Skip to content

Commit

Permalink
Update client API schema
Browse files Browse the repository at this point in the history
  • Loading branch information
davelopez committed Jul 18, 2024
1 parent 43cf75d commit 2720d7b
Showing 1 changed file with 81 additions and 2 deletions.
83 changes: 81 additions & 2 deletions client/src/api/schema/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7446,6 +7446,11 @@ export interface components {
*/
name: string;
};
/**
* DatasetPermissionAction
* @enum {string}
*/
DatasetPermissionAction: "set_permissions" | "make_private" | "remove_restrictions";
/**
* DatasetPermissions
* @description Role-based permissions for accessing and managing a dataset.
Expand Down Expand Up @@ -15706,6 +15711,74 @@ export interface components {
/** Creator */
creator?: unknown;
};
/** UpdateDatasetPermissionsPayload */
UpdateDatasetPermissionsPayload: {
/**
* Access IDs
* @description A list of role encoded IDs defining roles that should have access permission on the dataset.
*/
access_ids?: string[] | string | null;
/**
* Action
* @description Indicates what action should be performed on the dataset.
* @default set_permissions
*/
action: components["schemas"]["DatasetPermissionAction"] | null;
/**
* Manage IDs
* @description A list of role encoded IDs defining roles that should have manage permission on the dataset.
*/
manage_ids?: string[] | string | null;
/**
* Modify IDs
* @description A list of role encoded IDs defining roles that should have modify permission on the dataset.
*/
modify_ids?: string[] | string | null;
};
/** UpdateDatasetPermissionsPayloadAliasB */
UpdateDatasetPermissionsPayloadAliasB: {
/**
* Access IDs
* @description A list of role encoded IDs defining roles that should have access permission on the dataset.
*/
access?: string[] | string | null;
/**
* Action
* @description Indicates what action should be performed on the dataset.
* @default set_permissions
*/
action: components["schemas"]["DatasetPermissionAction"] | null;
/**
* Manage IDs
* @description A list of role encoded IDs defining roles that should have manage permission on the dataset.
*/
manage?: string[] | string | null;
/**
* Modify IDs
* @description A list of role encoded IDs defining roles that should have modify permission on the dataset.
*/
modify?: string[] | string | null;
};
/**
* UpdateDatasetPermissionsPayloadAliasC
* @description This is for backwards compatibility with the old API syntax.
*
* Using the alias `access_ids[]`, `manage_ids[]`, and `modify_ids[]`.
*/
UpdateDatasetPermissionsPayloadAliasC: {
/** Access Ids[] */
"access_ids[]"?: string[] | string | null;
/**
* Action
* @description Indicates what action should be performed on the dataset.
* @default set_permissions
*/
action: components["schemas"]["DatasetPermissionAction"] | null;
/** Manage Ids[] */
"manage_ids[]"?: string[] | string | null;
/** Modify Ids[] */
"modify_ids[]"?: string[] | string | null;
};
/**
* UpdateHistoryContentsBatchPayload
* @description Contains property values that will be updated for all the history `items` provided.
Expand Down Expand Up @@ -18338,7 +18411,10 @@ export interface operations {
};
requestBody: {
content: {
"application/json": Record<string, never>;
"application/json":
| components["schemas"]["UpdateDatasetPermissionsPayload"]
| components["schemas"]["UpdateDatasetPermissionsPayloadAliasB"]
| components["schemas"]["UpdateDatasetPermissionsPayloadAliasC"];
};
};
responses: {
Expand Down Expand Up @@ -22623,7 +22699,10 @@ export interface operations {
};
requestBody: {
content: {
"application/json": Record<string, never>;
"application/json":
| components["schemas"]["UpdateDatasetPermissionsPayload"]
| components["schemas"]["UpdateDatasetPermissionsPayloadAliasB"]
| components["schemas"]["UpdateDatasetPermissionsPayloadAliasC"];
};
};
responses: {
Expand Down

0 comments on commit 2720d7b

Please sign in to comment.