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
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,11 @@ datetime_with_tz = datetime(2025, 2, 5, 20, 57, 57, 511182, tzinfo=timezone.utc)
```

<a id="apis-link"></a>
<a id="apis-v3-link"></a>
## Documentation for V3 API endpoints

Namespace | Resource | Operation | HTTP request |
------------ | ------------- | ------------- | ------------- |
<a id="apis-v2-link"></a>
## Documentation for V2 API endpoints

Expand Down Expand Up @@ -1018,6 +1023,25 @@ Namespace | Resource | Operation | HTTP request |


<a id="models-link"></a>
<a id="models-v3-link"></a>
## Documentation for V3 models

Namespace | Name | Import |
--------- | ---- | ------ |
**Core** | [PageSize](docs/v3/Core/models/PageSize.md) | `from foundry_sdk.v3.core.models import PageSize` |
**Core** | [PageToken](docs/v3/Core/models/PageToken.md) | `from foundry_sdk.v3.core.models import PageToken` |
**Endpoints** | [EndpointSet](docs/v3/Endpoints/models/EndpointSet.md) | `from foundry_sdk.v3.endpoints.models import EndpointSet` |
**Endpoints** | [EndpointSetEndpoint](docs/v3/Endpoints/models/EndpointSetEndpoint.md) | `from foundry_sdk.v3.endpoints.models import EndpointSetEndpoint` |
**Endpoints** | [EndpointSetEndpointRid](docs/v3/Endpoints/models/EndpointSetEndpointRid.md) | `from foundry_sdk.v3.endpoints.models import EndpointSetEndpointRid` |
**Endpoints** | [EndpointSetRid](docs/v3/Endpoints/models/EndpointSetRid.md) | `from foundry_sdk.v3.endpoints.models import EndpointSetRid` |
**Endpoints** | [EndpointSetVersion](docs/v3/Endpoints/models/EndpointSetVersion.md) | `from foundry_sdk.v3.endpoints.models import EndpointSetVersion` |
**Endpoints** | [EndpointSetVersionId](docs/v3/Endpoints/models/EndpointSetVersionId.md) | `from foundry_sdk.v3.endpoints.models import EndpointSetVersionId` |
**Endpoints** | [ListEndpointSetEndpointsResponse](docs/v3/Endpoints/models/ListEndpointSetEndpointsResponse.md) | `from foundry_sdk.v3.endpoints.models import ListEndpointSetEndpointsResponse` |
**Endpoints** | [ListEndpointSetVersionsResponse](docs/v3/Endpoints/models/ListEndpointSetVersionsResponse.md) | `from foundry_sdk.v3.endpoints.models import ListEndpointSetVersionsResponse` |
**Orchestrator** | [CompleteProcessExecutionSignalRequest](docs/v3/Orchestrator/models/CompleteProcessExecutionSignalRequest.md) | `from foundry_sdk.v3.orchestrator.models import CompleteProcessExecutionSignalRequest` |
**Orchestrator** | [ProcessExecutionId](docs/v3/Orchestrator/models/ProcessExecutionId.md) | `from foundry_sdk.v3.orchestrator.models import ProcessExecutionId` |
**Orchestrator** | [SignalId](docs/v3/Orchestrator/models/SignalId.md) | `from foundry_sdk.v3.orchestrator.models import SignalId` |

<a id="models-v2-link"></a>
## Documentation for V2 models

Expand Down Expand Up @@ -3479,6 +3503,20 @@ Namespace | Name | Import |

<a id="all-errors"></a>
## Documentation for errors
<a id="errors-v3-link"></a>
## Documentation for V3 errors

Namespace | Name | Import |
--------- | ---- | ------ |
**Core** | BatchRequestSizeExceededLimit | `from foundry_sdk.v3.core.errors import BatchRequestSizeExceededLimit` |
**Core** | MissingBatchRequest | `from foundry_sdk.v3.core.errors import MissingBatchRequest` |
**Endpoints** | EndpointSetEndpointNotFound | `from foundry_sdk.v3.endpoints.errors import EndpointSetEndpointNotFound` |
**Endpoints** | EndpointSetNotFound | `from foundry_sdk.v3.endpoints.errors import EndpointSetNotFound` |
**Endpoints** | EndpointSetVersionNotFound | `from foundry_sdk.v3.endpoints.errors import EndpointSetVersionNotFound` |
**Orchestrator** | CompleteProcessExecutionSignalPermissionDenied | `from foundry_sdk.v3.orchestrator.errors import CompleteProcessExecutionSignalPermissionDenied` |
**Orchestrator** | ProcessExecutionExpired | `from foundry_sdk.v3.orchestrator.errors import ProcessExecutionExpired` |
**Orchestrator** | ProcessExecutionNotFound | `from foundry_sdk.v3.orchestrator.errors import ProcessExecutionNotFound` |
**Orchestrator** | ProcessExecutionSignalNotFound | `from foundry_sdk.v3.orchestrator.errors import ProcessExecutionSignalNotFound` |
<a id="errors-v2-link"></a>
## Documentation for V2 errors

Expand Down
7 changes: 7 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,13 @@
"parquetExperimentSeries",
"parquetExperimentArtifactTable"
]
},
"v3": {
"namespaces": {
"Core": true,
"Endpoints": true,
"Orchestrator": true
}
}
},
"optionalLists": [
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.1783.1",
"minVersion": "1.1786.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
30 changes: 30 additions & 0 deletions docs-snippets-npm/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2177,6 +2177,36 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# WidgetSetRid | A Resource Identifier (RID) identifying a widget set.\nwidget_set_rid = \"ri.widgetregistry..widget-set.21dt2c42-b7df-4b23-880b-1436a3dred2e\"\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.widgets.WidgetSet.get(widget_set_rid, preview=preview)\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling WidgetSet.get: %s\\n\" % e)"
}
],
"v3.getEndpointSet": [
{
"template": "from foundry_sdk.v3 import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# EndpointSetRid\nendpoint_set_rid = None\n\n\ntry:\n api_response = client.endpoints.EndpointSet.get(endpoint_set_rid)\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling EndpointSet.get: %s\\n\" % e)"
}
],
"v3.getEndpointSetEndpoint": [
{
"template": "from foundry_sdk.v3 import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# EndpointSetRid\nendpoint_set_rid = None\n# EndpointSetEndpointRid\nendpoint_rid = None\n\n\ntry:\n api_response = client.endpoints.EndpointSet.Endpoint.get(endpoint_set_rid, endpoint_rid)\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Endpoint.get: %s\\n\" % e)"
}
],
"v3.listEndpointSetEndpoints": [
{
"template": "from foundry_sdk.v3 import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# EndpointSetRid\nendpoint_set_rid = None\n# Optional[PageSize]\npage_size = None\n# Optional[PageToken]\npage_token = None\n\n\ntry:\n for endpoint_set_endpoint in client.endpoints.EndpointSet.Endpoint.list(\n endpoint_set_rid, page_size=page_size, page_token=page_token\n ):\n pprint(endpoint_set_endpoint)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Endpoint.list: %s\\n\" % e)"
}
],
"v3.getEndpointSetVersion": [
{
"template": "from foundry_sdk.v3 import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# EndpointSetRid\nendpoint_set_rid = None\n# EndpointSetVersionId\nversion_id = None\n\n\ntry:\n api_response = client.endpoints.EndpointSet.Version.get(endpoint_set_rid, version_id)\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Version.get: %s\\n\" % e)"
}
],
"v3.listEndpointSetVersions": [
{
"template": "from foundry_sdk.v3 import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# EndpointSetRid\nendpoint_set_rid = None\n# Optional[PageSize]\npage_size = None\n# Optional[PageToken]\npage_token = None\n\n\ntry:\n for endpoint_set_version in client.endpoints.EndpointSet.Version.list(\n endpoint_set_rid, page_size=page_size, page_token=page_token\n ):\n pprint(endpoint_set_version)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Version.list: %s\\n\" % e)"
}
],
"v3.completeProcessExecutionSignal": [
{
"template": "from foundry_sdk.v3 import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# ProcessExecutionId\nprocess_execution_id = None\n# SignalId\nsignal_id = None\n# Optional[Any] | Arbitrary JSON passed to the process execution that consumes the signal. Empty when the completion carries no payload.\npayload = None\n\n\ntry:\n api_response = client.orchestrator.ProcessExecution.Signal.complete(\n process_execution_id, signal_id, payload=payload\n )\n print(\"The complete response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Signal.complete: %s\\n\" % e)"
}
]
}
}
Expand Down
3 changes: 1 addition & 2 deletions docs/v2/Ontologies/ActionTypeFullMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ See [README](../../../README.md#authorization)
Search for action types in the given Ontology that match the provided filters. Full action type metadata
results are returned by relevance of the match unless an explicit `orderBy` is provided.

Action types with logic rules that cannot be represented in the API are omitted from the results.
Action types with logic rules that cannot be represented in the API are omitted from the results.
As a consequence, totalCount counts all matching action types in the Ontology and may exceed the number
of results returned across all pages, and an individual page may be empty even when nextPageToken is present.

Expand Down Expand Up @@ -286,4 +286,3 @@ See [README](../../../README.md#authorization)
**200** | SearchActionTypesFullMetadataResponse | Success response. | application/json |

[[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)

11 changes: 11 additions & 0 deletions docs/v3/Core/models/PageSize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# PageSize

PageSize

## Type
```python
int
```


[[Back to Model list]](../../../../README.md#models-v3-link) [[Back to API list]](../../../../README.md#apis-v3-link) [[Back to README]](../../../../README.md)
11 changes: 11 additions & 0 deletions docs/v3/Core/models/PageToken.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# PageToken

PageToken

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v3-link) [[Back to API list]](../../../../README.md#apis-v3-link) [[Back to README]](../../../../README.md)
52 changes: 52 additions & 0 deletions docs/v3/Endpoints/EndpointSet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# EndpointSet

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v3/platform/endpointSets/{endpointSetRid} | Private Beta |

# **get**


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**endpoint_set_rid** | EndpointSetRid | | |

### Return type
**EndpointSet**

### Example

```python
from foundry_sdk.v3 import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EndpointSetRid
endpoint_set_rid = None


