Skip to content

Commit 755021f

Browse files
svc-excavator-botsvc-excavator-bot
authored
[kbn/upgrade-release] Excavator: Upgrade API Version (#313)
1 parent 3072794 commit 755021f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1106
-30
lines changed

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
tmp
44
test.py
55
venv
6-
.idea/

‎README.md‎

Lines changed: 32 additions & 0 deletions
Large diffs are not rendered by default.

‎docs-snippets-npm/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"sls": {
2525
"dependencies": {
2626
"com.palantir.foundry.api:api-gateway": {
27-
"minVersion": "1.1404.0",
27+
"minVersion": "1.1416.1",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

‎docs-snippets-npm/src/index.ts‎

Lines changed: 12 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/v2/Core/models/CheckReportRid.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CheckReportRid
2+
3+
The unique resource identifier (RID) of a Data Health Check Report.
4+
5+
## Type
6+
```python
7+
RID
8+
```
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/DataHealth/CheckReport.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# CheckReport
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**get**](#get) | **GET** /v2/dataHealth/checkReports/{checkReportRid} | Public Beta |
6+
7+
# **get**
8+
Get the CheckReport with the specified rid.
9+
10+
### Parameters
11+
12+
Name | Type | Description | Notes |
13+
------------- | ------------- | ------------- | ------------- |
14+
**check_report_rid** | CheckReportRid | | |
15+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
16+
17+
### Return type
18+
**CheckReport**
19+
20+
### Example
21+
22+
```python
23+
from foundry_sdk import FoundryClient
24+
import foundry_sdk
25+
from pprint import pprint
26+
27+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
28+
29+
# CheckReportRid
30+
check_report_rid = "ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
31+
# Optional[PreviewMode] | Enables the use of preview functionality.
32+
preview = None
33+
34+
35+
try:
36+
api_response = client.data_health.CheckReport.get(check_report_rid, preview=preview)
37+
print("The get response:\n")
38+
pprint(api_response)
39+
except foundry_sdk.PalantirRPCException as e:
40+
print("HTTP error when calling CheckReport.get: %s\n" % e)
41+
42+
```
43+
44+
45+
46+
### Authorization
47+
48+
See [README](../../../README.md#authorization)
49+
50+
### HTTP response details
51+
| Status Code | Type | Description | Content Type |
52+
|-------------|-------------|-------------|------------------|
53+
**200** | CheckReport | | application/json |
54+
55+
[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
56+

‎docs/v2/DataHealth/models/CheckReport.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CheckReport
2+
3+
CheckReport
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**rid** | CheckReportRid | Yes | |
9+
**check** | Check | Yes | Snapshot of the check configuration when this report was created. This will not change if the check is later modified. |
10+
**result** | CheckResult | Yes | |
11+
**created_time** | CreatedTime | Yes | |
12+
13+
14+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/DataHealth/models/CheckResult.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CheckResult
2+
3+
The result of running a check.
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**status** | CheckResultStatus | Yes | |
9+
**message** | Optional[str] | No | Further details about the result of the check. |
10+
11+
12+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/DataHealth/models/CheckResultStatus.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CheckResultStatus
2+
3+
The status of a check report execution.
4+
5+
| **Value** |
6+
| --------- |
7+
| `"PASSED"` |
8+
| `"FAILED"` |
9+
| `"WARNING"` |
10+
| `"ERROR"` |
11+
| `"NOT_APPLICABLE"` |
12+
| `"NOT_COMPUTABLE"` |
13+
14+
15+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/Functions/Query.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Name | Type | Description | Notes |
2626
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
2727
**trace_parent** | Optional[TraceParent] | | [optional] |
2828
**trace_state** | Optional[TraceState] | | [optional] |
29+
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] |
2930
**version** | Optional[FunctionVersion] | | [optional] |
3031

3132
### Return type
@@ -52,6 +53,8 @@ preview = None
5253
trace_parent = None
5354
# Optional[TraceState]
5455
trace_state = None
56+
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.
57+
transaction_id = None
5558
# Optional[FunctionVersion]
5659
version = None
5760

@@ -64,6 +67,7 @@ try:
6467
preview=preview,
6568
trace_parent=trace_parent,
6669
trace_state=trace_state,
70+
transaction_id=transaction_id,
6771
version=version,
6872
)
6973
print("The execute response:\n")
@@ -233,6 +237,7 @@ Name | Type | Description | Notes |
233237
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
234238
**trace_parent** | Optional[TraceParent] | | [optional] |
235239
**trace_state** | Optional[TraceState] | | [optional] |
240+
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] |
236241
**version** | Optional[FunctionVersion] | | [optional] |
237242

238243
### Return type
@@ -261,6 +266,8 @@ preview = None
261266
trace_parent = None
262267
# Optional[TraceState]
263268
trace_state = None
269+
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.
270+
transaction_id = None
264271
# Optional[FunctionVersion]
265272
version = None
266273

@@ -274,6 +281,7 @@ try:
274281
preview=preview,
275282
trace_parent=trace_parent,
276283
trace_state=trace_state,
284+
transaction_id=transaction_id,
277285
version=version,
278286
)
279287
print("The streaming_execute response:\n")

0 commit comments

Comments
 (0)