Skip to content
Draft
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 8 additions & 6 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,40 +113,42 @@ workflows:
name: python-<< matrix.python_version>>
matrix:
parameters:
python_version: ["3.9", "3.10", "3.11", "3.12"]
pydantic_version: ["2.10"]
python_version: ["3.10", "3.11", "3.12", "3.13"]
pydantic_version: ["2.12"]
httpx_version: ["0.28"]
- test:
<<: *always-run
name: pydantic-<< matrix.pydantic_version >>
matrix:
parameters:
python_version: ["3.12"]
pydantic_version: ["2.6", "2.7", "2.8", "2.9", "2.10"]
pydantic_version: ["2.6", "2.7", "2.8", "2.9", "2.10", "2.11", "2.12"]
httpx_version: ["0.28"]
- test:
<<: *always-run
name: httpx-<< matrix.httpx_version >>
matrix:
parameters:
python_version: ["3.12"]
pydantic_version: ["2.10"]
python_version: ["3.13"]
pydantic_version: ["2.8"]
httpx_version: ["0.25", "0.26", "0.27", "0.28"]
- black:
<<: *always-run
- circle-all:
<<: *always-run
requires:
- python-3.9
- python-3.10
- python-3.11
- python-3.12
- python-3.13

- pydantic-2.6
- pydantic-2.7
- pydantic-2.8
- pydantic-2.9
- pydantic-2.10
- pydantic-2.11
- pydantic-2.12

- httpx-0.25
- httpx-0.26
Expand Down
276 changes: 274 additions & 2 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.1453.0",
"minVersion": "1.1483.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
120 changes: 105 additions & 15 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/v1/Ontologies/models/EqualsQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Returns objects where the specified field is equal to a value.

For string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.


## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/Ontologies/models/PropertyTypeRid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PropertyTypeRid

PropertyTypeRid
The unique resource identifier of a property.

## Type
```python
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/Admin/Marking.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**category_id** | MarkingCategoryId | | |
**initial_members** | List[PrincipalId] | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations. | |
**initial_role_assignments** | List[MarkingRoleUpdate] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. | |
**initial_role_assignments** | List[MarkingRoleUpdate] | The initial roles that will be assigned when the Marking is created. At least one ADMINISTER role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. | |
**name** | MarkingName | | |
**description** | Optional[str] | | [optional] |

Expand All @@ -37,7 +37,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
category_id = "0950264e-01c8-4e83-81a9-1a6b7f77621a"
# List[PrincipalId] | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations.
initial_members = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]
# List[MarkingRoleUpdate] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer.
# List[MarkingRoleUpdate] | The initial roles that will be assigned when the Marking is created. At least one ADMINISTER role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer.
initial_role_assignments = [
{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}
]
Expand Down
121 changes: 121 additions & 0 deletions docs/v2/Admin/MarkingCategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,71 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/admin/markingCategories | Private Beta |
[**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | Public Beta |
[**list**](#list) | **GET** /v2/admin/markingCategories | Public Beta |
[**replace**](#replace) | **PUT** /v2/admin/markingCategories/{markingCategoryId} | Private Beta |

# **create**
Creates a new MarkingCategory.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**description** | MarkingCategoryDescription | | |
**initial_permissions** | MarkingCategoryPermissions | The initial permissions for the Marking Category. This can be changed later through MarkingCategoryPermission operations. The provided permissions must include at least one ADMINISTER role assignment. WARNING: If you do not list your own principal ID or the ID of a Group that you are a member of as an ADMINISTER, you will create a Marking Category that you cannot administer. | |
**name** | MarkingCategoryName | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**MarkingCategory**

### Example

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

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

# MarkingCategoryDescription
description = "Markings related to data about our customers"
# MarkingCategoryPermissions | The initial permissions for the Marking Category. This can be changed later through MarkingCategoryPermission operations. The provided permissions must include at least one ADMINISTER role assignment. WARNING: If you do not list your own principal ID or the ID of a Group that you are a member of as an ADMINISTER, you will create a Marking Category that you cannot administer.
initial_permissions = {
"organizationRids": ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],
"roles": [{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}],
}
# MarkingCategoryName
name = "Customer Data"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.MarkingCategory.create(
description=description, initial_permissions=initial_permissions, name=name, preview=preview
)
print("The create response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling MarkingCategory.create: %s\n" % e)

```



### Authorization

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

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

# **get**
Get the MarkingCategory with the specified id.
Expand Down Expand Up @@ -109,3 +172,61 @@ 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)

# **replace**
Replace the MarkingCategory with the specified id.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**marking_category_id** | MarkingCategoryId | | |
**description** | MarkingCategoryDescription | | |
**name** | MarkingCategoryName | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**MarkingCategory**

