Skip to content

Excavator: Upgrade API Version #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
svc-excavator-bot wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Excavator: Upgrade API Version #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/v2/Ontologies/OntologyObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,21 +373,21 @@ Partial terms are not matched by terms filters except where explicitly noted.

### Parameters

Name | Type | Description | Notes |
------------- |------------------------------------| ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | |
**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | |
**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to search objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
**where** | Optional[SearchJsonQueryV2] | | [optional] |
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | |
**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | |
**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to search objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
**where** | Optional[SearchJsonQueryV2] | | [optional] |

### Return type
**SearchObjectsResponseV2**
Expand Down
96 changes: 48 additions & 48 deletions docs/v2/Ontologies/OntologyObjectSet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,22 +229,22 @@ Vector properties will not be returned unless included in the `select` parameter

### Parameters

Name | Type | Description | Notes |
------------- |------------------------------------| ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. | [optional] |
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] |

### Return type
**LoadObjectSetResponseV2**
Expand Down Expand Up @@ -438,23 +438,23 @@ Vector properties will not be returned unless included in the `select` parameter

### Parameters

Name | Type | Description | Notes |
------------- |------------------------------------| ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. | [optional] |
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] |

### Return type
**LoadObjectSetV2MultipleObjectTypesResponse**
Expand Down Expand Up @@ -558,21 +558,21 @@ Vector properties will not be returned unless included in the `select` parameter

### Parameters

Name | Type | Description | Notes |
------------- |------------------------------------| ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] |
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |

### Return type
**LoadObjectSetV2ObjectsOrInterfacesResponse**
Expand Down
22 changes: 11 additions & 11 deletions docs/v2/Ontologies/models/LoadObjectSetRequestV2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
Represents the API POST body when loading an `ObjectSet`.

## Properties
| Name | Type | Required | Description |
| ------------ |------------------------------------|----------| ------------- |
**object_set** | ObjectSet | Yes | |
**order_by** | Optional[SearchOrderByV2] | No | |
**select** | List[SelectedPropertyApiName] | Yes | |
**select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. |
**page_token** | Optional[PageToken] | No | |
**page_size** | Optional[PageSize] | No | |
**exclude_rid** | Optional[bool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. |
**snapshot** | Optional[bool] | No | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. |
**include_compute_usage** | Optional[IncludeComputeUsage] | No | |
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**object_set** | ObjectSet | Yes | |
**order_by** | Optional[SearchOrderByV2] | No | |
**select** | List[SelectedPropertyApiName] | Yes | |
**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. |
**page_token** | Optional[PageToken] | No | |
**page_size** | Optional[PageSize] | No | |
**exclude_rid** | Optional[bool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. |
**snapshot** | Optional[bool] | No | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. |
**include_compute_usage** | Optional[IncludeComputeUsage] | No | |


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