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
43 changes: 43 additions & 0 deletions README.md

Large diffs are not rendered by default.

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.1680.0",
"minVersion": "1.1689.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
30 changes: 25 additions & 5 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

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

The purpose for which a language model is configured on an Agent.

| **Value** |
| --------- |
| `"PRIMARY_AGENT"` |
| `"QUESTION_SUGGESTER"` |


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

The Resource Identifier (RID) of a Dataset.


## Type
```python
RID
```


[[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: 1 addition & 1 deletion docs/v2/Filesystem/Folder.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Method | HTTP request | Release Stage |
[**replace**](#replace) | **PUT** /v2/filesystem/folders/{folderRid} | Private Beta |

# **children**
List all child Resources of the Folder.
List all child resources of the Folder.

This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is
provided, this page size will also be used as the default.
Expand Down
10 changes: 5 additions & 5 deletions docs/v2/Filesystem/Resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,13 +262,13 @@ See [README](../../../README.md#authorization)
[[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)

# **get_by_path**
Get a Resource by its absolute path.
Get a resource by its absolute path.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**path** | ResourcePath | The path to the Resource. The leading slash is optional. | |
**path** | ResourcePath | The path to the resource. The leading slash is optional. | |

### Return type
**Resource**
Expand All @@ -282,7 +282,7 @@ from pprint import pprint

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

# ResourcePath | The path to the Resource. The leading slash is optional.
# ResourcePath | The path to the resource. The leading slash is optional.
path = "/My Organization-abcd/My Important Project/My Dataset"


Expand All @@ -309,7 +309,7 @@ See [README](../../../README.md#authorization)
[[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)

# **get_by_path_batch**
Gets multiple Resources by their absolute paths.
Gets multiple resources by their absolute paths.
Returns a list of resources. If a path does not exist, is inaccessible, or refers to
a root folder or space, it will not be included in the response.
At most 1,000 paths should be requested at once.
Expand Down Expand Up @@ -418,7 +418,7 @@ See [README](../../../README.md#authorization)
[[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)

# **permanently_delete**
Permanently delete the given resource from the trash. If the Resource is not directly trashed, a
Permanently delete the given resource from the trash. If the resource is not directly trashed, a
`ResourceNotTrashed` error will be thrown.


Expand Down
169 changes: 169 additions & 0 deletions docs/v2/Filesystem/ResourceTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
# ResourceTag

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**add**](#add) | **POST** /v2/filesystem/resources/{resourceRid}/tags/add | Private Beta |
[**list**](#list) | **GET** /v2/filesystem/resources/{resourceRid}/tags | Private Beta |
[**remove**](#remove) | **POST** /v2/filesystem/resources/{resourceRid}/tags/remove | Private Beta |

# **add**
Apply tags to a resource.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**resource_rid** | ResourceRid | | |
**tag_rids** | List[TagRid] | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**None**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# ResourceRid
resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
# List[TagRid]
tag_rids = ["ri.compass.main.tag.c410f510-2937-420e-8ea3-8c9bcb3c1791"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.filesystem.Resource.Tag.add(
resource_rid, tag_rids=tag_rids, preview=preview
)
print("The add response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Tag.add: %s\n" % e)

```



### Authorization

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

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**204** | None | | None |

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

# **list**
List the tags applied to a resource.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**resource_rid** | ResourceRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ListResourceTagsResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# ResourceRid
resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.filesystem.Resource.Tag.list(resource_rid, preview=preview)
print("The list response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Tag.list: %s\n" % e)

```



### Authorization

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

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | ListResourceTagsResponse | | 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)

# **remove**
Remove tags from a resource.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**resource_rid** | ResourceRid | | |
**tag_rids** | List[TagRid] | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**None**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# ResourceRid
resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
# List[TagRid]
tag_rids = ["ri.compass.main.tag.c410f510-2937-420e-8ea3-8c9bcb3c1791"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.filesystem.Resource.Tag.remove(
resource_rid, tag_rids=tag_rids, preview=preview
)
print("The remove response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Tag.remove: %s\n" % e)

```



### Authorization

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

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**204** | None | | None |

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

2 changes: 1 addition & 1 deletion docs/v2/Filesystem/Space.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ See [README](../../../README.md#authorization)
[[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)

# **delete**
Delete the space. This will only work if the Space is empty, meaning any Projects or Resources have been deleted first.
Delete the space. This will only work if the Space is empty, meaning any Projects or resources have been deleted first.


### Parameters
Expand Down
11 changes: 11 additions & 0 deletions docs/v2/Filesystem/models/AddResourceTagsRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AddResourceTagsRequest

AddResourceTagsRequest

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**tag_rids** | List[TagRid] | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ GetByPathResourcesBatchRequestElement
## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**path** | ResourcePath | Yes | The path to the Resource. The leading slash is optional. |
**path** | ResourcePath | Yes | The path to the resource. The leading slash is optional. |


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

ListResourceTagsResponse

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[ResourceTag] | Yes | |


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

RemoveResourceTagsRequest

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**tag_rids** | List[TagRid] | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
22 changes: 11 additions & 11 deletions docs/v2/Filesystem/models/Resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ Resource
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**rid** | ResourceRid | Yes | |
**display_name** | ResourceDisplayName | Yes | The display name of the Resource |
**description** | Optional[str] | No | The description of the Resource |
**documentation** | Optional[str] | No | The documentation associated with the Resource |
**display_name** | ResourceDisplayName | Yes | The display name of the resource |
**description** | Optional[str] | No | The description of the resource |
**documentation** | Optional[str] | No | The documentation associated with the resource |
**path** | ResourcePath | Yes | The full path to the resource, including the resource name itself |
**type** | ResourceType | Yes | The type of the Resource derived from the Resource Identifier (RID). |
**created_by** | CreatedBy | Yes | The user that created the Resource. |
**updated_by** | UpdatedBy | Yes | The user that last updated the Resource. |
**created_time** | CreatedTime | Yes | The timestamp that the Resource was last created. |
**updated_time** | UpdatedTime | Yes | The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. |
**trash_status** | TrashStatus | Yes | The trash status of the Resource. If trashed, this could either be because the Resource itself has been trashed or because one of its ancestors has been trashed. |
**type** | ResourceType | Yes | The type of the resource derived from the Resource Identifier (RID). |
**created_by** | CreatedBy | Yes | The user that created the resource |
**updated_by** | UpdatedBy | Yes | The user that last updated the resource. |
**created_time** | CreatedTime | Yes | The timestamp that the resource was last created. |
**updated_time** | UpdatedTime | Yes | The timestamp that the resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. |
**trash_status** | TrashStatus | Yes | The trash status of the resource. If trashed, this could either be because the resource itself has been trashed or because one of its ancestors has been trashed. |
**parent_folder_rid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For projects, this will be the Space RID. |
**project_rid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID. |
**space_rid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Resource lives in. |
**project_rid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the resource lives in. If the resource itself is a Project, this value will still be populated with the Project RID. |
**space_rid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the resource lives in. |


[[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: 1 addition & 1 deletion docs/v2/Filesystem/models/ResourceDisplayName.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ResourceDisplayName

The display name of the Resource
The display name of the resource

## Type
```python
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/Filesystem/models/ResourceRid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ResourceRid

The unique resource identifier (RID) of a Resource.
The unique resource identifier (RID) of a resource.

## Type
```python
Expand Down
12 changes: 12 additions & 0 deletions docs/v2/Filesystem/models/ResourceTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ResourceTag

ResourceTag

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**tag_rid** | TagRid | Yes | |
**display_name** | ResourceTagDisplayName | Yes | The display name of the tag, qualified by its category as `{category}:{tag}`. |


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

The display name of the tag, qualified by its category as `{category}:{tag}`.

## Type
```python
str
```


[[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: 1 addition & 1 deletion docs/v2/Filesystem/models/ResourceType.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ResourceType

The type of the Resource derived from the Resource Identifier (RID).
The type of the resource derived from the Resource Identifier (RID).

| **Value** |
| --------- |
Expand Down
Loading