### Example

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

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

# MarkingCategoryId
marking_category_id = None
# MarkingCategoryDescription
description = "Markings related to data about our customers"
# MarkingCategoryName
name = "Customer Data"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.MarkingCategory.replace(
marking_category_id, description=description, name=name, preview=preview
)
print("The replace response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling MarkingCategory.replace: %s\n" % e)

```



### Authorization

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

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

5 changes: 5 additions & 0 deletions docs/v2/Admin/MarkingCategoryPermissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# MarkingCategoryPermissions

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |

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

CreateMarkingCategoryRequest

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**initial_permissions** | MarkingCategoryPermissions | Yes | The initial permissions for the Marking Category. This can be changed later through MarkingCategoryPermission operations. The provided permissions must include at least one ADMINISTER role assignment. WARNING: If you do not list your own principal ID or the ID of a Group that you are a member of as an ADMINISTER, you will create a Marking Category that you cannot administer. |
**name** | MarkingCategoryName | Yes | |
**description** | MarkingCategoryDescription | Yes | |


[[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/Admin/models/CreateMarkingRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ CreateMarkingRequest
## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**initial_role_assignments** | List[MarkingRoleUpdate] | Yes | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. |
**initial_role_assignments** | List[MarkingRoleUpdate] | Yes | The initial roles that will be assigned when the Marking is created. At least one ADMINISTER role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. |
**initial_members** | List[PrincipalId] | Yes | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations. |
**name** | MarkingName | Yes | |
**description** | Optional[str] | No | |
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/Admin/models/MarkingCategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MarkingCategory
| ------------ | ------------- | ------------- | ------------- |
**id** | MarkingCategoryId | Yes | |
**name** | MarkingCategoryName | Yes | |
**description** | Optional[str] | No | |
**description** | MarkingCategoryDescription | Yes | |
**category_type** | MarkingCategoryType | Yes | |
**marking_type** | MarkingType | Yes | |
**markings** | List[MarkingId] | Yes | |
Expand Down
11 changes: 11 additions & 0 deletions docs/v2/Admin/models/MarkingCategoryDescription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# MarkingCategoryDescription

MarkingCategoryDescription

## 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)
13 changes: 13 additions & 0 deletions docs/v2/Admin/models/MarkingCategoryPermissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# MarkingCategoryPermissions

MarkingCategoryPermissions

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**organization_rids** | List[OrganizationRid] | Yes | Users must be members of at least one of the Organizations in this list to view Markings in the category, regardless of their assigned roles. |
**roles** | List[MarkingCategoryRoleAssignment] | Yes | |
**is_public** | MarkingCategoryPermissionsIsPublic | Yes | If true, all users who are members of at least one of the Organizations from organizationRids can view the Markings in the category. If false, only users who are explicitly granted the VIEW role can view the Markings in the category. |


[[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/Admin/models/MarkingCategoryPermissionsIsPublic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# MarkingCategoryPermissionsIsPublic

If true, all users who are members of at least one of the Organizations from organizationRids can view the Markings in the category. If false, only users who are explicitly granted the VIEW role can view the Markings in the category.

## Type
```python
bool
```


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

Represents the operations that a user can perform with regards to a Marking Category.
* ADMINISTER: The user can update a Marking Category's metadata and permissions
* VIEW: The user can view the Marking Category and the Markings within it.

NOTE: Permissions to administer or view a Marking Category do not confer any permissions to administer or view data protected by the Markings within that category.


| **Value** |
| --------- |
| `"ADMINISTER"` |
| `"VIEW"` |


[[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/Admin/models/MarkingCategoryRoleAssignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# MarkingCategoryRoleAssignment

MarkingCategoryRoleAssignment

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**role** | MarkingCategoryRole | Yes | |
**principal_id** | PrincipalId | Yes | |


[[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/Admin/models/ReplaceMarkingCategoryRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ReplaceMarkingCategoryRequest

ReplaceMarkingCategoryRequest

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**name** | MarkingCategoryName | Yes | |
**description** | MarkingCategoryDescription | 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/Core/models/ColumnName.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ColumnName

The name of a column in a dataset.

## 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)
6 changes: 5 additions & 1 deletion docs/v2/Datasets/Dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,11 @@ 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_schedules**
Get the RIDs of the Schedules that target the given Dataset
Get the RIDs of the Schedules that target the given Dataset.

Note: It may take up to an hour for recent changes to schedules to be reflected in this response,
especially for schedules managed by Marketplace. This operation will return outdated results in the
meantime.


### Parameters
Expand Down
Loading