Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2661,6 +2661,7 @@ Namespace | Name | Import |
**Ontologies** | [NegatePropertyExpression](docs/v2/Ontologies/models/NegatePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import NegatePropertyExpression` |
**Ontologies** | [NestedInterfacePropertyTypeImplementation](docs/v2/Ontologies/models/NestedInterfacePropertyTypeImplementation.md) | `from foundry_sdk.v2.ontologies.models import NestedInterfacePropertyTypeImplementation` |
**Ontologies** | [NestedQueryAggregation](docs/v2/Ontologies/models/NestedQueryAggregation.md) | `from foundry_sdk.v2.ontologies.models import NestedQueryAggregation` |
**Ontologies** | [NoLoadLevel](docs/v2/Ontologies/models/NoLoadLevel.md) | `from foundry_sdk.v2.ontologies.models import NoLoadLevel` |
**Ontologies** | [NotQueryV2](docs/v2/Ontologies/models/NotQueryV2.md) | `from foundry_sdk.v2.ontologies.models import NotQueryV2` |
**Ontologies** | [NumberFormatAffix](docs/v2/Ontologies/models/NumberFormatAffix.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatAffix` |
**Ontologies** | [NumberFormatCurrency](docs/v2/Ontologies/models/NumberFormatCurrency.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatCurrency` |
Expand Down Expand Up @@ -4002,6 +4003,7 @@ Namespace | Name | Import |
**Ontologies** | ObjectSetNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectSetNotFound` |
**Ontologies** | ObjectsExceededLimit | `from foundry_sdk.v2.ontologies.errors import ObjectsExceededLimit` |
**Ontologies** | ObjectsModifiedConcurrently | `from foundry_sdk.v2.ontologies.errors import ObjectsModifiedConcurrently` |
**Ontologies** | ObjectTypeDerivedPropertyNotSupported | `from foundry_sdk.v2.ontologies.errors import ObjectTypeDerivedPropertyNotSupported` |
**Ontologies** | ObjectTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotFound` |
**Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotSynced` |
**Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypesNotSynced` |
Expand Down Expand Up @@ -4336,6 +4338,7 @@ Namespace | Name | Import |
**Ontologies** | ObjectSetNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectSetNotFound` |
**Ontologies** | ObjectsExceededLimit | `from foundry_sdk.v1.ontologies.errors import ObjectsExceededLimit` |
**Ontologies** | ObjectsModifiedConcurrently | `from foundry_sdk.v1.ontologies.errors import ObjectsModifiedConcurrently` |
**Ontologies** | ObjectTypeDerivedPropertyNotSupported | `from foundry_sdk.v1.ontologies.errors import ObjectTypeDerivedPropertyNotSupported` |
**Ontologies** | ObjectTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotFound` |
**Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotSynced` |
**Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypesNotSynced` |
Expand Down
2 changes: 1 addition & 1 deletion docs-snippets-npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"sls": {
"dependencies": {
"com.palantir.foundry.api:api-gateway": {
"minVersion": "1.1697.0",
"minVersion": "1.1703.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
8 changes: 4 additions & 4 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/v2/Ontologies/OntologyObject.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,7 @@ Name | Type | Description | Notes |
**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. | |
**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] |
**default_load_level** | Optional[PropertyLoadLevel] | | [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] |
**execute_in_memory_only** | Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
Expand Down Expand Up @@ -415,6 +416,8 @@ object_type = "employee"
select = None
# 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.
branch = None
# Optional[PropertyLoadLevel]
default_load_level = None
# 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.
exclude_rid = None
# Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false.
Expand Down Expand Up @@ -445,6 +448,7 @@ try:
object_type,
select=select,
branch=branch,
default_load_level=default_load_level,
exclude_rid=exclude_rid,
execute_in_memory_only=execute_in_memory_only,
order_by=order_by,
Expand Down
12 changes: 12 additions & 0 deletions docs/v2/Ontologies/OntologyObjectSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@ Name | Type | Description | Notes |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**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] |
**default_load_level** | Optional[PropertyLoadLevel] | | [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] |
**execute_in_memory_only** | Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. | [optional] |
**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] |
Expand Down Expand Up @@ -312,6 +313,8 @@ object_set = {"type": "base", "objectType": "Employee"}
select = None
# 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.
branch = None
# Optional[PropertyLoadLevel]
default_load_level = None
# 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.
exclude_rid = None
# Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false.
Expand Down Expand Up @@ -352,6 +355,7 @@ try:
object_set=object_set,
select=select,
branch=branch,
default_load_level=default_load_level,
exclude_rid=exclude_rid,
execute_in_memory_only=execute_in_memory_only,
include_compute_usage=include_compute_usage,
Expand Down Expand Up @@ -520,6 +524,7 @@ Name | Type | Description | Notes |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**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] |
**default_load_level** | Optional[PropertyLoadLevel] | | [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] |
**execute_in_memory_only** | Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. | [optional] |
**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] |
Expand Down Expand Up @@ -558,6 +563,8 @@ object_set = {"type": "base", "objectType": "Employee"}
select = None
# 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.
branch = None
# Optional[PropertyLoadLevel]
default_load_level = None
# 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.
exclude_rid = None
# Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false.
Expand Down Expand Up @@ -600,6 +607,7 @@ try:
object_set=object_set,
select=select,
branch=branch,
default_load_level=default_load_level,
exclude_rid=exclude_rid,
execute_in_memory_only=execute_in_memory_only,
include_compute_usage=include_compute_usage,
Expand Down Expand Up @@ -664,6 +672,7 @@ Name | Type | Description | Notes |
**object_set** | ObjectSet | | |
**select** | List[SelectedPropertyApiName] | | |
**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] |
**default_load_level** | Optional[PropertyLoadLevel] | | [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] |
**execute_in_memory_only** | Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. | [optional] |
**order_by** | Optional[SearchOrderByV2] | | [optional] |
Expand Down Expand Up @@ -700,6 +709,8 @@ object_set = {"type": "interfaceBase", "interfaceType": "Person"}
select = None
# 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.
branch = None
# Optional[PropertyLoadLevel]
default_load_level = None
# 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.
exclude_rid = None
# Optional[bool] | If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false.
Expand Down Expand Up @@ -738,6 +749,7 @@ try:
object_set=object_set,
select=select,
branch=branch,
default_load_level=default_load_level,
exclude_rid=exclude_rid,
execute_in_memory_only=execute_in_memory_only,
order_by=order_by,
Expand Down
1 change: 1 addition & 0 deletions docs/v2/Ontologies/models/LoadObjectSetRequestV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Represents the API POST body when loading an `ObjectSet`.
**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. |
**default_load_level** | Optional[PropertyLoadLevel] | No | |
**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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje
**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. |
**default_load_level** | Optional[PropertyLoadLevel] | No | |
**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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje
**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. |
**default_load_level** | Optional[PropertyLoadLevel] | No | |
**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. |
Expand Down
14 changes: 14 additions & 0 deletions docs/v2/Ontologies/models/NoLoadLevel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# NoLoadLevel

Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an
explicit per-property load level (via `PropertyWithLoadLevelSelector`) to opt a property out of a
`defaultLoadLevel`.


## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**type** | Literal["noLoadLevel"] | Yes | None |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
2 changes: 2 additions & 0 deletions docs/v2/Ontologies/models/PropertyLoadLevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The load level of the property:
- APPLY_REDUCERS: Returns a single value of an array as configured in the ontology.
- EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.
- APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.
- NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.


This is a discriminator type and does not contain any fields. Instead, it is a union
Expand All @@ -16,6 +17,7 @@ This discriminator class uses the `type` field to differentiate between classes.
ApplyReducersAndExtractMainValueLoadLevel | applyReducersAndExtractMainValue
ApplyReducersLoadLevel | applyReducers
ExtractMainValueLoadLevel | extractMainValue
NoLoadLevel | noLoadLevel


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
1 change: 1 addition & 0 deletions docs/v2/Ontologies/models/SearchObjectsRequestV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ SearchObjectsRequestV2
**page_token** | Optional[PageToken] | No | |
**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. |
**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. |
**default_load_level** | Optional[PropertyLoadLevel] | 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. |
**reference_signing_options** | Optional[ReferenceSigningOptions] | No | |
Expand Down
2 changes: 1 addition & 1 deletion foundry_sdk/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
# using the autorelease bot
__version__ = "0.0.0"

__openapi_document_version__ = "1.1697.0"
__openapi_document_version__ = "1.1703.0"
25 changes: 23 additions & 2 deletions foundry_sdk/v1/ontologies/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ class FunctionExecutionTimedOutParameters(typing_extensions.TypedDict):


@dataclass
class FunctionExecutionTimedOut(errors.InternalServerError):
class FunctionExecutionTimedOut(errors.BadRequestError):
name: typing.Literal["FunctionExecutionTimedOut"]
parameters: FunctionExecutionTimedOutParameters
error_instance_id: str
Expand Down Expand Up @@ -1761,6 +1761,26 @@ class ObjectSetNotFound(errors.NotFoundError):
error_instance_id: str


class ObjectTypeDerivedPropertyNotSupportedParameters(typing_extensions.TypedDict):
"""
The request uses an object type derived property in a way that is not supported. This occurs when results
are sorted by the derived property, when the object set is filtered on the derived property, or when the
derived property is returned only because the request asked for all properties of the object type (rather
than naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any
filters, and select only the specific properties you need - you may select the derived property itself by
name.
"""

__pydantic_config__ = {"extra": "allow"} # type: ignore


@dataclass
class ObjectTypeDerivedPropertyNotSupported(errors.BadRequestError):
name: typing.Literal["ObjectTypeDerivedPropertyNotSupported"]
parameters: ObjectTypeDerivedPropertyNotSupportedParameters
error_instance_id: str


class ObjectTypeNotFoundParameters(typing_extensions.TypedDict):
"""The requested object type is not found, or the client token does not have access to it."""

Expand Down Expand Up @@ -2373,7 +2393,7 @@ class QueryTimeExceededLimitParameters(typing_extensions.TypedDict):


@dataclass
class QueryTimeExceededLimit(errors.InternalServerError):
class QueryTimeExceededLimit(errors.BadRequestError):
name: typing.Literal["QueryTimeExceededLimit"]
parameters: QueryTimeExceededLimitParameters
error_instance_id: str
Expand Down Expand Up @@ -2710,6 +2730,7 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError):
"ObjectEditMissingPrimaryKey",
"ObjectNotFound",
"ObjectSetNotFound",
"ObjectTypeDerivedPropertyNotSupported",
"ObjectTypeNotFound",
"ObjectTypeNotSynced",
"ObjectTypesNotSynced",
Expand Down
Loading