try:
api_response = client.endpoints.EndpointSet.get(endpoint_set_rid)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling EndpointSet.get: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | EndpointSet | | application/json |

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v3-link) [[Back to Model list]](../../../README.md#models-v3-link) [[Back to README]](../../../README.md)
109 changes: 109 additions & 0 deletions docs/v3/Endpoints/EndpointSetEndpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# EndpointSetEndpoint

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v3/platform/endpointSets/{endpointSetRid}/endpoints/{endpointRid} | Private Beta |
[**list**](#list) | **GET** /v3/platform/endpointSets/{endpointSetRid}/endpoints | Private Beta |

# **get**


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**endpoint_set_rid** | EndpointSetRid | | |
**endpoint_rid** | EndpointSetEndpointRid | | |

### Return type
**EndpointSetEndpoint**

### Example

```python
from foundry_sdk.v3 import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EndpointSetRid
endpoint_set_rid = None
# EndpointSetEndpointRid
endpoint_rid = None


try:
api_response = client.endpoints.EndpointSet.Endpoint.get(endpoint_set_rid, endpoint_rid)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Endpoint.get: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | EndpointSetEndpoint | | application/json |

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v3-link) [[Back to Model list]](../../../README.md#models-v3-link) [[Back to README]](../../../README.md)
# **list**


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**endpoint_set_rid** | EndpointSetRid | | |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |

### Return type
**ListEndpointSetEndpointsResponse**

### Example

```python
from foundry_sdk.v3 import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EndpointSetRid
endpoint_set_rid = None
# Optional[PageSize]
page_size = None
# Optional[PageToken]
page_token = None


try:
for endpoint_set_endpoint in client.endpoints.EndpointSet.Endpoint.list(
endpoint_set_rid, page_size=page_size, page_token=page_token
):
pprint(endpoint_set_endpoint)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Endpoint.list: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | ListEndpointSetEndpointsResponse | | application/json |

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