Skip to content

Commit a970f4a

Browse files
svc-excavator-botsvc-excavator-bot
authored
Excavator: Upgrade API Version (#324)
1 parent 973fad0 commit a970f4a

77 files changed

Lines changed: 1609 additions & 4046 deletions

File tree

Some content is hidden

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

‎README.md‎

Lines changed: 18 additions & 3 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.1485.0",
27+
"minVersion": "1.1494.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

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

Lines changed: 18 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/v1/Core/models/VoidType.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# VoidType
2+
3+
VoidType
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**type** | Literal["void"] | Yes | None |
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)

‎docs/v1/Ontologies/models/QueryDataType.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ DateType | date
1414
OntologyInterfaceObjectType | interfaceObject
1515
QueryStructType | struct
1616
QuerySetType | set
17+
VoidType | void
1718
StringType | string
1819
EntrySetType | entrySet
1920
DoubleType | double

docs/v2/SqlQueries/models/ParameterBinaryValue.md renamed to docs/v2/Core/models/VoidType.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# ParameterBinaryValue
1+
# VoidType
22

3-
A binary parameter value.
3+
VoidType
44

55
## Properties
66
| Name | Type | Required | Description |
77
| ------------ | ------------- | ------------- | ------------- |
8-
**value** | bytes | Yes | |
9-
**type** | Literal["binary"] | Yes | None |
8+
**type** | Literal["void"] | Yes | None |
109

1110

1211
[[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: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Executes a Query using the given parameters. By default, this executes the lates
1313

1414
This endpoint is maintained for backward compatibility only.
1515

16-
For all new implementations, use the `streamingExecute` endpoint, which supports all function types
16+
For all new implementations, use the `streamingExecute` endpoint, which supports all function types
1717
and provides enhanced functionality.
1818

1919

@@ -24,11 +24,12 @@ Name | Type | Description | Notes |
2424
**query_api_name** | QueryApiName | | |
2525
**parameters** | Dict[ParameterId, Optional[DataValue]] | | |
2626
**attribution** | Optional[Attribution] | | [optional] |
27+
**branch** | Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. | [optional] |
2728
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
2829
**trace_parent** | Optional[TraceParent] | | [optional] |
2930
**trace_state** | Optional[TraceState] | | [optional] |
3031
**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] |
31-
**version** | Optional[FunctionVersion] | | [optional] |
32+
**version** | Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. | [optional] |
3233

3334
### Return type
3435
**ExecuteQueryResponse**
@@ -48,6 +49,8 @@ query_api_name = None
4849
parameters = None
4950
# Optional[Attribution]
5051
attribution = None
52+
# Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch.
53+
branch = "ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
5154
# Optional[PreviewMode] | Enables the use of preview functionality.
5255
preview = None
5356
# Optional[TraceParent]
@@ -56,7 +59,7 @@ trace_parent = None
5659
trace_state = None
5760
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.
5861
transaction_id = None
59-
# Optional[FunctionVersion]
62+
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
6063
version = None
6164

6265

@@ -65,6 +68,7 @@ try:
6568
query_api_name,
6669
parameters=parameters,
6770
attribution=attribution,
71+
branch=branch,
6872
preview=preview,
6973
trace_parent=trace_parent,
7074
trace_state=trace_state,
@@ -294,12 +298,13 @@ Name | Type | Description | Notes |
294298
**query_api_name** | QueryApiName | | |
295299
**parameters** | Dict[ParameterId, Optional[DataValue]] | | |
296300
**attribution** | Optional[Attribution] | | [optional] |
301+
**branch** | Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. | [optional] |
297302
**ontology** | Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. | [optional] |
298303
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
299304
**trace_parent** | Optional[TraceParent] | | [optional] |
300305
**trace_state** | Optional[TraceState] | | [optional] |
301306
**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] |
302-
**version** | Optional[FunctionVersion] | | [optional] |
307+
**version** | Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. | [optional] |
303308

304309
### Return type
305310
**bytes**
@@ -319,6 +324,8 @@ query_api_name = None
319324
parameters = None
320325
# Optional[Attribution]
321326
attribution = None
327+
# Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch.
328+
branch = "ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
322329
# Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function.
323330
ontology = "example-ontology"
324331
# Optional[PreviewMode] | Enables the use of preview functionality.
@@ -329,7 +336,7 @@ trace_parent = None
329336
trace_state = None
330337
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.
331338
transaction_id = None
332-
# Optional[FunctionVersion]
339+
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
333340
version = None
334341

335342

@@ -338,6 +345,7 @@ try:
338345
query_api_name,
339346
parameters=parameters,
340347
attribution=attribution,
348+
branch=branch,
341349
ontology=ontology,
342350
preview=preview,
343351
trace_parent=trace_parent,

‎docs/v2/Functions/models/ExecuteQueryRequest.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ ExecuteQueryRequest
66
| Name | Type | Required | Description |
77
| ------------ | ------------- | ------------- | ------------- |
88
**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | |
9-
**version** | Optional[FunctionVersion] | No | |
9+
**version** | Optional[FunctionVersion] | No | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. |
10+
**branch** | Optional[FoundryBranch] | No | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. |
1011

1112

1213
[[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/models/QueryDataType.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This discriminator class uses the `type` field to differentiate between classes.
1313
DateType | date
1414
QueryStructType | struct
1515
QuerySetType | set
16+
VoidType | void
1617
StringType | string
1718
DoubleType | double
1819
IntegerType | integer

‎docs/v2/Functions/models/StreamingExecuteQueryRequest.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ StreamingExecuteQueryRequest
77
| ------------ | ------------- | ------------- | ------------- |
88
**ontology** | Optional[OntologyIdentifier] | No | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. |
99
**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | |
10-
**version** | Optional[FunctionVersion] | No | |
10+
**version** | Optional[FunctionVersion] | No | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. |
11+
**branch** | Optional[FoundryBranch] | No | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. |
1112

1213

1314
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

0 commit comments

Comments
 (0)