diff --git a/providers/src/databricks_account/v00.00.00000/provider.yaml b/providers/src/databricks_account/v00.00.00000/provider.yaml new file mode 100644 index 00000000..3ee68a22 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/provider.yaml @@ -0,0 +1,77 @@ +id: databricks_account +name: databricks_account +version: v00.00.00000 +providerServices: + billing: + id: billing:v00.00.00000 + name: billing + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/billing.yaml + title: Account Billing + version: v00.00.00000 + description: Account Billing + iam: + id: iam:v00.00.00000 + name: iam + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/iam.yaml + title: Identity and Access Management + version: v00.00.00000 + description: Identity and Access Management + logging: + id: logging:v00.00.00000 + name: logging + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/logging.yaml + title: Log Delivery + version: v00.00.00000 + description: Log Delivery + oauth: + id: oauth:v00.00.00000 + name: oauth + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/oauth.yaml + title: OAuth Integrations + version: v00.00.00000 + description: OAuth Integrations + provisioning: + id: provisioning:v00.00.00000 + name: provisioning + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/provisioning.yaml + title: Account Provisioning + version: v00.00.00000 + description: Account Provisioning + settings: + id: settings:v00.00.00000 + name: settings + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/settings.yaml + title: Account Settings + version: v00.00.00000 + description: Account Settings + unity_catalog: + id: unity_catalog:v00.00.00000 + name: unity_catalog + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/unity_catalog.yaml + title: Unity Catalog + version: v00.00.00000 + description: Unity Catalog +config: + auth: + type: oauth2 + client_id_env_var: DATABRICKS_CLIENT_ID + client_secret_env_var: DATABRICKS_CLIENT_SECRET + grant_type: client_credentials + token_url: https://accounts.cloud.databricks.com/oidc/accounts/{{ .__env__DATABRICKS_ACCOUNT_ID + }}/v1/token + scopes: + - all-apis diff --git a/providers/src/databricks_account/v00.00.00000/services/billing.yaml b/providers/src/databricks_account/v00.00.00000/services/billing.yaml new file mode 100644 index 00000000..e10286e9 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/billing.yaml @@ -0,0 +1,758 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Billing API + description: Account Billing +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/usage/download: + get: + operationId: billable-usage-download + externalDocs: + url: https://docs.databricks.com/api/account/billableusage/download + x-stackQL-resource: billable_usage + x-stackQL-method: download + x-stackQL-verb: exec + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: start_month + required: true + description: string + in: query + - name: end_month + required: true + description: string + in: query + - name: personal_data + in: query + responses: + '200': + description: Billable usage data was returned successfully. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Returns billable usage logs in CSV format for the specified account + and date range. For the data schema, see + /api/2.1/accounts/{account_id}/budgets: + post: + operationId: budgets-create + externalDocs: + url: https://docs.databricks.com/api/account/budgets/create + x-stackQL-resource: budgets + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budget: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget: + type: required + example: + budget: + account_id: 449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65 + alert_configurations: + - time_period: MONTH + trigger_type: CUMULATIVE_SPENDING_EXCEEDED + quantity_type: LIST_PRICE_DOLLARS_USD + quantity_threshold: string + action_configurations: + - action_type: EMAIL_NOTIFICATION + target: string + filter: + workspace_id: + operator: IN + values: + - 0 + tags: + - key: string + value: + operator: IN + values: + - string + display_name: string + description: Create a new budget configuration for an account. For full details, + see + get: + operationId: budgets-list + externalDocs: + url: https://docs.databricks.com/api/account/budgets/list + x-stackQL-resource: budgets + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budgets: + type: array + items: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.budgets + description: Gets all budgets associated with this account. + /api/2.1/accounts/{account_id}/budgets/{budget_id}: + delete: + operationId: budgets-delete + externalDocs: + url: https://docs.databricks.com/api/account/budgets/delete + x-stackQL-resource: budgets + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: budget_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a budget configuration for an account. Both account and + budget configuration are specified by ID. This cannot be undone. + get: + operationId: budgets-get + externalDocs: + url: https://docs.databricks.com/api/account/budgets/get + x-stackQL-resource: budgets + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: budget_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budget: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.budget + description: Gets a budget configuration for an account. Both account and budget + configuration are specified by ID. + put: + operationId: budgets-update + externalDocs: + url: https://docs.databricks.com/api/account/budgets/update + x-stackQL-resource: budgets + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: budget_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + budget: + type: object + properties: + budget_configuration_id: + type: string + account_id: + type: string + create_time: + type: integer + update_time: + type: integer + alert_configurations: + type: array + items: + type: object + properties: + alert_configuration_id: + type: string + time_period: + type: string + trigger_type: + type: string + quantity_type: + type: string + quantity_threshold: + type: string + action_configurations: + type: array + items: + type: object + properties: + action_configuration_id: + type: string + action_type: + type: string + target: + type: string + filter: + type: object + properties: + workspace_id: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + operator: + type: string + values: + type: array + items: + type: string + display_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget: + type: required + example: + budget: + budget_configuration_id: dc0b6e4b-23ef-471d-adf9-1d38d9199f98 + account_id: 449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65 + alert_configurations: + - alert_configuration_id: 60deed03-5f33-4eda-ac0b-03b20fccc5d1 + time_period: MONTH + trigger_type: CUMULATIVE_SPENDING_EXCEEDED + quantity_type: LIST_PRICE_DOLLARS_USD + quantity_threshold: string + action_configurations: + - action_configuration_id: 4079440f-2386-43ee-bb12-2fb4137f0080 + action_type: EMAIL_NOTIFICATION + target: string + filter: + workspace_id: + operator: IN + values: + - 0 + tags: + - key: string + value: + operator: IN + values: + - string + display_name: string + description: Updates a budget configuration for an account. Both account and + budget configuration are specified by ID. + /api/2.0/accounts/{account_id}/dashboard: + post: + operationId: usage-dashboards-create + externalDocs: + url: https://docs.databricks.com/api/account/usagedashboards/create + x-stackQL-resource: usage_dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspace_id: + type: integer + format: int64 + dashboard_type: + type: string + example: + workspace_id: 0 + dashboard_type: USAGE_DASHBOARD_TYPE_WORKSPACE + description: Create a usage dashboard specified by workspaceId, accountId, and + dashboard type. + get: + operationId: usage-dashboards-get + externalDocs: + url: https://docs.databricks.com/api/account/usagedashboards/get + x-stackQL-resource: usage_dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + in: query + - name: dashboard_type + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + dashboard_url: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + description: Get a usage dashboard specified by workspaceId, accountId, and + dashboard type. +components: + x-stackQL-resources: + billable_usage: + id: databricks_account.billing.billable_usage + name: billable_usage + title: Billable_usage + methods: + download: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1usage~1download/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/billable_usage/methods/download' + budgets: + id: databricks_account.billing.budgets + name: budgets + title: Budgets + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.budgets + delete: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets~1{budget_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets~1{budget_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.budget + update: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budgets~1{budget_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/budgets/methods/get' + - $ref: '#/components/x-stackQL-resources/budgets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/budgets/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/budgets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' + exec: [] + usage_dashboards: + id: databricks_account.billing.usage_dashboards + name: usage_dashboards + title: Usage_dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1dashboard/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1dashboard/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/usage_dashboards/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/usage_dashboards/methods/create' + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/iam.yaml b/providers/src/databricks_account/v00.00.00000/services/iam.yaml new file mode 100644 index 00000000..9986bd7d --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/iam.yaml @@ -0,0 +1,2037 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Iam API + description: Identity and Access Management +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/preview/accounts/{account_id}/access-control/assignable-roles: + get: + operationId: assignable-roles-getassignablerolesforresource + externalDocs: + url: https://docs.databricks.com/api/account/accountaccesscontrol/getassignablerolesforresource + x-stackQL-resource: assignable_roles + x-stackQL-method: getassignablerolesforresource + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: resource + required: true + description: string + in: query + responses: + '200': + description: Assignable roles were returned successfully. + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.roles + description: Gets all the roles that can be granted on an account level resource. + A role is grantable if the rule set on the resource can contain an access + rule of the role. + /api/2.0/accounts/{account_id}/scim/v2/Groups: + post: + operationId: groups-create + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/create + x-stackQL-resource: groups + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The group creation request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + roles: + type: Array of object + example: + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Properties of the new group. + description: Creates a group in the Databricks account with a unique name, using + the supplied group details. + get: + operationId: groups-list + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/list + x-stackQL-resource: groups + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List groups operation was succesful. + content: + application/json: + schema: + type: object + properties: + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets all details of the groups associated with the Databricks account. + /api/2.0/accounts/{account_id}/scim/v2/Groups/{id}: + delete: + operationId: groups-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/delete + x-stackQL-resource: groups + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Group was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a group from the Databricks account. + get: + operationId: groups-get + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/get + x-stackQL-resource: groups + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the information for a specific group in the Databricks account. + patch: + operationId: groups-patch + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/patch + x-stackQL-resource: groups + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on group information. + description: Partially updates the details of a group. + put: + operationId: groups-update + externalDocs: + url: https://docs.databricks.com/api/account/accountgroups/update + x-stackQL-resource: groups + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + roles: + type: Array of object + example: + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Operations to be applied on group information. + description: Updates the details of a group by replacing the entire group entity. + /api/2.0/preview/accounts/{account_id}/access-control/rule-sets: + get: + operationId: rule-sets-getruleset + externalDocs: + url: https://docs.databricks.com/api/account/accountaccesscontrol/getruleset + x-stackQL-resource: rule_sets + x-stackQL-method: getruleset + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: name + required: true + description: string + in: query + - name: etag + required: true + description: string + in: query + responses: + '200': + description: The rule set was returned successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + principals: + type: array + items: + type: string + role: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Get a rule set by its name. A rule set is always attached to a + resource and contains a list of access rules on the said resource. Currently + only a default rule set for each resource is supported. + put: + operationId: rule-sets-updateruleset + externalDocs: + url: https://docs.databricks.com/api/account/accountaccesscontrol/updateruleset + x-stackQL-resource: rule_sets + x-stackQL-method: updateruleset + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Rule sets on the resource was updated successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + role: + type: string + principals: + type: array + items: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + rule_set: + type: object + example: + name: string + rule_set: + name: string + grant_rules: + - principals: + - string + role: string + etag: string + description: The rule set to update to. + description: Replace the rules of a rule set. First, use get to read the current + version of the rule set before modifying it. This pattern helps prevent conflicts + between concurrent updates. + /api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals: + post: + operationId: service-principals-create + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/create + x-stackQL-resource: service_principals + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + applicationId: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + roles: + type: Array of object + example: + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new service principal. + description: Creates a new service principal in the Databricks account. + get: + operationId: service-principals-list + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/list + x-stackQL-resource: service_principals + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List service principals operation was succesful. + content: + application/json: + schema: + type: object + properties: + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + id: + type: string + applicationId: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets the set of service principals associated with a Databricks + account. + /api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}: + delete: + operationId: service-principals-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/delete + x-stackQL-resource: service_principals + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Service principal was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete a single service principal in the Databricks account. + get: + operationId: service-principals-get + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/get + x-stackQL-resource: service_principals + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + applicationId: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the details for a single service principal define in the Databricks + account. + patch: + operationId: service-principals-patch + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/patch + x-stackQL-resource: service_principals + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on service principal information. + description: Partially updates the details of a single service principal in + the Databricks account. + put: + operationId: service-principals-update + externalDocs: + url: https://docs.databricks.com/api/account/accountserviceprincipals/update + x-stackQL-resource: service_principals + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + roles: + type: Array of object + example: + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Updates the details of a single service principal. + /api/2.0/accounts/{account_id}/scim/v2/Users: + post: + operationId: users-create + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/create + x-stackQL-resource: users + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + roles: + type: Array of object + example: + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new user. + description: Creates a new user in the Databricks account. This new user will + also be added to the Databricks account. + get: + operationId: users-list + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/list + x-stackQL-resource: users + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List users operation was succesful. + content: + application/json: + schema: + type: object + properties: + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets details for all the users associated with a Databricks account. + /api/2.0/accounts/{account_id}/scim/v2/Users/{id}: + delete: + operationId: users-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/delete + x-stackQL-resource: users + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: User was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a user. Deleting a user from a Databricks account also + removes objects associated with the user. + get: + operationId: users-get + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/get + x-stackQL-resource: users + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: User information was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets information for a specific user in Databricks account. + patch: + operationId: users-patch + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/patch + x-stackQL-resource: users + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on user information. + description: Partially updates a user resource by applying the supplied operations + on specific user attributes. + put: + operationId: users-update + externalDocs: + url: https://docs.databricks.com/api/account/accountusers/update + x-stackQL-resource: users + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + roles: + type: Array of object + example: + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Replaces a user's information with the data supplied in request. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/permissions: + get: + operationId: workspace-permissions-get + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/get + x-stackQL-resource: workspace_permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permissions + description: Get an array of workspace permissions for the specified account + and workspace. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}: + put: + operationId: workspace-permission-assignments-createorupdate + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/update + x-stackQL-resource: workspace_permission_assignments + x-stackQL-method: createorupdate + x-stackQL-verb: insert + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: principal_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + principal: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + principal_id: + type: integer + display_name: + type: string + permissions: + type: array + items: + type: string + error: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + permissions: + type: Array of string + example: + permissions: + - UNKNOWN + description: Creates or updates the workspace permissions assignment in a given + account and workspace for the specified principal. + delete: + operationId: workspace-permission-assignments-delete + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/delete + x-stackQL-resource: workspace_permission_assignments + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: principal_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Deletes the workspace permissions assignment in a given account + and workspace for the specified principal. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments: + get: + operationId: workspace-permission-assignments-list + externalDocs: + url: https://docs.databricks.com/api/account/workspaceassignment/list + x-stackQL-resource: workspace_permission_assignments + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + permission_assignments: + type: array + items: + type: object + properties: + principal: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + principal_id: + type: integer + display_name: + type: string + permissions: + type: array + items: + type: string + error: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_assignments + description: Get the permission assignments for the specified Databricks account + and Databricks workspace. +components: + x-stackQL-resources: + assignable_roles: + id: databricks_account.iam.assignable_roles + name: assignable_roles + title: Assignable_roles + methods: + getassignablerolesforresource: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1{account_id}~1access-control~1assignable-roles/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assignable_roles/methods/getassignablerolesforresource' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + groups: + id: databricks_account.iam.groups + name: groups + title: Groups + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Groups~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete' + exec: [] + rule_sets: + id: databricks_account.iam.rule_sets + name: rule_sets + title: Rule_sets + methods: + getruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1{account_id}~1access-control~1rule-sets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1{account_id}~1access-control~1rule-sets/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/updateruleset' + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/getruleset' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + service_principals: + id: databricks_account.iam.service_principals + name: service_principals + title: Service_principals + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1ServicePrincipals~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/get' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/delete' + exec: [] + users: + id: databricks_account.iam.users + name: users + title: Users + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1scim~1v2~1Users~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/users/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + exec: [] + workspace_permissions: + id: databricks_account.iam.workspace_permissions + name: workspace_permissions + title: Workspace_permissions + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments~1permissions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permissions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_permissions/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + workspace_permission_assignments: + id: databricks_account.iam.workspace_permission_assignments + name: workspace_permission_assignments + title: Workspace_permission_assignments + methods: + createorupdate: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments~1principals~1{principal_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments~1principals~1{principal_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1permissionassignments/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_assignments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_permission_assignments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workspace_permission_assignments/methods/createorupdate' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/workspace_permission_assignments/methods/delete' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/logging.yaml b/providers/src/databricks_account/v00.00.00000/services/logging.yaml new file mode 100644 index 00000000..e7338fa4 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/logging.yaml @@ -0,0 +1,371 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Logging API + description: Log Delivery +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/log-delivery: + post: + operationId: log-delivery-create + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/create + x-stackQL-resource: log_delivery + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The log delivery configuration creation request succeeded. + content: + application/json: + schema: + type: object + properties: + log_delivery_configuration: + type: object + properties: + account_id: + type: string + config_id: + type: string + creation_time: + type: integer + update_time: + type: integer + log_delivery_status: + type: object + properties: + status: + type: string + message: + type: string + last_attempt_time: + type: string + last_successful_attempt_time: + type: string + config_name: + type: string + status: + type: string + log_type: + type: string + output_format: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + workspace_ids_filter: + type: array + items: + type: integer + delivery_path_prefix: + type: string + delivery_start_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + log_delivery_configuration: + type: object + example: + log_delivery_configuration: + config_name: string + status: ENABLED + log_type: BILLABLE_USAGE + output_format: CSV + credentials_id: c7814269-df58-4ca3-85e9-f6672ef43d77 + storage_configuration_id: 04aae505-1b1e-4cb9-997d-e1c49282675d + workspace_ids_filter: + - 0 + delivery_path_prefix: string + delivery_start_time: string + description: Properties of the new log delivery configuration. + description: Creates a new Databricks log delivery configuration to enable delivery + of the specified type of logs to your storage location. This requires that + you already created a + get: + operationId: log-delivery-list + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/list + x-stackQL-resource: log_delivery + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: status + in: query + - name: credentials_id + in: query + - name: storage_configuration_id + in: query + responses: + '200': + description: Log delivery configurations were returned successfully. + content: + application/json: + schema: + type: object + properties: + log_delivery_configurations: + type: array + items: + type: object + properties: + account_id: + type: string + config_id: + type: string + creation_time: + type: integer + update_time: + type: integer + log_delivery_status: + type: object + properties: + status: + type: string + message: + type: string + last_attempt_time: + type: string + last_successful_attempt_time: + type: string + config_name: + type: string + status: + type: string + log_type: + type: string + output_format: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + workspace_ids_filter: + type: array + items: + type: integer + delivery_path_prefix: + type: string + delivery_start_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.log_delivery_configurations + description: Gets all Databricks log delivery configurations associated with + an account specified by ID. + /api/2.0/accounts/{account_id}/log-delivery/{log_delivery_configuration_id}: + get: + operationId: log-delivery-get + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/get + x-stackQL-resource: log_delivery + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: log_delivery_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The log delivery configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + log_delivery_configuration: + type: object + properties: + account_id: + type: string + config_id: + type: string + creation_time: + type: integer + update_time: + type: integer + log_delivery_status: + type: object + properties: + status: + type: string + message: + type: string + last_attempt_time: + type: string + last_successful_attempt_time: + type: string + config_name: + type: string + status: + type: string + log_type: + type: string + output_format: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + workspace_ids_filter: + type: array + items: + type: integer + delivery_path_prefix: + type: string + delivery_start_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.log_delivery_configuration + description: Gets a Databricks log delivery configuration object for an account, + both specified by ID. + patch: + operationId: log-delivery-patchstatus + externalDocs: + url: https://docs.databricks.com/api/account/logdelivery/patchstatus + x-stackQL-resource: log_delivery + x-stackQL-method: patchstatus + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: log_delivery_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The log delivery configuration was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + type: required + example: + status: ENABLED + description: The new status for this log delivery configuration object. + description: Enables or disables a log delivery configuration. Deletion of delivery + configurations is not supported, so disable log delivery configurations that + are no longer needed. Note that you can't re-enable a delivery configuration + if this would violate the delivery configuration limits described under +components: + x-stackQL-resources: + log_delivery: + id: databricks_account.logging.log_delivery + name: log_delivery + title: Log_delivery + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_delivery_configurations + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery~1{log_delivery_configuration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_delivery_configuration + patchstatus: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1log-delivery~1{log_delivery_configuration_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/get' + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/create' + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/log_delivery/methods/patchstatus' diff --git a/providers/src/databricks_account/v00.00.00000/services/oauth.yaml b/providers/src/databricks_account/v00.00.00000/services/oauth.yaml new file mode 100644 index 00000000..e8457f4d --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/oauth.yaml @@ -0,0 +1,935 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Oauth API + description: OAuth Integrations +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations: + post: + operationId: custom-app-integrations-create + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/create + x-stackQL-resource: custom_app_integrations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + client_id: + type: string + client_secret: + type: string + integration_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + redirect_urls: + type: Array of string + name: + type: string + confidential: + type: boolean + scopes: + type: Array of string + token_access_policy: + type: object + example: + summary: Create Tableau Cloud OAuth App Integration + value: + name: Example Tableau Server + scopes: + - all-apis + - offline_access + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + redirect_urls: + - https://example.online.tableau.com/auth/add_oauth_token + confidential: true + description: Create Custom OAuth App Integration. + get: + operationId: custom-app-integrations-list + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/list + x-stackQL-resource: custom_app_integrations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + - name: include_creator_username + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + integration_id: + type: string + client_id: + type: string + redirect_urls: + type: array + items: + type: string + name: + type: string + confidential: + type: boolean + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + scopes: + type: array + items: + type: string + created_by: + type: integer + create_time: + type: string + creator_username: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + x-stackQL-objectKey: $.apps + description: Get the list of custom OAuth app integrations for the specified + Databricks account + /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations/{integration_id}: + delete: + operationId: custom-app-integrations-delete + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/delete + x-stackQL-resource: custom_app_integrations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Delete an existing Custom OAuth App Integration. You can retrieve + the custom OAuth app integration via + get: + operationId: custom-app-integrations-get + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/get + x-stackQL-resource: custom_app_integrations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + integration_id: + type: string + client_id: + type: string + redirect_urls: + type: array + items: + type: string + name: + type: string + confidential: + type: boolean + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + scopes: + type: array + items: + type: string + created_by: + type: integer + create_time: + type: string + creator_username: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Gets the Custom OAuth App Integration for the given integration + id. + patch: + operationId: custom-app-integrations-update + externalDocs: + url: https://docs.databricks.com/api/account/customappintegration/update + x-stackQL-resource: custom_app_integrations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + redirect_urls: + type: Array of string + token_access_policy: + type: object + example: + value: + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + description: Updates an existing custom OAuth App Integration. You can retrieve + the custom OAuth app integration via + /api/2.0/accounts/{account_id}/oauth2/published-apps: + get: + operationId: published-apps-list + externalDocs: + url: https://docs.databricks.com/api/account/oauthpublishedapps/list + x-stackQL-resource: published_apps + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + app_id: + type: string + client_id: + type: string + name: + type: string + description: + type: string + is_confidential_client: + type: boolean + redirect_urls: + type: array + items: + type: string + scopes: + type: array + items: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + x-stackQL-objectKey: $.apps + description: Get all the available published OAuth apps in Databricks. + /api/2.0/accounts/{account_id}/oauth2/published-app-integrations: + post: + operationId: published-app-integrations-create + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/create + x-stackQL-resource: published_app_integrations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + integration_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + app_id: + type: string + token_access_policy: + type: object + example: + PowerBI: + summary: Enable PowerBI OAuth Login + value: + app_id: power-bi + TableauDesktop: + summary: Enable Tableau Desktop OAuth Login + value: + app_id: tableau-desktop + description: Create Published OAuth App Integration. + get: + operationId: published-app-integrations-list + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/list + x-stackQL-resource: published_app_integrations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + app_id: + type: string + integration_id: + type: string + name: + type: string + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + created_by: + type: integer + create_time: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + x-stackQL-objectKey: $.apps + description: Get the list of published OAuth app integrations for the specified + Databricks account + /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}: + delete: + operationId: published-app-integrations-delete + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/delete + x-stackQL-resource: published_app_integrations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Delete an existing Published OAuth App Integration. You can retrieve + the published OAuth app integration via + get: + operationId: published-app-integrations-get + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/get + x-stackQL-resource: published_app_integrations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + app_id: + type: string + integration_id: + type: string + name: + type: string + token_access_policy: + type: object + properties: + access_token_ttl_in_minutes: + type: integer + refresh_token_ttl_in_minutes: + type: integer + created_by: + type: integer + create_time: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + description: Gets the Published OAuth App Integration for the given integration + id. + patch: + operationId: published-app-integrations-update + externalDocs: + url: https://docs.databricks.com/api/account/publishedappintegration/update + x-stackQL-resource: published_app_integrations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: integration_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + '501': + description: Operation is not implemented or is not supported/enabled in + this service. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token_access_policy: + type: object + example: + value: + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + description: Updates an existing published OAuth App Integration. You can retrieve + the published OAuth app integration via + /api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets: + post: + operationId: service-principal-secrets-create + externalDocs: + url: https://docs.databricks.com/api/account/serviceprincipalsecrets/create + x-stackQL-resource: service_principal_secrets + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: service_principal_id + required: true + description: int64 + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + secret: + type: string + secret_hash: + type: string + create_time: + type: string + update_time: + type: string + status: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Create a secret for the given service principal. + get: + operationId: service-principal-secrets-list + externalDocs: + url: https://docs.databricks.com/api/account/serviceprincipalsecrets/list + x-stackQL-resource: service_principal_secrets + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: service_principal_id + required: true + description: int64 + in: path + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + secrets: + type: array + items: + type: object + properties: + id: + type: string + secret_hash: + type: string + create_time: + type: string + update_time: + type: string + status: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.secrets + description: List all secrets associated with the given service principal. This + operation only returns information about the secrets themselves and does not + include the secret values. + /api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets/{secret_id}: + delete: + operationId: service-principal-secrets-delete + externalDocs: + url: https://docs.databricks.com/api/account/serviceprincipalsecrets/delete + x-stackQL-resource: service_principal_secrets + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: string + in: path + - name: service_principal_id + required: true + description: int64 + in: path + - name: secret_id + required: true + description: string + in: path + responses: + '200': + description: The secret was successfully deleted. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete a secret from the given service principal. +components: + x-stackQL-resources: + custom_app_integrations: + id: databricks_account.oauth.custom_app_integrations + name: custom_app_integrations + title: Custom_app_integrations + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations~1{integration_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations~1{integration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1custom-app-integrations~1{integration_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/custom_app_integrations/methods/delete' + exec: [] + published_apps: + id: databricks_account.oauth.published_apps + name: published_apps + title: Published_apps + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-apps/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/published_apps/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + published_app_integrations: + id: databricks_account.oauth.published_app_integrations + name: published_app_integrations + title: Published_app_integrations + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations~1{integration_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations~1{integration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1oauth2~1published-app-integrations~1{integration_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/get' + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/published_app_integrations/methods/delete' + exec: [] + service_principal_secrets: + id: databricks_account.oauth.service_principal_secrets + name: service_principal_secrets + title: Service_principal_secrets + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1servicePrincipals~1{service_principal_id}~1credentials~1secrets/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1servicePrincipals~1{service_principal_id}~1credentials~1secrets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.secrets + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1servicePrincipals~1{service_principal_id}~1credentials~1secrets~1{secret_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_principal_secrets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_principal_secrets/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/service_principal_secrets/methods/delete' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml new file mode 100644 index 00000000..ab254281 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml @@ -0,0 +1,2158 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Provisioning API + description: Account Provisioning +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/credentials: + post: + operationId: credentials-create + externalDocs: + url: https://docs.databricks.com/api/account/credentials/create + x-stackQL-resource: credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The credential configuration creation request succeeded. + content: + application/json: + schema: + type: object + properties: + credentials_id: + type: string + credentials_name: + type: string + aws_credentials: + type: object + properties: + sts_role: + type: object + properties: + role_arn: + type: string + external_id: + type: string + account_id: + type: string + creation_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credentials_name: + type: required + aws_credentials: + type: required + example: + credentials_name: credential_1 + aws_credentials: + sts_role: + role_arn: arn-aws-iam::111110000000:role/test_role + description: Properties of the new credential configuration. + description: Creates a Databricks credential configuration that represents cloud + cross-account credentials for a specified account. Databricks uses this to + set up network infrastructure properly to host Databricks clusters. For your + AWS IAM role, you need to trust the External ID (the Databricks Account API + account ID) in the returned credential object, and configure the required + access policy. + get: + operationId: credentials-list + externalDocs: + url: https://docs.databricks.com/api/account/credentials/list + x-stackQL-resource: credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Credential configurations were returned successfully. + content: + application/json: + schema: + type: array + items: + type: object + properties: + credentials_id: + type: string + credentials_name: + type: string + aws_credentials: + type: object + properties: + sts_role: + type: object + properties: + role_arn: + type: string + external_id: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets all Databricks credential configurations associated with an + account specified by ID. + /api/2.0/accounts/{account_id}/credentials/{credentials_id}: + delete: + operationId: credentials-delete + externalDocs: + url: https://docs.databricks.com/api/account/credentials/delete + x-stackQL-resource: credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: credentials_id + required: true + description: uuid + in: path + responses: + '200': + description: The credential configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a Databricks credential configuration object for an account, + both specified by ID. You cannot delete a credential that is associated with + any workspace. + get: + operationId: credentials-get + externalDocs: + url: https://docs.databricks.com/api/account/credentials/get + x-stackQL-resource: credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: credentials_id + required: true + description: uuid + in: path + responses: + '200': + description: The credential configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + credentials_id: + type: string + credentials_name: + type: string + aws_credentials: + type: object + properties: + sts_role: + type: object + properties: + role_arn: + type: string + external_id: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a Databricks credential configuration object for an account, + both specified by ID. + /api/2.0/accounts/{account_id}/customer-managed-keys: + post: + operationId: encryption-keys-create + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/create + x-stackQL-resource: encryption_keys + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The encryption key configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + customer_managed_key_id: + type: string + account_id: + type: string + aws_key_info: + type: object + properties: + key_arn: + type: string + key_alias: + type: string + key_region: + type: string + reuse_key_for_cluster_volumes: + type: boolean + creation_time: + type: integer + use_cases: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + use_cases: + type: required + aws_key_info: + type: object + example: + aws_key_info: + key_arn: arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321 + key_alias: alias/projectKey + reuse_key_for_cluster_volumes: true + use_cases: + - MANAGED_SERVICES + - STORAGE + description: Properties of the encryption key configuration. + description: Creates a customer-managed key configuration object for an account, + specified by ID. This operation uploads a reference to a customer-managed + key to Databricks. If the key is assigned as a workspace's customer-managed + key for managed services, Databricks uses the key to encrypt the workspaces + notebooks and secrets in the control plane, in addition to Databricks SQL + queries and query history. If it is specified as a workspace's customer-managed + key for workspace storage, the key encrypts the workspace's root S3 bucket + (which contains the workspace's root DBFS and system data) and, optionally, + cluster EBS volume data. + get: + operationId: encryption-keys-list + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/list + x-stackQL-resource: encryption_keys + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The encryption key configurations were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + customer_managed_key_id: + type: string + account_id: + type: string + aws_key_info: + type: object + properties: + key_arn: + type: string + key_alias: + type: string + key_region: + type: string + reuse_key_for_cluster_volumes: + type: boolean + creation_time: + type: integer + use_cases: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets all customer-managed key configuration objects for an account. + If the key is specified as a workspace's managed services customer-managed + key, Databricks uses the key to encrypt the workspace's notebooks and secrets + in the control plane, in addition to Databricks SQL queries and query history. + If the key is specified as a workspace's storage customer-managed key, the + key is used to encrypt the workspace's root S3 bucket and optionally can encrypt + cluster EBS volumes data in the data plane. + /api/2.0/accounts/{account_id}/customer-managed-keys/{customer_managed_key_id}: + delete: + operationId: encryption-keys-delete + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/delete + x-stackQL-resource: encryption_keys + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: customer_managed_key_id + required: true + description: uuid + in: path + responses: + '200': + description: The encryption key configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a customer-managed key configuration object for an account. + You cannot delete a configuration that is associated with a running workspace. + get: + operationId: encryption-keys-get + externalDocs: + url: https://docs.databricks.com/api/account/encryptionkeys/get + x-stackQL-resource: encryption_keys + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: customer_managed_key_id + required: true + description: uuid + in: path + responses: + '200': + description: The encryption key configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + customer_managed_key_id: + type: string + account_id: + type: string + aws_key_info: + type: object + properties: + key_arn: + type: string + key_alias: + type: string + key_region: + type: string + reuse_key_for_cluster_volumes: + type: boolean + creation_time: + type: integer + use_cases: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a customer-managed key configuration object for an account, + specified by ID. This operation uploads a reference to a customer-managed + key to Databricks. If assigned as a workspace's customer-managed key for managed + services, Databricks uses the key to encrypt the workspaces notebooks and + secrets in the control plane, in addition to Databricks SQL queries and query + history. If it is specified as a workspace's customer-managed key for storage, + the key encrypts the workspace's root S3 bucket (which contains the workspace's + root DBFS and system data) and, optionally, cluster EBS volume data. + /api/2.0/accounts/{account_id}/networks: + post: + operationId: networks-create + externalDocs: + url: https://docs.databricks.com/api/account/networks/create + x-stackQL-resource: networks + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The network configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + network_id: + type: string + network_name: + type: string + vpc_id: + type: string + subnet_ids: + type: array + items: + type: string + security_group_ids: + type: array + items: + type: string + vpc_status: + type: string + warning_messages: + type: array + items: + type: object + properties: + warning_type: + type: string + warning_message: + type: string + error_messages: + type: array + items: + type: object + properties: + error_type: + type: string + error_message: + type: string + workspace_id: + type: integer + account_id: + type: string + creation_time: + type: integer + vpc_endpoints: + type: object + properties: + rest_api: + type: array + items: + type: string + dataplane_relay: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + network_name: + type: required + vpc_id: + type: string + subnet_ids: + type: string + security_group_ids: + type: Array of string + vpc_endpoints: + type: object + example: + network_name: string + vpc_id: string + subnet_ids: + - string + security_group_ids: + - string + vpc_endpoints: + rest_api: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + dataplane_relay: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + description: Properties of the new network configuration. + description: Creates a Databricks network configuration that represents an AWS + VPC and its resources. The VPC will be used for new Databricks clusters. This + requires a pre-existing VPC and subnets. For VPC requirements, see + get: + operationId: networks-list + externalDocs: + url: https://docs.databricks.com/api/account/networks/list + x-stackQL-resource: networks + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The network configurations were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + network_id: + type: string + network_name: + type: string + vpc_id: + type: string + subnet_ids: + type: array + items: + type: string + security_group_ids: + type: array + items: + type: string + vpc_status: + type: string + warning_messages: + type: array + items: + type: object + properties: + warning_type: + type: string + warning_message: + type: string + error_messages: + type: array + items: + type: object + properties: + error_type: + type: string + error_message: + type: string + workspace_id: + type: integer + account_id: + type: string + creation_time: + type: integer + vpc_endpoints: + type: object + properties: + rest_api: + type: array + items: + type: string + dataplane_relay: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all Databricks network configurations for an account, + specified by ID. + /api/2.0/accounts/{account_id}/networks/{network_id}: + delete: + operationId: networks-delete + externalDocs: + url: https://docs.databricks.com/api/account/networks/delete + x-stackQL-resource: networks + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_id + required: true + description: uuid + in: path + responses: + '200': + description: The network configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a Databricks network configuration, which represents a + cloud VPC and its resources. You cannot delete a network that is associated + with a workspace. + get: + operationId: networks-get + externalDocs: + url: https://docs.databricks.com/api/account/networks/get + x-stackQL-resource: networks + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_id + required: true + description: uuid + in: path + responses: + '200': + description: The network configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + network_id: + type: string + network_name: + type: string + vpc_id: + type: string + subnet_ids: + type: array + items: + type: string + security_group_ids: + type: array + items: + type: string + vpc_status: + type: string + warning_messages: + type: array + items: + type: object + properties: + warning_type: + type: string + warning_message: + type: string + error_messages: + type: array + items: + type: object + properties: + error_type: + type: string + error_message: + type: string + workspace_id: + type: integer + account_id: + type: string + creation_time: + type: integer + vpc_endpoints: + type: object + properties: + rest_api: + type: array + items: + type: string + dataplane_relay: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a Databricks network configuration, which represents an AWS + VPC and its resources. This requires a pre-existing VPC and subnets. + /api/2.0/accounts/{account_id}/private-access-settings: + post: + operationId: private-access-create + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/create + x-stackQL-resource: private_access + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully created. + content: + application/json: + schema: + type: object + properties: + private_access_settings_id: + type: string + private_access_settings_name: + type: string + public_access_enabled: + type: boolean + region: + type: string + account_id: + type: string + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + private_access_settings_name: + type: required + region: + type: string + public_access_enabled: + type: required + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: boolean + example: + private_access_settings_name: string + region: string + public_access_enabled: false + private_access_level: ENDPOINT + allowed_vpc_endpoint_ids: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + description: Properties of the new private access settings object. + description: Creates a private access settings object, which specifies how your + workspace is accessed over + get: + operationId: private-access-list + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/list + x-stackQL-resource: private_access + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + private_access_settings_id: + type: string + private_access_settings_name: + type: string + public_access_enabled: + type: boolean + region: + type: string + account_id: + type: string + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all private access settings objects for an account, + specified by ID. + /api/2.0/accounts/{account_id}/private-access-settings/{private_access_settings_id}: + delete: + operationId: private-access-delete + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/delete + x-stackQL-resource: private_access + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: private_access_settings_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a private access settings object, which determines how + your workspace is accessed over + get: + operationId: private-access-get + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/get + x-stackQL-resource: private_access + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: private_access_settings_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully returned. + content: + application/json: + schema: + type: object + properties: + private_access_settings_id: + type: string + private_access_settings_name: + type: string + public_access_enabled: + type: boolean + region: + type: string + account_id: + type: string + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a private access settings object, which specifies how your + workspace is accessed over + put: + operationId: private-access-replace + externalDocs: + url: https://docs.databricks.com/api/account/privateaccess/replace + x-stackQL-resource: private_access + x-stackQL-method: replace + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: private_access_settings_id + required: true + description: uuid + in: path + responses: + '200': + description: The private access settings object was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + private_access_settings_name: + type: required + region: + type: string + public_access_enabled: + type: required + private_access_level: + type: string + allowed_vpc_endpoint_ids: + type: boolean + example: + private_access_settings_name: string + region: string + public_access_enabled: false + private_access_level: ENDPOINT + allowed_vpc_endpoint_ids: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + description: Properties of the new private access settings object. + description: Updates an existing private access settings object, which specifies + how your workspace is accessed over + /api/2.0/accounts/{account_id}/storage-configurations: + post: + operationId: storage-create + externalDocs: + url: https://docs.databricks.com/api/account/storage/create + x-stackQL-resource: storage + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The storage configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + storage_configuration_id: + type: string + storage_configuration_name: + type: string + root_bucket_info: + type: object + properties: + bucket_name: + type: string + account_id: + type: string + creation_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + storage_configuration_name: + type: required + root_bucket_info: + type: required + example: + storage_configuration_name: storage_conf_1 + root_bucket_info: + bucket_name: string + description: Properties of the new storage configuration. + description: Creates new storage configuration for an account, specified by + ID. Uploads a storage configuration object that represents the root AWS S3 + bucket in your account. Databricks stores related workspace assets including + DBFS, cluster logs, and job results. For the AWS S3 bucket, you need to configure + the required bucket policy. + get: + operationId: storage-list + externalDocs: + url: https://docs.databricks.com/api/account/storage/list + x-stackQL-resource: storage + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The storage configurations were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + storage_configuration_id: + type: string + storage_configuration_name: + type: string + root_bucket_info: + type: object + properties: + bucket_name: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all Databricks storage configurations for your account, + specified by ID. + /api/2.0/accounts/{account_id}/storage-configurations/{storage_configuration_id}: + delete: + operationId: storage-delete + externalDocs: + url: https://docs.databricks.com/api/account/storage/delete + x-stackQL-resource: storage + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: storage_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The storage configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a Databricks storage configuration. You cannot delete a + storage configuration that is associated with any workspace. + get: + operationId: storage-get + externalDocs: + url: https://docs.databricks.com/api/account/storage/get + x-stackQL-resource: storage + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: storage_configuration_id + required: true + description: uuid + in: path + responses: + '200': + description: The storage configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + storage_configuration_id: + type: string + storage_configuration_name: + type: string + root_bucket_info: + type: object + properties: + bucket_name: + type: string + account_id: + type: string + creation_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a Databricks storage configuration for an account, both specified + by ID. + /api/2.0/accounts/{account_id}/vpc-endpoints: + post: + operationId: vpc-endpoints-create + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/create + x-stackQL-resource: vpc_endpoints + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoint configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + vpc_endpoint_id: + type: string + vpc_endpoint_name: + type: string + aws_vpc_endpoint_id: + type: string + aws_endpoint_service_id: + type: string + use_case: + type: string + region: + type: string + account_id: + type: string + aws_account_id: + type: string + state: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + vpc_endpoint_name: + type: required + aws_vpc_endpoint_id: + type: string + region: + type: string + example: + vpc_endpoint_name: string + aws_vpc_endpoint_id: string + region: string + description: Properties of the new VPC endpoint configuration. + description: Creates a VPC endpoint configuration, which represents a + get: + operationId: vpc-endpoints-list + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/list + x-stackQL-resource: vpc_endpoints + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoints were successfully returned. + content: + application/json: + schema: + type: array + items: + type: object + properties: + vpc_endpoint_id: + type: string + vpc_endpoint_name: + type: string + aws_vpc_endpoint_id: + type: string + aws_endpoint_service_id: + type: string + use_case: + type: string + region: + type: string + account_id: + type: string + aws_account_id: + type: string + state: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all VPC endpoints for an account, specified by ID. + /api/2.0/accounts/{account_id}/vpc-endpoints/{vpc_endpoint_id}: + delete: + operationId: vpc-endpoints-delete + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/delete + x-stackQL-resource: vpc_endpoints + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: vpc_endpoint_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoint configuration was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a VPC endpoint configuration, which represents an + get: + operationId: vpc-endpoints-get + externalDocs: + url: https://docs.databricks.com/api/account/vpcendpoints/get + x-stackQL-resource: vpc_endpoints + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: vpc_endpoint_id + required: true + description: uuid + in: path + responses: + '200': + description: The VPC endpoint was successfully returned. + content: + application/json: + schema: + type: object + properties: + vpc_endpoint_id: + type: string + vpc_endpoint_name: + type: string + aws_vpc_endpoint_id: + type: string + aws_endpoint_service_id: + type: string + use_case: + type: string + region: + type: string + account_id: + type: string + aws_account_id: + type: string + state: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a VPC endpoint configuration, which represents a + /api/2.0/accounts/{account_id}/workspaces: + post: + operationId: workspaces-create + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/create + x-stackQL-resource: workspaces + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: Workspace creation request was received. Check workspace status. + content: + application/json: + schema: + type: object + properties: + workspace_id: + type: integer + workspace_name: + type: string + deployment_name: + type: string + network_id: + type: string + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + account_id: + type: string + workspace_status: + type: string + workspace_status_message: + type: string + managed_services_customer_managed_key_id: + type: string + private_access_settings_id: + type: string + creation_time: + type: integer + pricing_tier: + type: string + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workspace_name: + type: required + network_id: + type: string + deployment_name: + type: uuid + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: uuid + managed_services_customer_managed_key_id: + type: uuid + private_access_settings_id: + type: uuid + pricing_tier: + type: uuid + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + example: + workspace_name: string + network_id: fd0cc5bc-683c-47e9-b15e-144d7744a496 + deployment_name: workspace_1 + aws_region: us-west-2 + credentials_id: ccc64f28-ebdc-4c89-add9-5dcb6d7727d8 + storage_configuration_id: b43a6064-04c1-4e1c-88b6-d91e5b136b13 + managed_services_customer_managed_key_id: 849b3d6b-e68e-468d-b3e5-deb08b03c56d + private_access_settings_id: 3b3bbcb5-46bd-4b03-944e-97eb44ed7991 + pricing_tier: PREMIUM + storage_customer_managed_key_id: 14138d0f-a575-4ae2-be71-ddfd0b602286 + custom_tags: + property1: string + property2: string + description: Properties of the new workspace. + description: Creates a new workspace using a credential configuration and a + storage configuration, an optional network configuration (if using a customer-managed + VPC), an optional managed services key configuration (if using customer-managed + keys for managed services), and an optional storage key configuration (if + using customer-managed keys for storage). The key configurations used for + managed services and storage encryption can be the same or different. + get: + operationId: workspaces-list + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/list + x-stackQL-resource: workspaces + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The workspaces were returned successfully. + content: + application/json: + schema: + type: array + items: + type: object + properties: + workspace_id: + type: integer + workspace_name: + type: string + deployment_name: + type: string + network_id: + type: string + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + account_id: + type: string + workspace_status: + type: string + workspace_status_message: + type: string + managed_services_customer_managed_key_id: + type: string + private_access_settings_id: + type: string + creation_time: + type: integer + pricing_tier: + type: string + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all workspaces associated with an account, specified + by ID. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}: + delete: + operationId: workspaces-delete + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/delete + x-stackQL-resource: workspaces + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Terminates and deletes a Databricks workspace. From an API perspective, + deletion is immediate. However, it might take a few minutes for all workspaces + resources to be deleted, depending on the size and number of workspace resources. + get: + operationId: workspaces-get + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/get + x-stackQL-resource: workspaces + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + workspace_id: + type: integer + workspace_name: + type: string + deployment_name: + type: string + network_id: + type: string + aws_region: + type: string + credentials_id: + type: string + storage_configuration_id: + type: string + account_id: + type: string + workspace_status: + type: string + workspace_status_message: + type: string + managed_services_customer_managed_key_id: + type: string + private_access_settings_id: + type: string + creation_time: + type: integer + pricing_tier: + type: string + storage_customer_managed_key_id: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets information including status for a Databricks workspace, specified + by ID. In the response, the + patch: + operationId: workspaces-update + externalDocs: + url: https://docs.databricks.com/api/account/workspaces/update + x-stackQL-resource: workspaces + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace update request is accepted. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + '509': + description: An external service is unavailable temporarily as it is being + updated. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + aws_region: + type: string + credentials_id: + type: uuid + storage_configuration_id: + type: uuid + network_id: + type: uuid + managed_services_customer_managed_key_id: + type: uuid + private_access_settings_id: + type: uuid + storage_customer_managed_key_id: + type: uuid + network_connectivity_config_id: + type: uuid + custom_tags: + type: object + example: + aws_region: us-west-2 + credentials_id: c7814269-df58-4ca3-85e9-f6672ef43d77 + storage_configuration_id: 04aae505-1b1e-4cb9-997d-e1c49282675d + network_id: d6797cf4-42b9-4cad-8591-9dd91c3f0fc3 + managed_services_customer_managed_key_id: faacdc79-6530-4583-a154-5d427a663e53 + private_access_settings_id: 3b3bbcb5-46bd-4b03-944e-97eb44ed7991 + storage_customer_managed_key_id: 14138d0f-a575-4ae2-be71-ddfd0b602286 + custom_tags: + property1: string + property2: string + network_connectivity_config_id: 390afeb4-1111-2222-af33-ca3965c04068 + description: Changes of the workspace properties. + description: Updates a workspace configuration for either a running workspace + or a failed workspace. The elements that can be updated varies between these + two use cases. +components: + x-stackQL-resources: + credentials: + id: databricks_account.provisioning.credentials + name: credentials + title: Credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials~1{credentials_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1credentials~1{credentials_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/credentials/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/credentials/methods/delete' + exec: [] + encryption_keys: + id: databricks_account.provisioning.encryption_keys + name: encryption_keys + title: Encryption_keys + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys~1{customer_managed_key_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1customer-managed-keys~1{customer_managed_key_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/delete' + exec: [] + networks: + id: databricks_account.provisioning.networks + name: networks + title: Networks + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks~1{network_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1networks~1{network_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/networks/methods/get' + - $ref: '#/components/x-stackQL-resources/networks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/networks/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/networks/methods/delete' + exec: [] + private_access: + id: databricks_account.provisioning.private_access + name: private_access + title: Private_access + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings~1{private_access_settings_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings~1{private_access_settings_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + replace: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1private-access-settings~1{private_access_settings_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/private_access/methods/get' + - $ref: '#/components/x-stackQL-resources/private_access/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/private_access/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/private_access/methods/replace' + delete: + - $ref: '#/components/x-stackQL-resources/private_access/methods/delete' + exec: [] + storage: + id: databricks_account.provisioning.storage + name: storage + title: Storage + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations~1{storage_configuration_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1storage-configurations~1{storage_configuration_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage/methods/get' + - $ref: '#/components/x-stackQL-resources/storage/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/storage/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/storage/methods/delete' + exec: [] + vpc_endpoints: + id: databricks_account.provisioning.vpc_endpoints + name: vpc_endpoints + title: Vpc_endpoints + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints~1{vpc_endpoint_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1vpc-endpoints~1{vpc_endpoint_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete' + exec: [] + workspaces: + id: databricks_account.provisioning.workspaces + name: workspaces + title: Workspaces + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/get' + - $ref: '#/components/x-stackQL-resources/workspaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/settings.yaml b/providers/src/databricks_account/v00.00.00000/services/settings.yaml new file mode 100644 index 00000000..ae5a1c1a --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/settings.yaml @@ -0,0 +1,985 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Settings API + description: Account Settings +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/settings/types/shield_csp_enablement_ac/names/default: + get: + operationId: compliance-security-profile-get + externalDocs: + url: https://docs.databricks.com/api/account/cspenablementaccount/get + x-stackQL-resource: compliance_security_profile + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + csp_enablement_account: + type: object + properties: + is_enforced: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the compliance security profile setting for new workspaces. + patch: + operationId: compliance-security-profile-update + externalDocs: + url: https://docs.databricks.com/api/account/cspenablementaccount/update + x-stackQL-resource: compliance_security_profile + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + csp_enablement_account: + type: object + properties: + is_enforced: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + csp_enablement_account: + is_enforced: true + compliance_standards: + - NONE + field_mask: string + description: Details required to update a setting. + description: Updates the value of the compliance security profile setting for + new workspaces. + /api/2.0/accounts/{account_id}/settings/types/shield_esm_enablement_ac/names/default: + get: + operationId: enhanced-security-monitoring-get + externalDocs: + url: https://docs.databricks.com/api/account/esmenablementaccount/get + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + esm_enablement_account: + type: object + properties: + is_enforced: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the enhanced security monitoring setting for new workspaces. + patch: + operationId: enhanced-security-monitoring-update + externalDocs: + url: https://docs.databricks.com/api/account/esmenablementaccount/update + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + esm_enablement_account: + type: object + properties: + is_enforced: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + esm_enablement_account: + is_enforced: true + field_mask: string + description: Details required to update a setting. + description: Updates the value of the enhanced security monitoring setting for + new workspaces. + /api/2.0/accounts/{account_id}/ip-access-lists: + post: + operationId: ip-access-lists-create + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/create + x-stackQL-resource: ip_access_lists + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + description: Details required to configure a block list or allow list. + description: Creates an IP access list for the account. + get: + operationId: ip-access-lists-list + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/list + x-stackQL-resource: ip_access_lists + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_lists: + type: array + items: + type: object + properties: + address_count: + type: integer + created_at: + type: integer + created_by: + type: integer + enabled: + type: boolean + ip_addresses: + type: array + items: + type: string + label: + type: string + list_id: + type: string + list_type: + type: string + updated_at: + type: integer + updated_by: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_lists + description: Gets all IP access lists for the specified account. + /api/2.0/accounts/{account_id}/ip-access-lists/{ip_access_list_id}: + delete: + operationId: ip-access-lists-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/delete + x-stackQL-resource: ip_access_lists + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an IP access list, specified by its list ID. + get: + operationId: ip-access-lists-get + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/get + x-stackQL-resource: ip_access_lists + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_list + description: Gets an IP access list, specified by its list ID. + put: + operationId: ip-access-lists-replace + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/replace + x-stackQL-resource: ip_access_lists + x-stackQL-method: replace + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + enabled: + type: string + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to replace an IP access list. + description: Replaces an IP access list, specified by its ID. + patch: + operationId: ip-access-lists-update + externalDocs: + url: https://docs.databricks.com/api/account/accountipaccesslists/update + x-stackQL-resource: ip_access_lists + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: string + in: path + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: string + list_type: + type: string + ip_addresses: + type: Array of string + enabled: + type: boolean + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to update an IP access list. + description: Updates an existing IP access list, specified by its ID. + /api/2.0/accounts/{account_id}/network-connectivity-configs: + post: + operationId: network-connectivity-createnetworkconnectivityconfiguration + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/createnetworkconnectivityconfiguration + x-stackQL-resource: network_connectivity + x-stackQL-method: createnetworkconnectivityconfiguration + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: The network connectivity configuration was successfully created. + content: + application/json: + schema: + type: object + properties: + network_connectivity_config_id: + type: string + account_id: + type: string + name: + type: string + region: + type: string + egress_config: + type: object + properties: + default_rules: + type: object + properties: + aws_stable_ip_rule: + type: object + properties: + cidr_blocks: + type: array + items: + type: string + creation_time: + type: integer + updated_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + region: + type: uuid + example: + name: 9ffa9185-7453-4fb2-aa6a-3105a6ae83a8 + region: string + description: Properties of the new network connectivity configuration. + description: Creates a network connectivity configuration (NCC), which provides + stable IP CIDR blocks that are associated with your workspace. You can assign + an NCC to one or more workspaces in the same region. Once assigned, the workspace + serverless compute resources use the same set of stable IP CIDR blocks to + access your resources. + get: + operationId: network-connectivity-listnetworkconnectivityconfigurations + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/listnetworkconnectivityconfigurations + x-stackQL-resource: network_connectivity + x-stackQL-method: listnetworkconnectivityconfigurations + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: page_token + in: query + responses: + '200': + description: The network connectivity configuration list was successfully + retrieved. + content: + application/json: + schema: + type: object + properties: + items: + type: array + items: + type: object + properties: + network_connectivity_config_id: + type: string + account_id: + type: string + name: + type: string + region: + type: string + egress_config: + type: object + properties: + default_rules: + type: object + properties: + aws_stable_ip_rule: + type: object + properties: + cidr_blocks: + type: array + items: + type: string + creation_time: + type: integer + updated_time: + type: integer + next_page_token: + type: string + description: Gets an array of network connectivity configurations. + /api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}: + delete: + operationId: network-connectivity-deletenetworkconnectivityconfiguration + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/deletenetworkconnectivityconfiguration + x-stackQL-resource: network_connectivity + x-stackQL-method: deletenetworkconnectivityconfiguration + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_connectivity_config_id + required: true + description: uuid + in: path + responses: + '200': + description: The network connectivity config was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes a network connectivity configuration. + get: + operationId: network-connectivity-getnetworkconnectivityconfiguration + externalDocs: + url: https://docs.databricks.com/api/account/networkconnectivity/getnetworkconnectivityconfiguration + x-stackQL-resource: network_connectivity + x-stackQL-method: getnetworkconnectivityconfiguration + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: network_connectivity_config_id + required: true + description: uuid + in: path + responses: + '200': + description: The network connectivity configuration was successfully returned. + content: + application/json: + schema: + type: object + properties: + network_connectivity_config_id: + type: string + account_id: + type: string + name: + type: string + region: + type: string + egress_config: + type: object + properties: + default_rules: + type: object + properties: + aws_stable_ip_rule: + type: object + properties: + cidr_blocks: + type: array + items: + type: string + creation_time: + type: integer + updated_time: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a network connectivity configuration. +components: + x-stackQL-resources: + compliance_security_profile: + id: databricks_account.settings.compliance_security_profile + name: compliance_security_profile + title: Compliance_security_profile + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_csp_enablement_ac~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_csp_enablement_ac~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/update' + replace: [] + delete: [] + exec: [] + enhanced_security_monitoring: + id: databricks_account.settings.enhanced_security_monitoring + name: enhanced_security_monitoring + title: Enhanced_security_monitoring + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_esm_enablement_ac~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1settings~1types~1shield_esm_enablement_ac~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/update' + replace: [] + delete: [] + exec: [] + ip_access_lists: + id: databricks_account.settings.ip_access_lists + name: ip_access_lists + title: Ip_access_lists + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_lists + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_list + replace: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1ip-access-lists~1{ip_access_list_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/replace' + delete: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/delete' + exec: [] + network_connectivity: + id: databricks_account.settings.network_connectivity + name: network_connectivity + title: Network_connectivity + methods: + createnetworkconnectivityconfiguration: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listnetworkconnectivityconfigurations: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletenetworkconnectivityconfiguration: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs~1{network_connectivity_config_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getnetworkconnectivityconfiguration: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1network-connectivity-configs~1{network_connectivity_config_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/getnetworkconnectivityconfiguration' + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/listnetworkconnectivityconfigurations' + insert: + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/createnetworkconnectivityconfiguration' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/network_connectivity/methods/deletenetworkconnectivityconfiguration' + exec: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml b/providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml new file mode 100644 index 00000000..792fe362 --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/unity_catalog.yaml @@ -0,0 +1,1158 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Unity_catalog API + description: Unity Catalog +servers: +- url: https://accounts.cloud.databricks.com +paths: + /api/2.0/accounts/{account_id}/metastores: + post: + operationId: metastores-create + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/create + x-stackQL-resource: metastores + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore was successfully created. + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + example: + metastore_info: + name: string + storage_root: string + region: string + description: Properties of the new metastore. + description: Creates a Unity Catalog metastore. + get: + operationId: metastores-list + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/list + x-stackQL-resource: metastores + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: account_id + required: true + description: uuid + in: path + responses: + '200': + description: Metastores were returned successfully. + content: + application/json: + schema: + type: object + properties: + metastores: + type: array + items: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + x-stackQL-objectKey: $.metastores + description: Gets all Unity Catalog metastores associated with an account specified + by ID. + /api/2.0/accounts/{account_id}/metastores/{metastore_id}: + delete: + operationId: metastores-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/delete + x-stackQL-resource: metastores + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: force + in: query + responses: + '200': + description: The metastore was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a Unity Catalog metastore for an account, both specified + by ID. + get: + operationId: metastores-get + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/get + x-stackQL-resource: metastores + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore was successfully returned. + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.metastore_info + description: Gets a Unity Catalog metastore from an account, both specified + by ID. + put: + operationId: metastores-update + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastores/update + x-stackQL-resource: metastores + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore update request succeeded. + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_info: + type: object + example: + metastore_info: + storage_root_credential_id: string + delta_sharing_recipient_token_lifetime_in_seconds: 0 + delta_sharing_organization_name: string + owner: string + privilege_model_version: string + new_name: string + delta_sharing_scope: INTERNAL + description: Properties of the metastore to change. + description: Updates an existing Unity Catalog metastore. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}: + post: + operationId: metastore-assignments-create + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/create + x-stackQL-resource: metastore_assignments + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore assignment was successfully created. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_assignment: + type: object + example: + metastore_assignment: + metastore_id: string + default_catalog_name: string + description: The mapping from workspace to metastore. + description: Creates an assignment to a metastore for a workspace + delete: + operationId: metastore-assignments-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/delete + x-stackQL-resource: metastore_assignments + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore assignment was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a metastore assignment to a workspace, leaving the workspace + with no metastore. + put: + operationId: metastore-assignments-update + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/update + x-stackQL-resource: metastore_assignments + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '201': + description: The metastore assignment was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_assignment: + type: object + example: + metastore_assignment: + metastore_id: string + default_catalog_name: string + description: The metastore assignment to update. + description: Updates an assignment to a metastore for a workspace. Currently, + only the default catalog may be updated. + /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastore: + get: + operationId: metastore-assignments-get + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/get + x-stackQL-resource: metastore_assignments + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The workspace metastore assignment was successfully returned. + content: + application/json: + schema: + type: object + properties: + metastore_assignment: + type: object + properties: + metastore_id: + type: string + workspace_id: + type: integer + default_catalog_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.metastore_assignment + description: Gets the metastore assignment, if any, for the workspace specified + by ID. If the workspace is assigned a metastore, the mappig will be returned. + If no metastore is assigned to the workspace, the assignment will not be found + and a 404 returned. + /api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials: + post: + operationId: storage-credentials-create + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/create + x-stackQL-resource: storage_credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The new storage credential was successfully created. + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + example: + credential_info: + name: string + comment: string + read_only: true + aws_iam_role: + role_arn: string + skip_validation: false + description: 'Creates a new storage credential. The request object is specific + to the cloud:' + get: + operationId: storage-credentials-list + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/list + x-stackQL-resource: storage_credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore storage credentials were successfully returned. + content: + application/json: + schema: + type: object + properties: + storage_credentials: + type: array + items: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + x-stackQL-objectKey: $.storage_credentials + description: Gets a list of all storage credentials that have been assigned + to given metastore. + /api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials/{storage_credential_name}: + delete: + operationId: storage-credentials-delete + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/delete + x-stackQL-resource: storage_credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: storage_credential_name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The storage credential was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a storage credential from the metastore. The caller must + be an owner of the storage credential. + get: + operationId: storage-credentials-get + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/get + x-stackQL-resource: storage_credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: storage_credential_name + required: true + description: string + in: path + responses: + '200': + description: The storage credential was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.credential_info + description: Gets a storage credential from the metastore. The caller must be + a metastore admin, the owner of the storage credential, or have a level of + privilege on the storage credential. + put: + operationId: storage-credentials-update + externalDocs: + url: https://docs.databricks.com/api/account/accountstoragecredentials/update + x-stackQL-resource: storage_credentials + x-stackQL-method: update + x-stackQL-verb: replace + x-numReqParams: 3 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + - name: storage_credential_name + required: true + description: string + in: path + responses: + '201': + description: The storage credential was successfully updated. + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_info: + type: object + example: + credential_info: + comment: string + read_only: true + owner: string + aws_iam_role: + role_arn: string + isolation_mode: ISOLATION_MODE_OPEN + new_name: string + skip_validation: false + force: true + description: The storage credential to update. + description: Updates a storage credential on the metastore. The caller must + be the owner of the storage credential. If the caller is a metastore admin, + only the + /api/2.0/accounts/{account_id}/metastores/{metastore_id}/workspaces: + get: + operationId: workspace-assignments-list + externalDocs: + url: https://docs.databricks.com/api/account/accountmetastoreassignments/list + x-stackQL-resource: workspace_assignments + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: account_id + required: true + description: uuid + in: path + - name: metastore_id + required: true + description: uuid + in: path + responses: + '200': + description: The metastore assignments were successfully returned. + content: + application/json: + schema: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a list of all Databricks workspace IDs that have been assigned + to given metastore. +components: + x-stackQL-resources: + metastores: + id: databricks_account.unity_catalog.metastores + name: metastores + title: Metastores + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastores + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastore_info + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastores/methods/get' + - $ref: '#/components/x-stackQL-resources/metastores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/metastores/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/metastores/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/metastores/methods/delete' + exec: [] + metastore_assignments: + id: databricks_account.unity_catalog.metastore_assignments + name: metastore_assignments + title: Metastore_assignments + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastores~1{metastore_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastores~1{metastore_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastores~1{metastore_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1workspaces~1{workspace_id}~1metastore/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastore_assignment + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/delete' + exec: [] + storage_credentials: + id: databricks_account.unity_catalog.storage_credentials + name: storage_credentials + title: Storage_credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.storage_credentials + delete: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials~1{storage_credential_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials~1{storage_credential_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.credential_info + update: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1storage-credentials~1{storage_credential_name}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/delete' + exec: [] + workspace_assignments: + id: databricks_account.unity_catalog.workspace_assignments + name: workspace_assignments + title: Workspace_assignments + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1accounts~1{account_id}~1metastores~1{metastore_id}~1workspaces/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/provider.yaml b/providers/src/databricks_workspace/v00.00.00000/provider.yaml new file mode 100644 index 00000000..eeeb005f --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/provider.yaml @@ -0,0 +1,176 @@ +id: databricks_workspace +name: databricks_workspace +version: v00.00.00000 +providerServices: + apps: + id: apps:v00.00.00000 + name: apps + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/apps.yaml + title: Apps + version: v00.00.00000 + description: Apps + cleanrooms: + id: cleanrooms:v00.00.00000 + name: cleanrooms + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/cleanrooms.yaml + title: Cleanrooms + version: v00.00.00000 + description: Cleanrooms + compute: + id: compute:v00.00.00000 + name: compute + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/compute.yaml + title: Compute + version: v00.00.00000 + description: Compute + dbsql: + id: dbsql:v00.00.00000 + name: dbsql + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/dbsql.yaml + title: Dbsql + version: v00.00.00000 + description: Dbsql + deltalivetables: + id: deltalivetables:v00.00.00000 + name: deltalivetables + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/deltalivetables.yaml + title: Deltalivetables + version: v00.00.00000 + description: Deltalivetables + deltasharing: + id: deltasharing:v00.00.00000 + name: deltasharing + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/deltasharing.yaml + title: Deltasharing + version: v00.00.00000 + description: Deltasharing + filemanagement: + id: filemanagement:v00.00.00000 + name: filemanagement + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/filemanagement.yaml + title: Filemanagement + version: v00.00.00000 + description: Filemanagement + iam: + id: iam:v00.00.00000 + name: iam + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/iam.yaml + title: Iam + version: v00.00.00000 + description: Iam + lakeview: + id: lakeview:v00.00.00000 + name: lakeview + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/lakeview.yaml + title: Lakeview + version: v00.00.00000 + description: Lakeview + machinelearning: + id: machinelearning:v00.00.00000 + name: machinelearning + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/machinelearning.yaml + title: Machinelearning + version: v00.00.00000 + description: Machinelearning + marketplace: + id: marketplace:v00.00.00000 + name: marketplace + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/marketplace.yaml + title: Marketplace + version: v00.00.00000 + description: Marketplace + realtimeserving: + id: realtimeserving:v00.00.00000 + name: realtimeserving + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/realtimeserving.yaml + title: Realtimeserving + version: v00.00.00000 + description: Realtimeserving + repos: + id: repos:v00.00.00000 + name: repos + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/repos.yaml + title: Repos + version: v00.00.00000 + description: Repos + secrets: + id: secrets:v00.00.00000 + name: secrets + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/secrets.yaml + title: Secrets + version: v00.00.00000 + description: Secrets + unitycatalog: + id: unitycatalog:v00.00.00000 + name: unitycatalog + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/unitycatalog.yaml + title: Unitycatalog + version: v00.00.00000 + description: Unitycatalog + vectorsearch: + id: vectorsearch:v00.00.00000 + name: vectorsearch + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/vectorsearch.yaml + title: Vectorsearch + version: v00.00.00000 + description: Vectorsearch + workflows: + id: workflows:v00.00.00000 + name: workflows + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/workflows.yaml + title: Workflows + version: v00.00.00000 + description: Workflows + workspace: + id: workspace:v00.00.00000 + name: workspace + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/workspace.yaml + title: Workspace + version: v00.00.00000 + description: Workspace +config: + auth: + type: oauth2 + client_id_env_var: DATABRICKS_CLIENT_ID + client_secret_env_var: DATABRICKS_CLIENT_SECRET + grant_type: client_credentials + token_url: https://accounts.cloud.databricks.com/oidc/accounts/{{ .__env__DATABRICKS_ACCOUNT_ID + }}/v1/token + scopes: + - all-apis diff --git a/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml new file mode 100644 index 00000000..1277adac --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml @@ -0,0 +1,1854 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Apps API + description: Apps +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/apps: + post: + operationId: apps-create + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/create + x-stackQL-resource: apps + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + resources: + type: Array of object + example: + name: my-custom-app + description: My app description. + resources: + - name: api-key + description: API key for external service. + secret: + scope: my-scope + key: my-key + permission: READ + sql_warehouse: + id: e9ca293f79a74b5c + permission: CAN_MANAGE + serving_endpoint: + name: databricks-meta-llama-3-1-70b-instruct + permission: CAN_MANAGE + job: + id: '1234' + permission: CAN_MANAGE + description: Creates a new app. + get: + operationId: apps-list + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/list + x-stackQL-resource: apps + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + apps: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.apps + description: Lists all apps in the workspace. + /api/2.0/apps/{name}: + delete: + operationId: apps-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/delete + x-stackQL-resource: apps + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an app. + get: + operationId: apps-get + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/get + x-stackQL-resource: apps + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves information for the app with the supplied name. + patch: + operationId: apps-update + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/update + x-stackQL-resource: apps + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + resources: + type: Array of object + example: + name: my-custom-app + description: My app description. + resources: + - name: api-key + description: API key for external service. + secret: + scope: my-scope + key: my-key + permission: READ + sql_warehouse: + id: e9ca293f79a74b5c + permission: CAN_MANAGE + serving_endpoint: + name: databricks-meta-llama-3-1-70b-instruct + permission: CAN_MANAGE + job: + id: '1234' + permission: CAN_MANAGE + description: Updates the app with the supplied name. + /api/2.0/apps/{app_name}/deployments: + post: + operationId: apps-deploy + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/deploy + x-stackQL-resource: apps + x-stackQL-method: deploy + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + example: + deployment_id: 01ef0bda89f21f08a8351f41e4a9b948 + source_code_path: /Workspace/user@test.com/my_custom_app + mode: SNAPSHOT + description: Creates an app deployment for the app with the supplied name. + get: + operationId: deployments-listdeployments + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/listdeployments + x-stackQL-resource: deployments + x-stackQL-method: listdeployments + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + app_deployments: + type: array + items: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.app_deployments + description: Lists all app deployments for the app with the supplied name. + /api/2.0/apps/{name}/start: + post: + operationId: apps-start + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/start + x-stackQL-resource: apps + x-stackQL-method: start + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Start the last active deployment of the app in the workspace. + /api/2.0/apps/{name}/stop: + post: + operationId: apps-stop + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/stop + x-stackQL-resource: apps + x-stackQL-method: stop + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + compute_status: + type: object + properties: + state: + type: string + message: + type: string + app_status: + type: object + properties: + state: + type: string + message: + type: string + url: + type: string + active_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + updater: + type: string + pending_deployment: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + resources: + type: array + items: + type: object + properties: + name: + type: string + description: + type: string + secret: + type: object + properties: + scope: + type: string + key: + type: string + permission: + type: string + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + job: + type: object + properties: + id: + type: string + permission: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + default_source_code_path: + type: string + service_principal_client_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Stops the active deployment of the app in the workspace. + /api/2.0/apps/{app_name}/deployments/{deployment_id}: + get: + operationId: deployments-getdeployment + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/getdeployment + x-stackQL-resource: deployments + x-stackQL-method: getdeployment + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: app_name + required: true + description: string + in: path + - name: deployment_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + deployment_id: + type: string + source_code_path: + type: string + mode: + type: string + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + status: + type: object + properties: + state: + type: string + message: + type: string + create_time: + type: string + creator: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves information for the app deployment with the supplied + name and deployment id. + /api/2.0/permissions/apps/{app_name}: + get: + operationId: permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/getpermissions + x-stackQL-resource: permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an app. Apps can inherit permissions from + their root object. + put: + operationId: permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/setpermissions + x-stackQL-resource: permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/updatepermissions + x-stackQL-resource: permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an app. Apps can inherit permissions + from their root object. + /api/2.0/permissions/apps/{app_name}/permissionLevels: + get: + operationId: permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/apps/getpermissionlevels + x-stackQL-resource: permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: app_name + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + apps: + id: databricks_workspace.apps.apps + name: apps + title: Apps + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1apps/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1apps/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.apps + delete: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deploy: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{app_name}~1deployments/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}~1start/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{name}~1stop/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/apps/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/apps/methods/stop' + - $ref: '#/components/x-stackQL-resources/apps/methods/start' + - $ref: '#/components/x-stackQL-resources/apps/methods/deploy' + deployments: + id: databricks_workspace.apps.deployments + name: deployments + title: Deployments + methods: + listdeployments: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{app_name}~1deployments/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.app_deployments + getdeployment: + operation: + $ref: '#/paths/~1api~12.0~1apps~1{app_name}~1deployments~1{deployment_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deployments/methods/getdeployment' + - $ref: '#/components/x-stackQL-resources/deployments/methods/listdeployments' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + permissions: + id: databricks_workspace.apps.permissions + name: permissions + title: Permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/setpermissions' + delete: [] + exec: [] + permission_levels: + id: databricks_workspace.apps.permission_levels + name: permission_levels + title: Permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1apps~1{app_name}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml new file mode 100644 index 00000000..5bcb6f2e --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml @@ -0,0 +1,1849 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Cleanrooms API + description: Cleanrooms +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/clean-rooms/{clean_room_name}/assets: + post: + operationId: assets-create + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/create + x-stackQL-resource: assets + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + added_at: + type: integer + status: + type: string + owner_collaborator_alias: + type: string + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + volume_local_details: + type: object + properties: + local_name: + type: string + view_local_details: + type: object + properties: + local_name: + type: string + foreign_table_local_details: + type: object + properties: + local_name: + type: string + table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + notebook: + type: object + properties: + notebook_content: + type: string + etag: + type: string + view: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + foreign_table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + table_local_details: + type: object + volume_local_details: + type: object + view_local_details: + type: object + foreign_table_local_details: + type: object + table: + type: object + notebook: + type: object + view: + type: object + foreign_table: + type: object + example: + name: creator.sales.products + asset_type: TABLE + table_local_details: + local_name: demo.sales.products + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + volume_local_details: + local_name: demo.sales.products + view_local_details: + local_name: demo.sales.products + foreign_table_local_details: + local_name: demo.sales.products + table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + notebook: + notebook_content: string + etag: string + view: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + foreign_table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + description: Metadata of the clean room asset + description: "Create a clean room asset \u2014share an asset like a notebook\ + \ or table into the clean room. For each UC asset that is added through this\ + \ method, the clean room owner must also have enough privilege on the asset\ + \ to consume it. The privilege must be maintained indefinitely for the clean\ + \ room to be able to access the asset. Typically, you should use a group as\ + \ the clean room owner." + get: + operationId: assets-list + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/list + x-stackQL-resource: assets + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + assets: + type: array + items: + type: object + properties: + name: + type: string + asset_type: + type: string + added_at: + type: integer + status: + type: string + owner_collaborator_alias: + type: string + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + volume_local_details: + type: object + properties: + local_name: + type: string + view_local_details: + type: object + properties: + local_name: + type: string + foreign_table_local_details: + type: object + properties: + local_name: + type: string + table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + notebook: + type: object + properties: + notebook_content: + type: string + etag: + type: string + view: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + foreign_table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.assets + /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{asset_full_name}: + delete: + operationId: assets-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/delete + x-stackQL-resource: assets + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: asset_type + required: true + description: string + in: path + - name: asset_full_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a clean room asset - unshare/remove the asset from the clean + room + /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}: + patch: + operationId: assets-update + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomassets/update + x-stackQL-resource: assets + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 3 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: asset_type + required: true + description: string + in: path + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + added_at: + type: integer + status: + type: string + owner_collaborator_alias: + type: string + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + volume_local_details: + type: object + properties: + local_name: + type: string + view_local_details: + type: object + properties: + local_name: + type: string + foreign_table_local_details: + type: object + properties: + local_name: + type: string + table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + notebook: + type: object + properties: + notebook_content: + type: string + etag: + type: string + view: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + foreign_table: + type: object + properties: + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + asset_type: + type: string + table_local_details: + type: object + volume_local_details: + type: object + view_local_details: + type: object + foreign_table_local_details: + type: object + table: + type: object + notebook: + type: object + view: + type: object + foreign_table: + type: object + example: + name: creator.sales.products + asset_type: TABLE + table_local_details: + local_name: demo.sales.products + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + volume_local_details: + local_name: demo.sales.products + view_local_details: + local_name: demo.sales.products + foreign_table_local_details: + local_name: demo.sales.products + table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + notebook: + notebook_content: string + etag: string + view: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + foreign_table: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + description: Metadata of the clean room asset + description: Update a clean room asset. For example, updating the content of + a notebook; changing the shared partitions of a table; etc. + /api/2.0/clean-rooms: + post: + operationId: clean-rooms-create + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/create + x-stackQL-resource: clean_rooms + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + remote_detailed_info: + type: object + example: + name: test-clean-room1 + remote_detailed_info: + central_clean_room_id: b5c8d856-ff41-4c5f-8ccd-2b13b44fec27 + cloud_vendor: aws + region: us-west-2 + collaborators: + - global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + creator: + global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + egress_network_policy: + internet_access: + restriction_mode: FULL_ACCESS + allowed_internet_destinations: + - destination: string + type: FQDN + protocol: TCP + allowed_storage_destinations: + - bucket_name: string + region: string + type: AWS_S3 + azure_storage_account: string + allowed_paths: + - string + azure_storage_service: string + azure_dns_zone: string + azure_container: string + log_only_mode: + log_only_mode_type: ALL_SERVICES + workloads: + - DBSQL + compliance_security_profile: + is_enabled: true + compliance_standards: + - NONE + owner: alice@example.com + comment: This is a clean room for demo + description: Create a new clean room with the specified collaborators. This + method is asynchronous; the returned name field inside the clean_room field + can be used to poll the clean room status, using the + get: + operationId: clean-rooms-list + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/list + x-stackQL-resource: clean_rooms + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + clean_rooms: + type: array + items: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.clean_rooms + description: Get a list of all clean rooms of the metastore. Only clean rooms + the caller has access to are returned. + /api/2.0/clean-rooms/{name}: + delete: + operationId: clean-rooms-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/delete + x-stackQL-resource: clean_rooms + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a clean room. After deletion, the clean room will be removed + from the metastore. If the other collaborators have not deleted the clean + room, they will still have the clean room in their metastore, but it will + be in a DELETED state and no operations other than deletion can be performed + on it. + get: + operationId: clean-rooms-get + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/get + x-stackQL-resource: clean_rooms + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + description: Get the details of a clean room given its name. + patch: + operationId: clean-rooms-update + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/update + x-stackQL-resource: clean_rooms + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + cloud_vendor: + type: string + region: + type: string + collaborators: + type: array + items: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + creator: + type: object + properties: + global_metastore_id: + type: string + organization_name: + type: string + invite_recipient_workspace_id: + type: integer + invite_recipient_email: + type: string + collaborator_alias: + type: string + display_name: + type: string + egress_network_policy: + type: object + properties: + internet_access: + type: object + properties: + restriction_mode: + type: string + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + type: + type: string + protocol: + type: string + allowed_storage_destinations: + type: array + items: + type: object + properties: + bucket_name: + type: string + region: + type: string + type: + type: string + azure_storage_account: + type: string + allowed_paths: + type: array + items: + type: string + azure_storage_service: + type: string + azure_dns_zone: + type: string + azure_container: + type: string + log_only_mode: + type: object + properties: + log_only_mode_type: + type: string + workloads: + type: array + items: + type: string + compliance_security_profile: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + owner: + type: string + comment: + type: string + created_at: + type: integer + updated_at: + type: integer + status: + type: string + local_collaborator_alias: + type: string + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + access_restricted: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clean_room: + type: object + example: + clean_room: + name: test-clean-room1 + remote_detailed_info: + central_clean_room_id: b5c8d856-ff41-4c5f-8ccd-2b13b44fec27 + cloud_vendor: aws + region: us-west-2 + collaborators: + - global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + creator: + global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + egress_network_policy: + internet_access: + restriction_mode: FULL_ACCESS + allowed_internet_destinations: + - destination: string + type: FQDN + protocol: TCP + allowed_storage_destinations: + - bucket_name: string + region: string + type: AWS_S3 + azure_storage_account: string + allowed_paths: + - string + azure_storage_service: string + azure_dns_zone: string + azure_container: string + log_only_mode: + log_only_mode_type: ALL_SERVICES + workloads: + - DBSQL + compliance_security_profile: + is_enabled: true + compliance_standards: + - NONE + owner: alice@example.com + comment: This is a clean room for demo + created_at: 1716424663321 + updated_at: 1716424663321 + status: ACTIVE + local_collaborator_alias: creator + output_catalog: + status: NOT_ELIGIBLE + catalog_name: string + access_restricted: NO_RESTRICTION + description: Update a clean room. The caller must be the owner of the clean + room, have + /api/2.0/clean-rooms/{clean_room_name}/output-catalogs: + post: + operationId: output-catalog-createoutputcatalog + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanrooms/createoutputcatalog + x-stackQL-resource: output_catalog + x-stackQL-method: createoutputcatalog + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + output_catalog: + type: object + properties: + status: + type: string + catalog_name: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + example: + catalog_name: string + description: Create the output catalog of the clean room. + /api/2.0/clean-rooms/{clean_room_name}/runs: + get: + operationId: task-runs-list + externalDocs: + url: https://docs.databricks.com/api/workspace/cleanroomtaskruns/list + x-stackQL-resource: task_runs + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: clean_room_name + required: true + description: string + in: path + - name: notebook_name + in: query + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + runs: + type: array + items: + type: object + properties: + notebook_name: + type: string + start_time: + type: integer + run_duration: + type: integer + notebook_job_run_state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + collaborator_job_run_info: + type: object + properties: + collaborator_job_id: + type: integer + collaborator_job_run_id: + type: integer + collaborator_task_run_id: + type: integer + collaborator_workspace_id: + type: integer + collaborator_alias: + type: string + output_schema_name: + type: string + output_schema_expiration_time: + type: integer + next_page_token: + type: string + x-stackQL-objectKey: $.runs + description: List all the historical notebook task runs in a clean room. +components: + x-stackQL-resources: + assets: + id: databricks_workspace.cleanrooms.assets + name: assets + title: Assets + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.assets + delete: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets~1{asset_type}~1{asset_full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1assets~1{asset_type}~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/assets/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete' + exec: [] + clean_rooms: + id: databricks_workspace.cleanrooms.clean_rooms + name: clean_rooms + title: Clean_rooms + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.clean_rooms + delete: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/get' + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/clean_rooms/methods/delete' + exec: [] + output_catalog: + id: databricks_workspace.cleanrooms.output_catalog + name: output_catalog + title: Output_catalog + methods: + createoutputcatalog: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1output-catalogs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/output_catalog/methods/createoutputcatalog' + update: [] + replace: [] + delete: [] + exec: [] + task_runs: + id: databricks_workspace.cleanrooms.task_runs + name: task_runs + title: Task_runs + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1clean-rooms~1{clean_room_name}~1runs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/task_runs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml new file mode 100644 index 00000000..b4499f14 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml @@ -0,0 +1,4609 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Compute API + description: Compute +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/policies/clusters/list-compliance: + get: + operationId: all-clusters-policy-compliance-listcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforclusters/listcompliance + x-stackQL-resource: all_clusters_policy_compliance + x-stackQL-method: listcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + clusters: + type: array + items: + type: object + properties: + cluster_id: + type: string + is_compliant: + type: boolean + violations: + type: object + properties: + custom_tags.test_tag: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.clusters + description: Returns the policy compliance status of all clusters that use a + given policy. Clusters could be out of compliance if their policy was updated + after the cluster was last edited. + /api/2.1/clusters/change-owner: + post: + operationId: clusters-changeowner + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/changeowner + x-stackQL-resource: clusters + x-stackQL-method: changeowner + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + owner_username: + type: string + example: + cluster_id: string + owner_username: string + description: Change the owner of the cluster. You must be an admin and the cluster + must be terminated to perform this operation. The service principal application + ID can be supplied as an argument to + /api/2.1/clusters/create: + post: + operationId: clusters-create + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/create + x-stackQL-resource: clusters + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_workers: + type: int32 + kind: + type: string + cluster_name: + type: string + spark_version: + type: required + use_ml_runtime: + type: string + is_single_node: + type: boolean + node_type_id: + type: boolean + driver_node_type_id: + type: string + ssh_public_keys: + type: string + autotermination_minutes: + type: Array of string + enable_elastic_disk: + type: int32 + instance_pool_id: + type: boolean + policy_id: + type: string + enable_local_disk_encryption: + type: string + driver_instance_pool_id: + type: boolean + runtime_engine: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: string + autoscale: + type: object + spark_conf: + type: object + aws_attributes: + type: object + custom_tags: + type: object + cluster_log_conf: + type: object + init_scripts: + type: Array of object + spark_env_vars: + type: object + workload_type: + type: object + docker_image: + type: object + clone_from: + type: object + example: + cluster_name: single-node-with-kind-cluster + is_single_node: true + kind: CLASSIC_PREVIEW + spark_version: 14.3.x-scala2.12 + node_type_id: i3.xlarge + aws_attributes: + first_on_demand: 1 + availability: SPOT_WITH_FALLBACK + zone_id: auto + spot_bid_price_percent: 100 + ebs_volume_count: 0 + description: Creates a new Spark cluster. This method will acquire new instances + from the cloud provider if necessary. This method is asynchronous; the returned + /api/2.1/clusters/delete: + post: + operationId: clusters-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/delete + x-stackQL-resource: clusters + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1234-567890-frays123 + description: Terminates the Spark cluster with the specified ID. The cluster + is removed asynchronously. Once the termination has completed, the cluster + will be in a + /api/2.1/clusters/edit: + post: + operationId: clusters-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/edit + x-stackQL-resource: clusters + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + num_workers: + type: string + kind: + type: int32 + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: required + is_single_node: + type: string + node_type_id: + type: boolean + driver_node_type_id: + type: boolean + ssh_public_keys: + type: string + autotermination_minutes: + type: string + enable_elastic_disk: + type: Array of string + instance_pool_id: + type: int32 + policy_id: + type: boolean + enable_local_disk_encryption: + type: string + driver_instance_pool_id: + type: string + runtime_engine: + type: boolean + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: string + autoscale: + type: object + spark_conf: + type: object + aws_attributes: + type: object + custom_tags: + type: object + cluster_log_conf: + type: object + init_scripts: + type: Array of object + spark_env_vars: + type: object + workload_type: + type: object + docker_image: + type: object + example: + cluster_id: 1202-211320-brick1 + num_workers: 10 + spark_version: 3.3.x-scala2.11 + node_type_id: i3.2xlarge + description: Updates the configuration of a cluster to match the provided attributes + and size. A cluster can be updated if it is in a + /api/2.1/clusters/get: + get: + operationId: clusters-get + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/get + x-stackQL-resource: clusters + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: integer + cluster_name: + type: string + spark_version: + type: string + aws_attributes: + type: object + properties: + zone_id: + type: string + first_on_demand: + type: integer + availability: + type: string + spot_bid_price_percent: + type: integer + ebs_volume_count: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_count: + type: integer + cluster_source: + type: string + enable_local_disk_encryption: + type: boolean + instance_source: + type: object + properties: + node_type_id: + type: string + driver_instance_source: + type: object + properties: + node_type_id: + type: string + state: + type: string + state_message: + type: string + start_time: + type: integer + terminated_time: + type: integer + last_state_loss_time: + type: integer + num_workers: + type: integer + default_tags: + type: object + properties: + Vendor: + type: string + Creator: + type: string + ClusterName: + type: string + ClusterId: + type: string + creator_user_name: + type: string + termination_reason: + type: object + properties: + code: + type: string + parameters: + type: object + properties: + inactivity_duration_min: + type: string + type: + type: string + init_scripts_safe_mode: + type: boolean + spec: + type: object + properties: + spark_version: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the information for a cluster given its identifier. Clusters + can be described while they are running, or up to 60 days after they are terminated. + /api/2.1/clusters/list: + get: + operationId: clusters-list + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/list + x-stackQL-resource: clusters + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + - name: null + in: query + - name: null + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + clusters: + type: array + items: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: integer + cluster_name: + type: string + spark_version: + type: string + aws_attributes: + type: object + properties: + zone_id: + type: string + first_on_demand: + type: integer + availability: + type: string + spot_bid_price_percent: + type: integer + ebs_volume_count: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_count: + type: integer + cluster_source: + type: string + enable_local_disk_encryption: + type: boolean + instance_source: + type: object + properties: + node_type_id: + type: string + driver_instance_source: + type: object + properties: + node_type_id: + type: string + state: + type: string + state_message: + type: string + start_time: + type: integer + terminated_time: + type: integer + last_state_loss_time: + type: integer + num_workers: + type: integer + default_tags: + type: object + properties: + Vendor: + type: string + Creator: + type: string + ClusterName: + type: string + ClusterId: + type: string + creator_user_name: + type: string + termination_reason: + type: object + properties: + code: + type: string + parameters: + type: object + properties: + inactivity_duration_min: + type: string + type: + type: string + init_scripts_safe_mode: + type: boolean + prev_page_token: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.clusters + description: Return information about all pinned and active clusters, and all + clusters terminated within the last 30 days. Clusters terminated prior to + this period are not included. + /api/2.1/clusters/permanent-delete: + post: + operationId: clusters-permanentdelete + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/permanentdelete + x-stackQL-resource: clusters + x-stackQL-method: permanentdelete + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1202-211320-brick1 + description: Permanently deletes a Spark cluster. This cluster is terminated + and resources are asynchronously removed. + /api/2.1/clusters/pin: + post: + operationId: clusters-pin + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/pin + x-stackQL-resource: clusters + x-stackQL-method: pin + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1234-567890-reef123 + description: Pinning a cluster ensures that the cluster will always be returned + by the ListClusters API. Pinning a cluster that is already pinned will have + no effect. This API can only be called by workspace admins. + /api/2.1/clusters/resize: + post: + operationId: clusters-resize + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/resize + x-stackQL-resource: clusters + x-stackQL-method: resize + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_workers: + type: int32 + cluster_id: + type: required + autoscale: + type: object + example: + cluster_id: 1202-211320-brick1 + num_workers: 30 + description: Resizes a cluster to have a desired number of workers. This will + fail unless the cluster is in a + /api/2.1/clusters/restart: + post: + operationId: clusters-restart + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/restart + x-stackQL-resource: clusters + x-stackQL-method: restart + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + restart_user: + type: string + example: + cluster_id: 1202-211320-brick1 + description: Restarts a Spark cluster with the supplied ID. If the cluster is + not currently in a + /api/2.1/clusters/start: + post: + operationId: clusters-start + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/start + x-stackQL-resource: clusters + x-stackQL-method: start + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1202-211320-brick1 + description: Starts a terminated Spark cluster with the supplied ID. This works + similar to + /api/2.1/clusters/unpin: + post: + operationId: clusters-unpin + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/unpin + x-stackQL-resource: clusters + x-stackQL-method: unpin + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + example: + cluster_id: 1234-567890-reef123 + description: Unpinning a cluster will allow the cluster to eventually be removed + from the ListClusters API. Unpinning a cluster that is not pinned will have + no effect. This API can only be called by workspace admins. + /api/2.1/clusters/update: + post: + operationId: clusters-update + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/update + x-stackQL-resource: clusters + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + update_mask: + type: string + cluster: + type: object + example: + cluster_id: 1202-211320-brick1 + cluster: + num_workers: 10 + spark_version: 14.3.x-scala2.12 + spark_conf: + spark.databricks.cluster.profile: singleNode + spark.master: '[*, 4]' + update_mask: num_workers,spark_version,spark_conf + description: Updates the configuration of a cluster to match the partial set + of attributes and size. Denote which fields to update using the + /api/2.1/clusters/events: + post: + operationId: cluster-events-events + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/events + x-stackQL-resource: cluster_events + x-stackQL-method: events + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + events: + type: array + items: + type: object + properties: + cluster_id: + type: string + timestamp: + type: integer + event_type: + type: string + event_details: + type: object + properties: + username: + type: string + next_page: + type: object + properties: + cluster_id: + type: string + end_time: + type: integer + order: + type: string + offset: + type: integer + total_count: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + start_time: + type: string + end_time: + type: integer + format: int64 + order: + type: integer + format: int64 + event_types: + type: string + offset: + type: Array of string + limit: + type: integer + format: int64 + example: + start_time: 1617238800000 + end_time: 1619485200000 + offset: 5 + order: DESC + event_types: + - RUNNING + cluster_id: 1234-567890-reef123 + limit: 5 + description: Retrieves a list of events about the activity of a cluster. This + API is paginated. If there are more events to read, the response includes + all the nparameters necessary to request the next page of events. + /api/2.0/permissions/clusters/{cluster_id}: + get: + operationId: cluster-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/getpermissions + x-stackQL-resource: cluster_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a cluster. Clusters can inherit permissions + from their root object. + put: + operationId: cluster-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/setpermissions + x-stackQL-resource: cluster_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: cluster-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/updatepermissions + x-stackQL-resource: cluster_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a cluster. Clusters can inherit permissions + from their root object. + /api/2.0/permissions/clusters/{cluster_id}/permissionLevels: + get: + operationId: cluster-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/getpermissionlevels + x-stackQL-resource: cluster_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/policies/clusters/create: + post: + operationId: cluster-policies-create + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/create + x-stackQL-resource: cluster_policies + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + definition: + type: JSON + description: + type: string + policy_family_id: + type: string + policy_family_definition_overrides: + type: JSON + max_clusters_per_user: + type: integer + format: int64 + libraries: + type: Array of object + example: + definition: '{ "custom_tags.test_tag": { "type": "fixed", "value": + "test_value" } }' + name: Test policy + description: Creates a new policy with prescribed settings. + /api/2.0/policies/clusters/delete: + post: + operationId: cluster-policies-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/delete + x-stackQL-resource: cluster_policies + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + policy_id: + type: required + example: + policy_id: string + description: Delete a policy for a cluster. Clusters governed by this policy + can still run, but cannot be edited. + /api/2.0/policies/clusters/edit: + post: + operationId: cluster-policies-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/edit + x-stackQL-resource: cluster_policies + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + policy_id: + type: required + name: + type: string + definition: + type: string + description: + type: JSON + policy_family_id: + type: string + policy_family_definition_overrides: + type: string + max_clusters_per_user: + type: JSON + libraries: + type: Array of object + example: + definition: '{ "custom_tags.test_tag": { "type": "fixed", "value": + "test_value" } }' + name: Test policy + policy_id: ABCD000000000000 + description: Update an existing policy for cluster. This operation may make + some clusters governed by the previous policy invalid. + /api/2.0/policies/clusters/get: + get: + operationId: cluster-policies-get + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/get + x-stackQL-resource: cluster_policies + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_id + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_id: + type: string + name: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + description: + type: string + policy_family_id: + type: string + policy_family_definition_overrides: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + max_clusters_per_user: + type: integer + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + creator_user_name: + type: string + created_at_timestamp: + type: integer + is_default: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Get a cluster policy entity. Creation and editing is available + to admins only. + /api/2.0/policies/clusters/list: + get: + operationId: cluster-policies-list + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/list + x-stackQL-resource: cluster_policies + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: sort_order + in: query + - name: sort_column + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policies: + type: array + items: + type: object + properties: + policy_id: + type: string + name: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + description: + type: string + policy_family_id: + type: string + policy_family_definition_overrides: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + max_clusters_per_user: + type: integer + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + creator_user_name: + type: string + created_at_timestamp: + type: integer + is_default: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + '504': + description: Deadline expired before the operation could complete. + x-stackQL-objectKey: $.policies + description: Returns a list of policies accessible by the requesting user. + /api/2.0/permissions/cluster-policies/{cluster_policy_id}: + get: + operationId: cluster-policies-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissions + x-stackQL-resource: cluster_policies_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a cluster policy. Cluster policies can + inherit permissions from their root object. + put: + operationId: cluster-policies-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/setpermissions + x-stackQL-resource: cluster_policies_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: cluster-policies-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/updatepermissions + x-stackQL-resource: cluster_policies_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Updates the permissions on a cluster policy. Cluster policies can + inherit permissions from their root object. + /api/2.0/policies/clusters/enforce-compliance: + post: + operationId: cluster-policy-compliance-enforcecompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforclusters/enforcecompliance + x-stackQL-resource: cluster_policy_compliance + x-stackQL-method: enforcecompliance + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + has_changes: + type: boolean + changes: + type: array + items: + type: object + properties: + field: + type: string + previous_value: + type: string + new_value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + validate_only: + type: string + example: + cluster_id: string + validate_only: false + description: Updates a cluster to be compliant with the current version of its + policy. A cluster can be updated if it is in a + /api/2.0/policies/clusters/get-compliance: + get: + operationId: cluster-policy-compliance-getcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforclusters/getcompliance + x-stackQL-resource: cluster_policy_compliance + x-stackQL-method: getcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + is_compliant: + type: boolean + violations: + type: object + properties: + custom_tags.test_tag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Returns the policy compliance status of a cluster. Clusters could + be out of compliance if their policy was updated after the cluster was last + edited. + /api/1.2/commands/cancel: + post: + operationId: commands-cancel + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/cancel + x-stackQL-resource: commands + x-stackQL-method: cancel + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: string + contextId: + type: string + commandId: + type: string + example: + clusterId: string + contextId: string + commandId: string + description: Cancels a currently running command within an execution context. + /api/1.2/commands/status: + get: + operationId: commands-commandstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/commandstatus + x-stackQL-resource: commands + x-stackQL-method: commandstatus + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: clusterId + required: true + description: string + in: query + - name: contextId + required: true + description: string + in: query + - name: commandId + required: true + description: string + in: query + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + status: + type: string + results: + type: object + properties: + resultType: + type: string + data: + type: string + description: Gets the status of and, if available, the results from a currently + executing command. + /api/1.2/contexts/create: + post: + operationId: commands-create + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/create + x-stackQL-resource: commands + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: string + language: + type: string + example: + clusterId: string + language: python + description: Creates an execution context for running cluster commands. + /api/1.2/contexts/destroy: + post: + operationId: commands-destroy + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/destroy + x-stackQL-resource: commands + x-stackQL-method: destroy + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: required + contextId: + type: string + example: + clusterId: string + contextId: string + description: Deletes an execution context. + /api/1.2/commands/execute: + post: + operationId: commands-execute + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/execute + x-stackQL-resource: commands + x-stackQL-method: execute + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + clusterId: + type: string + contextId: + type: string + language: + type: string + command: + type: string + example: + clusterId: 1234-567890-span123 + contextId: '1234567890123456789' + language: python + command: print('Hello, World!') + description: Runs a cluster command in the given execution context, using the + provided language. + /api/1.2/contexts/status: + get: + operationId: command-status-contextstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/commandexecution/contextstatus + x-stackQL-resource: command_status + x-stackQL-method: contextstatus + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: clusterId + required: true + description: string + in: query + - name: contextId + required: true + description: string + in: query + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + status: + type: string + description: Gets the status for an execution context. + /api/2.0/global-init-scripts: + post: + operationId: global-init-scripts-create + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/create + x-stackQL-resource: global_init_scripts + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Response indicating that the script was created successfully. + content: + application/json: + schema: + type: object + properties: + script_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + script: + type: string + position: + type: required + enabled: + type: byte + example: + name: My example script name + script: ZWNobyBoZWxsbw== + position: 0 + enabled: false + description: Manages global init scripts for this workspace. + get: + operationId: global-init-scripts-list + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/list + x-stackQL-resource: global_init_scripts + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Response indicating that the scripts were retrieved successfully. + content: + application/json: + schema: + type: object + properties: + scripts: + type: array + items: + type: object + properties: + script_id: + type: string + name: + type: string + position: + type: integer + enabled: + type: boolean + created_by: + type: string + created_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.scripts + description: Manages global init scripts for this workspace. + /api/2.0/global-init-scripts/{script_id}: + delete: + operationId: global-init-scripts-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/delete + x-stackQL-resource: global_init_scripts + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: script_id + required: true + description: string + in: path + responses: + '200': + description: The script was deleted successfully. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Manage a specific global init script with ID + get: + operationId: global-init-scripts-get + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/get + x-stackQL-resource: global_init_scripts + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: script_id + required: true + description: string + in: path + responses: + '200': + description: Response indicating that the script was retrieved successfully. + content: + application/json: + schema: + type: object + properties: + script_id: + type: string + name: + type: string + position: + type: integer + enabled: + type: boolean + created_by: + type: string + created_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + script: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Manage a specific global init script with ID + patch: + operationId: global-init-scripts-update + externalDocs: + url: https://docs.databricks.com/api/workspace/globalinitscripts/update + x-stackQL-resource: global_init_scripts + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: script_id + required: true + description: string + in: path + responses: + '200': + description: The script was updated successfully. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + script: + type: string + position: + type: required + enabled: + type: byte + example: + name: My example script name + script: ZWNobyBoZWxsbw== + position: 0 + enabled: false + description: Manage a specific global init script with ID + /api/2.0/instance-pools/create: + post: + operationId: instance-pools-create + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/create + x-stackQL-resource: instance_pools + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_pool_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_pool_name: + type: required + min_idle_instances: + type: string + max_capacity: + type: int32 + node_type_id: + type: int32 + idle_instance_autotermination_minutes: + type: required + enable_elastic_disk: + type: string + preloaded_spark_versions: + type: int32 + aws_attributes: + type: object + custom_tags: + type: object + disk_spec: + type: object + preloaded_docker_images: + type: Array of object + example: + instance_pool_name: my-pool + node_type_id: i3.xlarge + min_idle_instances: 10 + aws_attributes: + availability: SPOT + custom_tags: + - key: my-key + value: my-value + description: Creates a new instance pool using idle and ready-to-use cloud instances. + /api/2.0/instance-pools/delete: + post: + operationId: instance-pools-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/delete + x-stackQL-resource: instance_pools + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_pool_id: + type: required + example: + instance_pool_id: 1234-567890-fetch12-pool-A3BcdEFg + description: Deletes the instance pool permanently. The idle instances in the + pool are terminated asynchronously. + /api/2.0/instance-pools/edit: + post: + operationId: instance-pools-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/edit + x-stackQL-resource: instance_pools + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_pool_name: + type: required + min_idle_instances: + type: string + max_capacity: + type: int32 + idle_instance_autotermination_minutes: + type: int32 + instance_pool_id: + type: int32 + node_type_id: + type: required + custom_tags: + type: object + example: + max_capacity: 200 + idle_instance_autotermination_minutes: 30 + min_idle_instances: 5 + instance_pool_id: 1234-567890-fetch12-pool-A3BcdEFg + instance_pool_name: my-edited-pool + description: Modifies the configuration of an existing instance pool. + /api/2.0/instance-pools/get: + get: + operationId: instance-pools-get + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/get + x-stackQL-resource: instance_pools + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_pool_name: + type: string + min_idle_instances: + type: integer + aws_attributes: + type: object + properties: + availability: + type: string + zone_id: + type: string + spot_bid_price_percent: + type: integer + node_type_id: + type: string + custom_tags: + type: object + properties: + my-key: + type: string + idle_instance_autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_type: + type: object + properties: + ebs_volume_type: + type: string + disk_count: + type: integer + disk_size: + type: integer + preloaded_spark_versions: + type: array + items: + type: string + instance_pool_id: + type: string + default_tags: + type: object + properties: + Vendor: + type: string + DatabricksInstancePoolCreatorId: + type: string + DatabricksInstancePoolId: + type: string + state: + type: string + stats: + type: object + properties: + used_count: + type: integer + idle_count: + type: integer + pending_used_count: + type: integer + pending_idle_count: + type: integer + status: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieve the information for an instance pool based on its identifier. + /api/2.0/instance-pools/list: + get: + operationId: instance-pools-list + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/list + x-stackQL-resource: instance_pools + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_pools: + type: array + items: + type: object + properties: + instance_pool_name: + type: string + min_idle_instances: + type: integer + aws_attributes: + type: object + properties: + availability: + type: string + zone_id: + type: string + spot_bid_price_percent: + type: integer + node_type_id: + type: string + idle_instance_autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + disk_spec: + type: object + properties: + disk_type: + type: object + properties: + ebs_volume_type: + type: string + disk_count: + type: integer + disk_size: + type: integer + preloaded_spark_versions: + type: array + items: + type: string + instance_pool_id: + type: string + default_tags: + type: object + properties: + Vendor: + type: string + DatabricksInstancePoolCreatorId: + type: string + DatabricksInstancePoolId: + type: string + state: + type: string + stats: + type: object + properties: + used_count: + type: integer + idle_count: + type: integer + pending_used_count: + type: integer + pending_idle_count: + type: integer + status: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.instance_pools + description: Gets a list of instance pools with their statistics. + /api/2.0/permissions/instance-pools/{instance_pool_id}: + get: + operationId: instance-pool-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/getpermissions + x-stackQL-resource: instance_pool_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an instance pool. Instance pools can inherit + permissions from their root object. + put: + operationId: instance-pool-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/setpermissions + x-stackQL-resource: instance_pool_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: instance-pool-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/updatepermissions + x-stackQL-resource: instance_pool_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an instance pool. Instance pools can + inherit permissions from their root object. + /api/2.0/permissions/instance-pools/{instance_pool_id}/permissionLevels: + get: + operationId: instance-pool-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/instancepools/getpermissionlevels + x-stackQL-resource: instance_pool_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: instance_pool_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/instance-profiles/add: + post: + operationId: instance-profiles-add + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/add + x-stackQL-resource: instance_profiles + x-stackQL-method: add + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + skip_validation: + type: boolean + instance_profile_arn: + type: required + iam_role_arn: + type: string + is_meta_instance_profile: + type: string + example: + instance_profile_arn: arn:aws:iam::123456789012:instance-profile/my-profile + description: In the UI, you can select the instance profile when launching clusters. + This API is only available to admin users. + /api/2.0/instance-profiles/edit: + post: + operationId: instance-profiles-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/edit + x-stackQL-resource: instance_profiles + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_profile_arn: + type: required + iam_role_arn: + type: string + is_meta_instance_profile: + type: string + example: + instance_profile_arn: arn:aws:iam::123456789012:instance-profile/my-profile + iam_role_arn: arn:aws:iam::123456789012:role/my-profile2 + description: 'The only supported field to change is the optional IAM role ARN + associated with the instance profile. It is required to specify the IAM role + ARN if both of the following are true:' + /api/2.0/instance-profiles/list: + get: + operationId: instance-profiles-list + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/list + x-stackQL-resource: instance_profiles + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + instance_profiles: + type: array + items: + type: object + properties: + instance_profile_arn: + type: string + is_meta_instance_profile: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.instance_profiles + description: List the instance profiles that the calling user can use to launch + a cluster. + /api/2.0/instance-profiles/remove: + post: + operationId: instance-profiles-remove + externalDocs: + url: https://docs.databricks.com/api/workspace/instanceprofiles/remove + x-stackQL-resource: instance_profiles + x-stackQL-method: remove + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + instance_profile_arn: + type: required + example: + instance_profile_arn: arn:aws:iam::123456789012:instance-profile/my-profile + description: Remove the instance profile with the provided ARN. Existing clusters + with this instance profile will continue to function. + /api/2.0/libraries/all-cluster-statuses: + get: + operationId: libraries-allclusterlibrarystatuses + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/allclusterlibrarystatuses + x-stackQL-resource: libraries + x-stackQL-method: allclusterlibrarystatuses + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + statuses: + type: array + items: + type: object + properties: + cluster_id: + type: string + library_statuses: + type: array + items: + type: object + properties: + is_library_for_all_clusters: + type: boolean + library: + type: object + properties: + pypi: + type: object + properties: + package: + type: string + repo: + type: string + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.statuses + description: Get the status of all libraries on all clusters. A status is returned + for all libraries installed on this cluster via the API or the libraries UI. + /api/2.0/libraries/cluster-status: + get: + operationId: libraries-clusterstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/clusterstatus + x-stackQL-resource: libraries + x-stackQL-method: clusterstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_id + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: string + library_statuses: + type: array + items: + type: object + properties: + is_library_for_all_clusters: + type: boolean + library: + type: object + properties: + pypi: + type: object + properties: + package: + type: string + repo: + type: string + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: 'Get the status of libraries on a cluster. A status is returned + for all libraries installed on this cluster via the API or the libraries UI. + The order of returned libraries is as follows:' + /api/2.0/libraries/install: + post: + operationId: libraries-install + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/install + x-stackQL-resource: libraries + x-stackQL-method: install + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + libraries: + type: required + example: + cluster_id: 1234-56789-abcde + libraries: + - pypi: + package: numpy + repo: http://my-pypi-repo.com + - jar: /Workspace/path/to/library.jar + - whl: /Workspace/path/to/library.whl + - maven: + coordinates: com.databricks:spark-csv_2.11:1.5.0 + exclusions: + - org.slf4j:slf4j-log4j12 + repo: http://my-maven-repo.com + - cran: + package: ggplot2 + repo: http://cran.us.r-project.org + - requirements: /Workspace/path/to/requirements.txt + description: Add libraries to install on a cluster. The installation is asynchronous; + it happens in the background after the completion of this request. + /api/2.0/libraries/uninstall: + post: + operationId: libraries-uninstall + externalDocs: + url: https://docs.databricks.com/api/workspace/libraries/uninstall + x-stackQL-resource: libraries + x-stackQL-method: uninstall + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cluster_id: + type: required + libraries: + type: required + example: + cluster_id: 1234-56789-abcde + libraries: + - pypi: + package: numpy + repo: http://my-pypi-repo.com + - jar: /Workspace/path/to/library.jar + - whl: /Workspace/path/to/library.whl + - maven: + coordinates: com.databricks:spark-csv_2.11:1.5.0 + exclusions: + - org.slf4j:slf4j-log4j12 + repo: http://my-maven-repo.com + - cran: + package: ggplot2 + repo: http://cran.us.r-project.org + - requirements: /Workspace/path/to/requirements.txt + description: Set libraries to uninstall from a cluster. The libraries won't + be uninstalled until the cluster is restarted. A request to uninstall a library + that is not currently installed is ignored. + /api/2.1/clusters/list-node-types: + get: + operationId: node-types-listnodetypes + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/listnodetypes + x-stackQL-resource: node_types + x-stackQL-method: listnodetypes + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + node_types: + type: array + items: + type: object + properties: + node_type_id: + type: string + memory_mb: + type: integer + num_cores: + type: integer + description: + type: string + instance_type_id: + type: string + is_deprecated: + type: boolean + category: + type: string + support_ebs_volumes: + type: boolean + support_cluster_tags: + type: boolean + num_gpus: + type: integer + node_instance_type: + type: object + properties: + instance_type_id: + type: string + local_disks: + type: integer + local_disk_size_gb: + type: integer + instance_family: + type: string + swap_size: + type: string + is_hidden: + type: boolean + support_port_forwarding: + type: boolean + supports_elastic_disk: + type: boolean + display_order: + type: integer + is_io_cache_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.node_types + description: Returns a list of supported Spark node types. These node types + can be used to launch a cluster. + /api/2.0/policy-families/{policy_family_id}: + get: + operationId: policy-families-get + externalDocs: + url: https://docs.databricks.com/api/workspace/policyfamilies/get + x-stackQL-resource: policy_families + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_family_id + required: true + description: string + in: path + - name: version + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_family_id: + type: string + name: + type: string + description: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieve the information for an policy family based on its identifier + and version + /api/2.0/policy-families: + get: + operationId: policy-families-list + externalDocs: + url: https://docs.databricks.com/api/workspace/policyfamilies/list + x-stackQL-resource: policy_families + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + policy_families: + type: array + items: + type: object + properties: + policy_family_id: + type: string + name: + type: string + description: + type: string + definition: + type: object + properties: + custom_tags.test_tag: + type: object + properties: + type: + type: string + value: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.policy_families + description: Returns the list of policy definition types available to use at + their latest version. This API is paginated. + /api/2.0/permissions/cluster-policies/{cluster_policy_id}/permissionLevels: + get: + operationId: policy-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissionlevels + x-stackQL-resource: policy_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: cluster_policy_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.1/clusters/spark-versions: + get: + operationId: spark-versions-sparkversions + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/sparkversions + x-stackQL-resource: spark_versions + x-stackQL-method: sparkversions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + versions: + type: array + items: + type: object + properties: + key: + type: string + name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.versions + description: Returns the list of available Spark versions. These versions can + be used to launch a cluster. + /api/2.1/clusters/list-zones: + get: + operationId: zones-listzones + externalDocs: + url: https://docs.databricks.com/api/workspace/clusters/listzones + x-stackQL-resource: zones + x-stackQL-method: listzones + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + zones: + type: array + items: + type: string + default_zone: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + description: Returns a list of availability zones where clusters can be created + in (For example, us-west-2a). These zones can be used to launch a cluster. +components: + x-stackQL-resources: + all_clusters_policy_compliance: + id: databricks_workspace.compute.all_clusters_policy_compliance + name: all_clusters_policy_compliance + title: All_clusters_policy_compliance + methods: + listcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1list-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.clusters + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/all_clusters_policy_compliance/methods/listcompliance' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + clusters: + id: databricks_workspace.compute.clusters + name: clusters + title: Clusters + methods: + changeowner: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1change-owner/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.clusters + permanentdelete: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1permanent-delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + pin: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1pin/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + resize: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1resize/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restart: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1restart/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1start/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + unpin: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1unpin/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' + - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/clusters/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/clusters/methods/unpin' + - $ref: '#/components/x-stackQL-resources/clusters/methods/start' + - $ref: '#/components/x-stackQL-resources/clusters/methods/restart' + - $ref: '#/components/x-stackQL-resources/clusters/methods/resize' + - $ref: '#/components/x-stackQL-resources/clusters/methods/pin' + - $ref: '#/components/x-stackQL-resources/clusters/methods/permanentdelete' + - $ref: '#/components/x-stackQL-resources/clusters/methods/changeowner' + cluster_events: + id: databricks_workspace.compute.cluster_events + name: cluster_events + title: Cluster_events + methods: + events: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1events/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_events/methods/events' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + cluster_permissions: + id: databricks_workspace.compute.cluster_permissions + name: cluster_permissions + title: Cluster_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cluster_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/cluster_permissions/methods/setpermissions' + delete: [] + exec: [] + cluster_permission_levels: + id: databricks_workspace.compute.cluster_permission_levels + name: cluster_permission_levels + title: Cluster_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1clusters~1{cluster_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + cluster_policies: + id: databricks_workspace.compute.cluster_policies + name: cluster_policies + title: Cluster_policies + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/list' + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/delete' + exec: [] + cluster_policies_permissions: + id: databricks_workspace.compute.cluster_policies_permissions + name: cluster_policies_permissions + title: Cluster_policies_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_policies_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cluster_policies_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/cluster_policies_permissions/methods/setpermissions' + delete: [] + exec: [] + cluster_policy_compliance: + id: databricks_workspace.compute.cluster_policy_compliance + name: cluster_policy_compliance + title: Cluster_policy_compliance + methods: + enforcecompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1enforce-compliance/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1clusters~1get-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_policy_compliance/methods/getcompliance' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/cluster_policy_compliance/methods/enforcecompliance' + delete: [] + exec: [] + commands: + id: databricks_workspace.compute.commands + name: commands + title: Commands + methods: + cancel: + operation: + $ref: '#/paths/~1api~11.2~1commands~1cancel/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + commandstatus: + operation: + $ref: '#/paths/~1api~11.2~1commands~1status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1api~11.2~1contexts~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + destroy: + operation: + $ref: '#/paths/~1api~11.2~1contexts~1destroy/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + execute: + operation: + $ref: '#/paths/~1api~11.2~1commands~1execute/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commands/methods/commandstatus' + insert: + - $ref: '#/components/x-stackQL-resources/commands/methods/create' + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/commands/methods/execute' + - $ref: '#/components/x-stackQL-resources/commands/methods/destroy' + - $ref: '#/components/x-stackQL-resources/commands/methods/cancel' + command_status: + id: databricks_workspace.compute.command_status + name: command_status + title: Command_status + methods: + contextstatus: + operation: + $ref: '#/paths/~1api~11.2~1contexts~1status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/command_status/methods/contextstatus' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + global_init_scripts: + id: databricks_workspace.compute.global_init_scripts + name: global_init_scripts + title: Global_init_scripts + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.scripts + delete: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts~1{script_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts~1{script_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1global-init-scripts~1{script_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/get' + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/global_init_scripts/methods/delete' + exec: [] + instance_pools: + id: databricks_workspace.compute.instance_pools + name: instance_pools + title: Instance_pools + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1instance-pools~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_pools + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/list' + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/delete' + exec: [] + instance_pool_permissions: + id: databricks_workspace.compute.instance_pool_permissions + name: instance_pool_permissions + title: Instance_pool_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pool_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/instance_pool_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/instance_pool_permissions/methods/setpermissions' + delete: [] + exec: [] + instance_pool_permission_levels: + id: databricks_workspace.compute.instance_pool_permission_levels + name: instance_pool_permission_levels + title: Instance_pool_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1instance-pools~1{instance_pool_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pool_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + instance_profiles: + id: databricks_workspace.compute.instance_profiles + name: instance_profiles + title: Instance_profiles + methods: + add: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1add/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_profiles + remove: + operation: + $ref: '#/paths/~1api~12.0~1instance-profiles~1remove/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/add' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/remove' + exec: [] + libraries: + id: databricks_workspace.compute.libraries + name: libraries + title: Libraries + methods: + allclusterlibrarystatuses: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1all-cluster-statuses/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.statuses + clusterstatus: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1cluster-status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + install: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1install/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + uninstall: + operation: + $ref: '#/paths/~1api~12.0~1libraries~1uninstall/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/libraries/methods/clusterstatus' + - $ref: '#/components/x-stackQL-resources/libraries/methods/allclusterlibrarystatuses' + insert: + - $ref: '#/components/x-stackQL-resources/libraries/methods/install' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/libraries/methods/uninstall' + exec: [] + node_types: + id: databricks_workspace.compute.node_types + name: node_types + title: Node_types + methods: + listnodetypes: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1list-node-types/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.node_types + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/node_types/methods/listnodetypes' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + policy_families: + id: databricks_workspace.compute.policy_families + name: policy_families + title: Policy_families + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1policy-families~1{policy_family_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1policy-families/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.policy_families + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policy_families/methods/list' + - $ref: '#/components/x-stackQL-resources/policy_families/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + policy_permission_levels: + id: databricks_workspace.compute.policy_permission_levels + name: policy_permission_levels + title: Policy_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1cluster-policies~1{cluster_policy_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policy_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + spark_versions: + id: databricks_workspace.compute.spark_versions + name: spark_versions + title: Spark_versions + methods: + sparkversions: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1spark-versions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.versions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/spark_versions/methods/sparkversions' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + zones: + id: databricks_workspace.compute.zones + name: zones + title: Zones + methods: + listzones: + operation: + $ref: '#/paths/~1api~12.1~1clusters~1list-zones/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones/methods/listzones' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml b/providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml new file mode 100644 index 00000000..343fbd17 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/dbsql.yaml @@ -0,0 +1,5452 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Dbsql API + description: Dbsql +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/sql/alerts: + post: + operationId: alerts-create + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/create + x-stackQL-resource: alerts + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + double_value: + type: integer + query_id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + alert: + type: object + example: + alert: + seconds_to_retrigger: 0 + display_name: Test alert + condition: + op: GREATER_THAN + operand: + column: + name: foo + threshold: + value: + double_value: 1 + query_id: dee5cca8-1c79-4b5e-a71m1-e7f9d241bdf6 + parent_path: /Workspace/Users/user.name@acme.com + description: Creates an alert. + get: + operationId: alerts-list + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/list + x-stackQL-resource: alerts + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + results: + type: array + items: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + double_value: + type: integer + query_id: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Gets a list of alerts accessible to the user, ordered by creation + time. + /api/2.0/sql/alerts/{id}: + delete: + operationId: alerts-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/delete + x-stackQL-resource: alerts + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Moves an alert to the trash. Trashed alerts immediately disappear + from searches and list views, and can no longer trigger. You can restore a + trashed alert through the UI. A trashed alert is permanently deleted after + 30 days. + get: + operationId: alerts-get + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/get + x-stackQL-resource: alerts + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + string_value: + type: string + query_id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets an alert. + patch: + operationId: alerts-update + externalDocs: + url: https://docs.databricks.com/api/workspace/alerts/update + x-stackQL-resource: alerts + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + state: + type: string + seconds_to_retrigger: + type: integer + owner_user_name: + type: string + display_name: + type: string + id: + type: string + condition: + type: object + properties: + op: + type: string + operand: + type: object + properties: + column: + type: object + properties: + name: + type: string + threshold: + type: object + properties: + value: + type: object + properties: + bool_value: + type: boolean + query_id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + update_time: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + update_mask: + type: required + alert: + type: object + example: + alert: + condition: + op: EQUAL + operand: + column: + name: bar + threshold: + value: + bool_value: true + display_name: Renamed alert + id: fe25e731-92f2-4838-9fb2-1ca364320a3d + update_mask: display_name,condition + description: Updates an alert. + /api/2.0/preview/sql/alerts: + post: + operationId: alerts-legacy-create + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/create + x-stackQL-resource: alerts_legacy + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: An alert was successfully created + content: + application/json: + schema: + type: object + properties: + created_at: + type: string + id: + type: string + parent: + type: string + last_triggered_at: + type: string + name: + type: string + options: + type: object + properties: + column: + type: string + custom_body: + type: string + custom_subject: + type: string + muted: + type: boolean + op: + type: string + value: + type: 'null' + empty_result_state: + type: string + query: + type: object + properties: + created_at: + type: string + data_source_id: + type: string + description: + type: string + id: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + is_safe: + type: boolean + name: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + query: + type: string + updated_at: + type: string + tags: + type: array + items: + type: string + user_id: + type: integer + rearm: + type: integer + state: + type: string + updated_at: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + query_id: + type: string + rearm: + type: required + parent: + type: UUID + options: + type: object + example: + name: Total Trips > 300 + options: + column: total_trips + custom_body: Total trips exceeded + custom_subject: The total trips has exceeded 300. + muted: false + op: '>' + value: null + empty_result_state: unknown + query_id: dee5cca8-1c79-4b5e-a711-e7f9d241bdf6 + rearm: 0 + parent: folders/2025532471912059 + description: Creates an alert. An alert is a Databricks SQL object that periodically + runs a query, evaluates a condition of its result, and notifies users or notification + destinations if the condition was met. + get: + operationId: alerts-legacy-list + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/list + x-stackQL-resource: alerts_legacy + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: List of alerts was successfully fetched. + content: + application/json: + schema: + type: array + items: + type: object + properties: + created_at: + type: string + id: + type: string + parent: + type: string + last_triggered_at: + type: string + name: + type: string + options: + type: object + properties: + column: + type: string + custom_body: + type: string + custom_subject: + type: string + muted: + type: boolean + op: + type: string + value: + type: 'null' + empty_result_state: + type: string + query: + type: object + properties: + created_at: + type: string + data_source_id: + type: string + description: + type: string + id: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + is_safe: + type: boolean + name: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + query: + type: string + updated_at: + type: string + tags: + type: array + items: + type: string + user_id: + type: integer + rearm: + type: integer + state: + type: string + updated_at: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Gets a list of alerts. + /api/2.0/preview/sql/alerts/{alert_id}: + delete: + operationId: alerts-legacy-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/delete + x-stackQL-resource: alerts_legacy + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: alert_id + required: true + description: string + in: path + responses: + '200': + description: Alert was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an alert. Deleted alerts are no longer accessible and cannot + be restored. + get: + operationId: alerts-legacy-get + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/get + x-stackQL-resource: alerts_legacy + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: alert_id + required: true + description: string + in: path + responses: + '200': + description: Alert was successfully fetched. + content: + application/json: + schema: + type: object + properties: + created_at: + type: string + id: + type: string + parent: + type: string + last_triggered_at: + type: string + name: + type: string + options: + type: object + properties: + column: + type: string + custom_body: + type: string + custom_subject: + type: string + muted: + type: boolean + op: + type: string + value: + type: 'null' + empty_result_state: + type: string + query: + type: object + properties: + created_at: + type: string + data_source_id: + type: string + description: + type: string + id: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + is_safe: + type: boolean + name: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + query: + type: string + updated_at: + type: string + tags: + type: array + items: + type: string + user_id: + type: integer + rearm: + type: integer + state: + type: string + updated_at: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets an alert. + put: + operationId: alerts-legacy-update + externalDocs: + url: https://docs.databricks.com/api/workspace/alertslegacy/update + x-stackQL-resource: alerts_legacy + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: alert_id + required: true + description: string + in: path + responses: + '200': + description: Alert was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + query_id: + type: string + rearm: + type: required + options: + type: object + example: + name: Total Trips > 300 + options: + column: total_trips + custom_body: Total trips exceeded + custom_subject: The total trips has exceeded 300. + muted: false + op: '>' + value: null + empty_result_state: unknown + query_id: dee5cca8-1c79-4b5e-a711-e7f9d241bdf6 + rearm: 0 + description: Updates an alert. + /api/2.0/preview/sql/dashboards: + post: + operationId: dashboards-create + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/create + x-stackQL-resource: dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: A dashboard object was successfully created. + content: + application/json: + schema: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + parent: + type: string + tags: + type: string + is_favorite: + type: Array of string + run_as_role: + type: boolean + dashboard_filters_enabled: + type: string + example: + name: Sales Dashboard + parent: folders/2025532471912059 + tags: + - Payroll + is_favorite: true + run_as_role: viewer + dashboard_filters_enabled: true + description: Creates a new dashboard object. Only the + get: + operationId: dashboards-list + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/list + x-stackQL-resource: dashboards + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page + in: query + - name: order + in: query + - name: q + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + count: + type: integer + page: + type: integer + page_size: + type: integer + results: + type: array + items: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Fetch a paginated list of dashboard objects. + /api/2.0/preview/sql/dashboards/{dashboard_id}: + delete: + operationId: dashboards-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/delete + x-stackQL-resource: dashboards + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard successfully moved to trash. + content: + application/json: + schema: + type: object + properties: {} + description: Moves a dashboard to the trash. Trashed dashboards do not appear + in list views or searches, and cannot be shared. + get: + operationId: dashboards-get + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/get + x-stackQL-resource: dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard fetched successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + description: Returns a JSON representation of a dashboard object, including + its visualization and query objects. + post: + operationId: dashboards-update + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/update + x-stackQL-resource: dashboards + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard updated successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + slug: + type: string + parent: + type: string + name: + type: string + user_id: + type: integer + dashboard_filters_enabled: + type: boolean + widgets: + type: array + items: + type: object + properties: + id: + type: string + width: + type: integer + options: + type: object + properties: + parameterMappings: + type: object + properties: + param: + type: object + properties: + name: + type: string + mapTo: + type: string + title: + type: string + type: + type: string + value: + type: 'null' + isHidden: + type: boolean + position: + type: object + properties: + autoHeight: + type: boolean + sizeX: + type: integer + sizeY: + type: integer + col: + type: integer + row: + type: integer + title: + type: string + description: + type: string + updated_at: + type: string + created_at: + type: string + visualization: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + tags: + type: array + items: + type: string + updated_at: + type: string + created_at: + type: string + is_favorite: + type: boolean + can_edit: + type: boolean + permission_tier: + type: string + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + run_as_role: + type: string + tags: + type: Array of string + example: + name: Sales Dashboard + run_as_role: viewer + tags: + - Payroll + description: The dashboard definition that replaces the current definition + for this + description: Modify this dashboard definition. This operation only affects attributes + of the dashboard object. It does not add, modify, or remove widgets. + /api/2.0/preview/sql/dashboards/trash/{dashboard_id}: + post: + operationId: dashboards-restore + externalDocs: + url: https://docs.databricks.com/api/workspace/dashboards/restore + x-stackQL-resource: dashboards + x-stackQL-method: restore + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Dashboard restored successfully. + content: + application/json: + schema: + type: object + properties: {} + description: A restored dashboard appears in list views and searches and can + be shared. + /api/2.0/preview/sql/permissions/{objectType}/{objectId}: + get: + operationId: permissions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/dbsqlpermissions/get + x-stackQL-resource: permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: objectType + required: true + description: string + in: path + - name: objectId + required: true + description: uuid + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + permission_level: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a JSON representation of the access control list (ACL) for + a specified object. + post: + operationId: permissions-set + externalDocs: + url: https://docs.databricks.com/api/workspace/dbsqlpermissions/set + x-stackQL-resource: permissions + x-stackQL-method: set + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: objectType + required: true + description: string + in: path + - name: objectId + required: true + description: uuid + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + permission_level: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: user@example.com + group_name: admins + permission_level: CAN_VIEW + description: An ACL list to be applied to the object specified in the URL. + description: Sets the access control list (ACL) for a specified object. This + operation will complete rewrite the ACL. + /api/2.0/preview/sql/permissions/{objectType}/{objectId}/transfer: + post: + operationId: permissions-transferownership + externalDocs: + url: https://docs.databricks.com/api/workspace/dbsqlpermissions/transferownership + x-stackQL-resource: permissions + x-stackQL-method: transferownership + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: objectType + required: true + description: string + in: path + - name: null + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + message: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_owner: + type: email + example: + new_owner: user@example.com + description: Email address for the new owner, who must exist in the workspace. + description: Transfer ownership of a single object. + /api/2.0/sql/queries: + post: + operationId: queries-create + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/create + x-stackQL-resource: queries + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + query: + type: object + example: + query: + description: Example description + tags: + - Tag 1 + display_name: Example query + parent_path: /Workspace/Users/user@acme.com + query_text: SELECT 1 + parameters: + - name: foo + text_value: + value: bar + title: foo + warehouse_id: a7066a8ef796be84 + run_as_mode: OWNER + description: Creates a query. + get: + operationId: queries-list + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/list + x-stackQL-resource: queries + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + results: + type: array + items: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + update_time: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Gets a list of queries accessible to the user, ordered by creation + time. + /api/2.0/sql/queries/{id}: + delete: + operationId: queries-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/delete + x-stackQL-resource: queries + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Moves a query to the trash. Trashed queries immediately disappear + from searches and list views, and cannot be used for alerts. You can restore + a trashed query through the UI. A trashed query is permanently deleted after + 30 days. + get: + operationId: queries-get + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/get + x-stackQL-resource: queries + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + update_time: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a query. + patch: + operationId: queries-update + externalDocs: + url: https://docs.databricks.com/api/workspace/queries/update + x-stackQL-resource: queries + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + description: + type: string + owner_user_name: + type: string + tags: + type: array + items: + type: string + display_name: + type: string + id: + type: string + parent_path: + type: string + lifecycle_state: + type: string + last_modifier_user_name: + type: string + query_text: + type: string + parameters: + type: array + items: + type: object + properties: + name: + type: string + text_value: + type: object + properties: + value: + type: string + title: + type: string + update_time: + type: string + warehouse_id: + type: string + run_as_mode: + type: string + create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + update_mask: + type: required + query: + type: object + example: + id: fe25e731-92f2-4838-9fb2-1ca364320a3d + query: + description: Example description updated + display_name: Example query updated + query_text: SELECT 2 + update_mask: display_name,description,query_text + description: Updates a query. + /api/2.0/preview/sql/queries: + post: + operationId: queries-legacy-create + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/create + x-stackQL-resource: queries_legacy + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Query created successfully + content: + application/json: + schema: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + data_source_id: + type: UUID + query: + type: string + name: + type: string + parent: + type: string + description: + type: string + options: + type: object + run_as_role: + type: string + tags: + type: Array of string + example: + data_source_id: 0c205e24-5db2-4940-adb1-fb13c7ce960b + query: SELECT field FROM table WHERE field = {{ param }} + name: Orders by month by customer + parent: folders/2025532471912059 + description: Summarizes total order dollars for customers in the Europe/Asia + region. + options: + parameters: + - title: customer + name: param + type: text + value: acme + run_as_role: viewer + tags: + - Payroll + description: A query object to be created. + description: Creates a new query definition. Queries created with this endpoint + belong to the authenticated user making the request. + get: + operationId: queries-legacy-list + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/list + x-stackQL-resource: queries_legacy + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page + in: query + - name: order + in: query + - name: q + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + count: + type: integer + page: + type: integer + page_size: + type: integer + results: + type: array + items: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + x-stackQL-objectKey: $.results + description: Gets a list of queries. Optionally, this list can be filtered by + a search term. + /api/2.0/preview/sql/queries/{query_id}: + delete: + operationId: queries-legacy-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/delete + x-stackQL-resource: queries_legacy + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query moved to trash. + content: + application/json: + schema: + type: object + properties: {} + description: Moves a query to the trash. Trashed queries immediately disappear + from searches and list views, and they cannot be used for alerts. The trash + is deleted after 30 days. + get: + operationId: queries-legacy-get + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/get + x-stackQL-resource: queries_legacy + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query fetched successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + description: Retrieve a query object definition along with contextual permissions + information about the currently authenticated user. + post: + operationId: queries-legacy-update + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/update + x-stackQL-resource: queries_legacy + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query updated successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: + type: object + properties: + id: + type: string + type: + type: string + name: + type: string + description: + type: string + options: + type: 'null' + updated_at: + type: string + created_at: + type: string + query: + type: object + properties: + id: + type: string + parent: + type: string + latest_query_data_id: + type: string + name: + type: string + description: + type: string + query: + type: string + query_hash: + type: string + is_archived: + type: boolean + is_draft: + type: boolean + updated_at: + type: string + created_at: + type: string + data_source_id: + type: string + options: + type: object + properties: + moved_to_trash_at: + type: string + catalog: + type: string + schema: + type: string + parameters: + type: array + items: + type: object + properties: + title: + type: string + name: + type: string + type: + type: string + enumOptions: + type: string + queryId: + type: string + multiValuesOptions: + type: object + properties: + prefix: + type: string + separator: + type: string + suffix: + type: string + value: + type: 'null' + tags: + type: array + items: + type: string + is_safe: + type: boolean + user_id: + type: integer + last_modified_by_id: + type: integer + visualizations: + type: array + items: {} + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + is_favorite: + type: boolean + user: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + last_modified_by: + type: object + properties: + id: + type: integer + name: + type: string + email: + type: string + can_edit: + type: boolean + permission_tier: + type: string + run_as_role: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + data_source_id: + type: UUID + query: + type: string + name: + type: string + description: + type: string + options: + type: object + run_as_role: + type: string + tags: + type: Array of string + example: + data_source_id: 0c205e24-5db2-4940-adb1-fb13c7ce960b + query: SELECT field FROM table WHERE field = {{ param }} + name: Orders by month by customer + description: Summarizes total order dollars for customers in the Europe/Asia + region. + options: + parameters: + - title: customer + name: param + type: text + value: acme + run_as_role: viewer + tags: + - Payroll + description: The query definition that will replace the current definition + for this + description: Modify this query definition. + /api/2.0/preview/sql/queries/trash/{query_id}: + post: + operationId: queries-legacy-restore + externalDocs: + url: https://docs.databricks.com/api/workspace/querieslegacy/restore + x-stackQL-resource: queries_legacy + x-stackQL-method: restore + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: query_id + required: true + description: UUID + in: path + responses: + '200': + description: Query restored successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Restore a query that has been moved to the trash. A restored query + appears in list views and searches. You can use restored queries for alerts. + /api/2.0/sql/history/queries: + get: + operationId: query-history-list + externalDocs: + url: https://docs.databricks.com/api/workspace/queryhistory/list + x-stackQL-resource: query_history + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: null + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_metrics + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + has_next_page: + type: boolean + res: + type: array + items: + type: object + properties: + query_id: + type: string + status: + type: string + query_text: + type: string + query_start_time_ms: + type: integer + execution_end_time_ms: + type: integer + query_end_time_ms: + type: integer + user_id: + type: integer + user_name: + type: string + spark_ui_url: + type: string + endpoint_id: + type: string + rows_produced: + type: integer + error_message: + type: string + lookup_key: + type: string + metrics: + type: object + properties: + total_time_ms: + type: integer + read_bytes: + type: integer + rows_produced_count: + type: integer + compilation_time_ms: + type: integer + execution_time_ms: + type: integer + read_remote_bytes: + type: integer + write_remote_bytes: + type: integer + read_cache_bytes: + type: integer + spill_to_disk_bytes: + type: integer + task_total_time_ms: + type: integer + read_files_count: + type: integer + read_partitions_count: + type: integer + photon_total_time_ms: + type: integer + rows_read_count: + type: integer + result_fetch_time_ms: + type: integer + network_sent_bytes: + type: integer + result_from_cache: + type: boolean + pruned_bytes: + type: integer + pruned_files_count: + type: integer + provisioning_queue_start_timestamp: + type: integer + overloading_queue_start_timestamp: + type: integer + query_compilation_start_timestamp: + type: integer + executed_as_user_id: + type: integer + executed_as_user_name: + type: string + is_final: + type: boolean + channel_used: + type: object + properties: + name: + type: string + dbsql_version: + type: string + plans_state: + type: string + statement_type: + type: string + warehouse_id: + type: string + duration: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '499': + description: Operation was canceled by the caller. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + x-stackQL-objectKey: $.res + description: List the history of queries through SQL warehouses, and serverless + compute. + /api/2.0/sql/statements/{statement_id}/cancel: + post: + operationId: statement-execution-cancelexecution + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/cancelexecution + x-stackQL-resource: statement_execution + x-stackQL-method: cancelexecution + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: statement_id + required: true + description: string + in: path + - name: statement_id + required: true + description: string + in: path + responses: + '200': + description: Cancel response is empty; receiving response indicates successful + receipt. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + description: Requests that an executing statement be canceled. Callers must + poll for status to see the terminal state. + /api/2.0/sql/statements/: + post: + operationId: statement-execution-executestatement + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/executestatement + x-stackQL-resource: statement_execution + x-stackQL-method: executestatement + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: StatementResponse contains `statement_id` and `status`; other + fields might be absent or present depending on context. If the SQL warehouse + fails to execute the provided statement, a 200 response is returned with + `status.state` set to `FAILED` (in constract to a failure when accepting + the request, which results in a non-200 response). Details of the error + can be found at `status.error` in case of execution failures. + content: + application/json: + schema: + type: object + properties: + statement_id: + type: string + status: + type: object + properties: + state: + type: string + manifest: + type: object + properties: + format: + type: string + schema: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + position: + type: integer + type_name: + type: string + type_text: + type: string + result: + type: object + properties: + chunk_index: + type: integer + row_offset: + type: integer + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + statement: + type: required + warehouse_id: + type: string + catalog: + type: required + schema: + type: string + row_limit: + type: string + byte_limit: + type: string + disposition: + type: integer + format: int64 + format: + type: integer + format: int64 + wait_timeout: + type: string + on_wait_timeout: + type: string + parameters: + type: Array of object + example: + warehouse_id: abcdef0123456789 + statement: SELECT * FROM range(100) + wait_timeout: 0s + description: Execute a SQL statement and optionally await its results for a + specified time. + /api/2.0/sql/statements/{statement_id}: + get: + operationId: statement-execution-getstatement + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/getstatement + x-stackQL-resource: statement_execution + x-stackQL-method: getstatement + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: statement_id + required: true + description: string + in: path + - name: statement_id + required: true + description: string + in: path + responses: + '200': + description: StatementResponse contains `statement_id` and `status`; other + fields might be absent or present depending on context. In case of an + error during execution of the SQL statement -- as opposed to an error + while processing the request -- a 200 response is returned with error + details in the `status` field. + content: + application/json: + schema: + type: object + properties: + statement_id: + type: string + status: + type: object + properties: + state: + type: string + manifest: + type: object + properties: + format: + type: string + schema: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + position: + type: integer + type_name: + type: string + type_text: + type: string + result: + type: object + properties: + chunk_index: + type: integer + row_offset: + type: integer + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + description: This request can be used to poll for the statement's status. When + the + /api/2.0/sql/statements/{statement_id}/result/chunks/{chunk_index}: + get: + operationId: statement-execution-results-getstatementresultchunkn + externalDocs: + url: https://docs.databricks.com/api/workspace/statementexecution/getstatementresultchunkn + x-stackQL-resource: statement_execution_results + x-stackQL-method: getstatementresultchunkn + x-stackQL-verb: select + x-numReqParams: 4 + parameters: + - name: statement_id + required: true + description: string + in: path + - name: chunk_index + required: true + description: int32 + in: path + - name: statement_id + required: true + description: string + in: path + - name: chunk_index + required: true + description: string + in: path + responses: + '200': + description: Successful return; depending on `disposition` returns chunks + of data either inline, or as links. + content: + application/json: + schema: + type: object + properties: + chunk_index: + type: integer + row_offset: + type: integer + row_count: + type: integer + next_chunk_index: + type: integer + next_chunk_internal_link: + type: string + data_array: + type: array + items: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + '503': + description: Service is currently unavailable. + description: After the statement execution has + /api/2.0/sql/warehouses: + post: + operationId: warehouses-create + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/create + x-stackQL-resource: warehouses + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: int32 + max_num_clusters: + type: int32 + auto_stop_mins: + type: int32 + creator_name: + type: string + instance_profile_arn: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + tags: + type: object + channel: + type: object + example: + name: string + cluster_size: string + min_num_clusters: '1' + max_num_clusters: 0 + auto_stop_mins: '120' + creator_name: string + instance_profile_arn: string + tags: + custom_tags: + - key: string + value: string + spot_instance_policy: POLICY_UNSPECIFIED + enable_photon: true + channel: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + enable_serverless_compute: true + warehouse_type: TYPE_UNSPECIFIED + description: Creates a new SQL warehouse. + get: + operationId: warehouses-list + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/list + x-stackQL-resource: warehouses + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: run_as_user_id + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + warehouses: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: string + max_num_clusters: + type: integer + auto_stop_mins: + type: string + creator_name: + type: string + instance_profile_arn: + type: string + tags: + type: object + properties: + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + channel: + type: object + properties: + name: + type: string + dbsql_version: + type: string + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + num_clusters: + type: integer + num_active_sessions: + type: integer + state: + type: string + jdbc_url: + type: string + odbc_params: + type: object + properties: + hostname: + type: string + path: + type: string + protocol: + type: string + port: + type: integer + health: + type: object + properties: + status: + type: string + message: + type: string + failure_reason: + type: object + properties: + code: + type: string + type: + type: string + parameters: + type: object + properties: + property1: + type: string + property2: + type: string + summary: + type: string + details: + type: string + x-stackQL-objectKey: $.warehouses + description: Lists all SQL warehouses that a user has manager permissions on. + /api/2.0/sql/warehouses/{id}: + delete: + operationId: warehouses-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/delete + x-stackQL-resource: warehouses + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a SQL warehouse. + get: + operationId: warehouses-get + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/get + x-stackQL-resource: warehouses + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: string + max_num_clusters: + type: integer + auto_stop_mins: + type: string + creator_name: + type: string + instance_profile_arn: + type: string + tags: + type: object + properties: + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + channel: + type: object + properties: + name: + type: string + dbsql_version: + type: string + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + num_clusters: + type: integer + num_active_sessions: + type: integer + state: + type: string + jdbc_url: + type: string + odbc_params: + type: object + properties: + hostname: + type: string + path: + type: string + protocol: + type: string + port: + type: integer + health: + type: object + properties: + status: + type: string + message: + type: string + failure_reason: + type: object + properties: + code: + type: string + type: + type: string + parameters: + type: object + properties: + property1: + type: string + property2: + type: string + summary: + type: string + details: + type: string + description: Gets the information for a single SQL warehouse. + /api/2.0/sql/warehouses/{id}/edit: + post: + operationId: warehouses-edit + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/edit + x-stackQL-resource: warehouses + x-stackQL-method: edit + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + cluster_size: + type: string + min_num_clusters: + type: int32 + max_num_clusters: + type: int32 + auto_stop_mins: + type: int32 + creator_name: + type: string + instance_profile_arn: + type: string + spot_instance_policy: + type: string + enable_photon: + type: boolean + enable_serverless_compute: + type: boolean + warehouse_type: + type: string + tags: + type: object + channel: + type: object + example: + name: string + cluster_size: string + min_num_clusters: '1' + max_num_clusters: 0 + auto_stop_mins: '120' + creator_name: string + instance_profile_arn: string + tags: + custom_tags: + - key: string + value: string + spot_instance_policy: POLICY_UNSPECIFIED + enable_photon: true + channel: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + enable_serverless_compute: true + warehouse_type: TYPE_UNSPECIFIED + description: Updates the configuration for a SQL warehouse. + /api/2.0/sql/warehouses/{id}/start: + post: + operationId: warehouses-start + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/start + x-stackQL-resource: warehouses + x-stackQL-method: start + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Starts a SQL warehouse. + /api/2.0/sql/warehouses/{id}/stop: + post: + operationId: warehouses-stop + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/stop + x-stackQL-resource: warehouses + x-stackQL-method: stop + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Stops a SQL warehouse. + /api/2.0/sql/config/warehouses: + get: + operationId: warehouse-config-getworkspacewarehouseconfig + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/getworkspacewarehouseconfig + x-stackQL-resource: warehouse_config + x-stackQL-method: getworkspacewarehouseconfig + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + security_policy: + type: string + data_access_config: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + instance_profile_arn: + type: string + channel: + type: object + properties: + name: + type: string + dbsql_version: + type: string + global_param: + type: object + properties: + config_pair: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + configuration_pairs: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + config_param: + type: object + properties: + config_pair: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + configuration_pairs: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + sql_configuration_parameters: + type: object + properties: + config_pair: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + configuration_pairs: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + google_service_account: + type: string + enabled_warehouse_types: + type: array + items: + type: object + properties: + warehouse_type: + type: string + enabled: + type: boolean + description: Gets the workspace level configuration that is shared by all SQL + warehouses in a workspace. + put: + operationId: warehouse-config-setworkspacewarehouseconfig + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/setworkspacewarehouseconfig + x-stackQL-resource: warehouse_config + x-stackQL-method: setworkspacewarehouseconfig + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + security_policy: + type: string + instance_profile_arn: + type: string + google_service_account: + type: string + data_access_config: + type: Array of object + channel: + type: object + global_param: + type: object + config_param: + type: object + sql_configuration_parameters: + type: object + enabled_warehouse_types: + type: Array of object + example: + security_policy: NONE + data_access_config: + - key: string + value: string + instance_profile_arn: string + channel: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + global_param: + config_pair: + - key: string + value: string + configuration_pairs: + - key: string + value: string + config_param: + config_pair: + - key: string + value: string + configuration_pairs: + - key: string + value: string + sql_configuration_parameters: + config_pair: + - key: string + value: string + configuration_pairs: + - key: string + value: string + google_service_account: string + enabled_warehouse_types: + - warehouse_type: TYPE_UNSPECIFIED + enabled: true + description: Sets the workspace level configuration that is shared by all SQL + warehouses in a workspace. + /api/2.0/permissions/warehouses/{warehouse_id}: + get: + operationId: warehouse-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/getpermissions + x-stackQL-resource: warehouse_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a SQL warehouse. SQL warehouses can inherit + permissions from their root object. + put: + operationId: warehouse-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/setpermissions + x-stackQL-resource: warehouse_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: warehouse-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/updatepermissions + x-stackQL-resource: warehouse_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a SQL warehouse. SQL warehouses can + inherit permissions from their root object. + /api/2.0/permissions/warehouses/{warehouse_id}/permissionLevels: + get: + operationId: warehouse-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/warehouses/getpermissionlevels + x-stackQL-resource: warehouse_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: warehouse_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + alerts: + id: databricks_workspace.dbsql.alerts + name: alerts + title: Alerts + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1sql~1alerts~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get' + - $ref: '#/components/x-stackQL-resources/alerts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alerts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/alerts/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/alerts/methods/delete' + exec: [] + alerts_legacy: + id: databricks_workspace.dbsql.alerts_legacy + name: alerts_legacy + title: Alerts_legacy + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts~1{alert_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts~1{alert_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1alerts~1{alert_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/get' + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/alerts_legacy/methods/delete' + exec: [] + dashboards: + id: databricks_workspace.dbsql.dashboards + name: dashboards + title: Dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1{dashboard_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1{dashboard_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1{dashboard_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1dashboards~1trash~1{dashboard_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/get' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/restore' + permissions: + id: databricks_workspace.dbsql.permissions + name: permissions + title: Permissions + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1permissions~1{objectType}~1{objectId}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + set: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1permissions~1{objectType}~1{objectId}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + transferownership: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1permissions~1{objectType}~1{objectId}~1transfer/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/set' + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/permissions/methods/transferownership' + queries: + id: databricks_workspace.dbsql.queries + name: queries + title: Queries + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1sql~1queries~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries/methods/get' + - $ref: '#/components/x-stackQL-resources/queries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queries/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/queries/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/queries/methods/delete' + exec: [] + queries_legacy: + id: databricks_workspace.dbsql.queries_legacy + name: queries_legacy + title: Queries_legacy + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1{query_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1{query_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1{query_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: '#/paths/~1api~12.0~1preview~1sql~1queries~1trash~1{query_id}/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/get' + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/queries_legacy/methods/restore' + query_history: + id: databricks_workspace.dbsql.query_history + name: query_history + title: Query_history + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1history~1queries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.res + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/query_history/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + statement_execution: + id: databricks_workspace.dbsql.statement_execution + name: statement_execution + title: Statement_execution + methods: + cancelexecution: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1{statement_id}~1cancel/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + executestatement: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getstatement: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1{statement_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/statement_execution/methods/getstatement' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/statement_execution/methods/executestatement' + - $ref: '#/components/x-stackQL-resources/statement_execution/methods/cancelexecution' + statement_execution_results: + id: databricks_workspace.dbsql.statement_execution_results + name: statement_execution_results + title: Statement_execution_results + methods: + getstatementresultchunkn: + operation: + $ref: '#/paths/~1api~12.0~1sql~1statements~1{statement_id}~1result~1chunks~1{chunk_index}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/statement_execution_results/methods/getstatementresultchunkn' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + warehouses: + id: databricks_workspace.dbsql.warehouses + name: warehouses + title: Warehouses + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.warehouses + delete: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + edit: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}~1edit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}~1start/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1sql~1warehouses~1{id}~1stop/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/get' + - $ref: '#/components/x-stackQL-resources/warehouses/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/create' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/edit' + delete: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/warehouses/methods/stop' + - $ref: '#/components/x-stackQL-resources/warehouses/methods/start' + warehouse_config: + id: databricks_workspace.dbsql.warehouse_config + name: warehouse_config + title: Warehouse_config + methods: + getworkspacewarehouseconfig: + operation: + $ref: '#/paths/~1api~12.0~1sql~1config~1warehouses/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setworkspacewarehouseconfig: + operation: + $ref: '#/paths/~1api~12.0~1sql~1config~1warehouses/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouse_config/methods/getworkspacewarehouseconfig' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/warehouse_config/methods/setworkspacewarehouseconfig' + delete: [] + exec: [] + warehouse_permissions: + id: databricks_workspace.dbsql.warehouse_permissions + name: warehouse_permissions + title: Warehouse_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouse_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/warehouse_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/warehouse_permissions/methods/setpermissions' + delete: [] + exec: [] + warehouse_permission_levels: + id: databricks_workspace.dbsql.warehouse_permission_levels + name: warehouse_permission_levels + title: Warehouse_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1warehouses~1{warehouse_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/warehouse_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml b/providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml new file mode 100644 index 00000000..b9e362d1 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/deltalivetables.yaml @@ -0,0 +1,1619 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Deltalivetables API + description: Deltalivetables +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/pipelines: + post: + operationId: pipelines-create + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/create + x-stackQL-resource: pipelines + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + pipeline_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + name: + type: string + storage: + type: string + target: + type: string + schema: + type: string + continuous: + type: boolean + development: + type: boolean + photon: + type: boolean + edition: + type: string + channel: + type: string + catalog: + type: string + serverless: + type: boolean + allow_duplicate_names: + type: boolean + dry_run: + type: boolean + configuration: + type: object + clusters: + type: Array of object + libraries: + type: Array of object + trigger: + type: object + filters: + type: object + notifications: + type: Array of object + deployment: + type: object + ingestion_definition: + type: object + example: + continuous: false + name: Wikipedia pipeline (SQL) + clusters: + - label: default + autoscale: + min_workers: 1 + max_workers: 5 + mode: ENHANCED + libraries: + - notebook: + path: /Users/username/DLT Notebooks/Delta Live Tables quickstart + (SQL) + storage: /Users/username/data + description: Creates a new data processing pipeline based on the requested configuration. + If successful, this method returns the ID of the new pipeline. + get: + operationId: pipelines-listpipelines + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/listpipelines + x-stackQL-resource: pipelines + x-stackQL-method: listpipelines + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + - name: order_by + in: query + - name: filter + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + statuses: + type: array + items: + type: object + properties: + name: + type: string + pipeline_id: + type: string + state: + type: string + latest_updates: + type: array + items: + type: object + properties: + update_id: + type: string + state: + type: string + creation_time: + type: string + creator_user_name: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.statuses + description: Lists pipelines defined in the Delta Live Tables system. + /api/2.0/pipelines/{pipeline_id}: + delete: + operationId: pipelines-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/delete + x-stackQL-resource: pipelines + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a pipeline. + get: + operationId: pipelines-get + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/get + x-stackQL-resource: pipelines + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + name: + type: string + pipeline_id: + type: string + state: + type: string + latest_updates: + type: array + items: + type: object + properties: + update_id: + type: string + state: + type: string + creation_time: + type: string + creator_user_name: + type: string + spec: + type: object + properties: + continuous: + type: boolean + name: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + clusters: + type: array + items: + type: object + properties: + label: + type: string + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + mode: + type: string + id: + type: string + libraries: + type: array + items: + type: object + properties: + notebook: + type: object + properties: + path: + type: string + storage: + type: string + target: + type: string + run_as_user_name: + type: string + cluster_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + put: + operationId: pipelines-update + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/update + x-stackQL-resource: pipelines + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: string + name: + type: string + storage: + type: string + target: + type: string + schema: + type: string + continuous: + type: boolean + development: + type: boolean + photon: + type: boolean + edition: + type: string + channel: + type: string + catalog: + type: string + serverless: + type: boolean + pipeline_id: + type: string + allow_duplicate_names: + type: boolean + expected_last_modified: + type: integer + format: int64 + configuration: + type: object + clusters: + type: Array of object + libraries: + type: Array of object + trigger: + type: object + filters: + type: object + notifications: + type: Array of object + deployment: + type: object + ingestion_definition: + type: object + example: + continuous: false + name: Wikipedia pipeline (SQL) + clusters: + - label: default + autoscale: + min_workers: 1 + max_workers: 5 + mode: ENHANCED + id: a12cd3e4-0ab1-1abc-1a2b-1a2bcd3e4fg5 + libraries: + - notebook: + path: /Users/username/DLT Notebooks/Delta Live Tables quickstart + (SQL) + storage: /Users/username/data + target: wikipedia_quickstart_data + description: Updates a pipeline with the supplied configuration. + /api/2.0/pipelines/{pipeline_id}/stop: + post: + operationId: pipelines-stop + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/stop + x-stackQL-resource: pipelines + x-stackQL-method: stop + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Stops the pipeline by canceling the active update. If there is + no active update for the pipeline, this request is a no-op. + /api/2.0/pipelines/{pipeline_id}/events: + get: + operationId: pipeline-events-listpipelineevents + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/listpipelineevents + x-stackQL-resource: pipeline_events + x-stackQL-method: listpipelineevents + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + - name: max_results + in: query + - name: order_by + in: query + - name: filter + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + prev_page_token: + type: string + events: + type: array + items: + type: object + properties: + id: + type: string + sequence: + type: object + properties: + data_plane_id: + type: object + properties: + instance: + type: string + seq_no: + type: integer + control_plane_seq_no: + type: integer + origin: + type: object + properties: + cloud: + type: string + region: + type: string + org_id: + type: integer + pipeline_id: + type: string + pipeline_name: + type: string + cluster_id: + type: string + update_id: + type: string + maintenance_id: + type: string + table_id: + type: string + dataset_name: + type: string + flow_id: + type: string + flow_name: + type: string + batch_id: + type: integer + request_id: + type: string + uc_resource_id: + type: string + host: + type: string + materialization_name: + type: string + timestamp: + type: string + message: + type: string + level: + type: string + error: + type: object + properties: + fatal: + type: boolean + exceptions: + type: array + items: + type: object + properties: + class_name: + type: string + message: + type: string + stack: + type: array + items: + type: object + properties: + declaring_class: + type: string + method_name: + type: string + file_name: + type: string + line_number: + type: integer + event_type: + type: string + maturity_level: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.events + description: Retrieves events for a pipeline. + /api/2.0/permissions/pipelines/{pipeline_id}: + get: + operationId: pipeline-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/getpermissions + x-stackQL-resource: pipeline_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a pipeline. Pipelines can inherit permissions + from their root object. + put: + operationId: pipeline-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/setpermissions + x-stackQL-resource: pipeline_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: pipeline-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/updatepermissions + x-stackQL-resource: pipeline_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a pipeline. Pipelines can inherit permissions + from their root object. + /api/2.0/permissions/pipelines/{pipeline_id}/permissionLevels: + get: + operationId: pipeline-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/getpermissionlevels + x-stackQL-resource: pipeline_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/pipelines/{pipeline_id}/updates/{update_id}: + get: + operationId: pipeline-updates-getupdate + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/getupdate + x-stackQL-resource: pipeline_updates + x-stackQL-method: getupdate + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: pipeline_id + required: true + description: string + in: path + - name: update_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + update: + type: object + properties: + creation_time: + type: integer + pipeline_id: + type: string + state: + type: string + update_id: + type: string + config: + type: object + properties: + continuous: + type: boolean + name: + type: string + clusters: + type: array + items: + type: object + properties: + label: + type: string + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + mode: + type: string + id: + type: string + libraries: + type: array + items: + type: object + properties: + notebook: + type: object + properties: + path: + type: string + configuration: + type: object + properties: + pipelines.numStreamRetryAttempts: + type: string + storage: + type: string + target: + type: string + development: + type: boolean + full_refresh: + type: boolean + cause: + type: string + request_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.update + description: Gets an update from an active pipeline. + /api/2.0/pipelines/{pipeline_id}/updates: + get: + operationId: pipeline-updates-listupdates + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/listupdates + x-stackQL-resource: pipeline_updates + x-stackQL-method: listupdates + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + - name: page_token + in: query + - name: max_results + in: query + - name: until_update_id + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + updates: + type: array + items: + type: object + properties: + pipeline_id: + type: string + update_id: + type: string + config: + type: object + properties: + id: + type: string + name: + type: string + storage: + type: string + configuration: + type: object + properties: + property1: + type: string + property2: + type: string + clusters: + type: array + items: + type: object + properties: + label: + type: string + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark.streaming.ui.retainedBatches: + type: integer + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + instance_pool_id: + type: string + driver_instance_pool_id: + type: string + policy_id: + type: string + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + mode: + type: string + apply_policy_default_values: + type: boolean + enable_local_disk_encryption: + type: boolean + libraries: + type: array + items: + type: object + properties: + notebook: + type: object + properties: + path: + type: string + file: + type: object + properties: + path: + type: string + whl: + type: string + trigger: + type: object + properties: + manual: + type: object + properties: {} + cron: + type: object + properties: + quartz_cron_schedule: + type: string + timezone_id: + type: string + target: + type: string + schema: + type: string + filters: + type: object + properties: + include: + type: array + items: + type: string + exclude: + type: array + items: + type: string + continuous: + type: boolean + development: + type: boolean + photon: + type: boolean + edition: + type: string + channel: + type: string + catalog: + type: string + notifications: + type: array + items: + type: object + properties: + email_recipients: + type: array + items: + type: string + alerts: + type: array + items: + type: string + serverless: + type: boolean + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + ingestion_definition: + type: object + properties: + connection_name: + type: string + ingestion_gateway_id: + type: string + objects: + type: array + items: + type: object + properties: + schema: + type: object + properties: + source_catalog: + type: string + source_schema: + type: string + destination_catalog: + type: string + destination_schema: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + table: + type: object + properties: + source_catalog: + type: string + source_schema: + type: string + source_table: + type: string + destination_catalog: + type: string + destination_schema: + type: string + destination_table: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + report: + type: object + properties: + source_url: + type: string + destination_catalog: + type: string + destination_schema: + type: string + destination_table: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + table_configuration: + type: object + properties: + primary_keys: + type: array + items: + type: string + sequence_by: + type: array + items: + type: string + cause: + type: string + state: + type: string + cluster_id: + type: string + creation_time: + type: integer + validate_only: + type: boolean + full_refresh: + type: boolean + refresh_selection: + type: array + items: + type: string + full_refresh_selection: + type: array + items: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.updates + description: List updates for an active pipeline. + post: + operationId: pipeline-updates-startupdate + externalDocs: + url: https://docs.databricks.com/api/workspace/pipelines/startupdate + x-stackQL-resource: pipeline_updates + x-stackQL-method: startupdate + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: pipeline_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + update_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + full_refresh: + type: boolean + validate_only: + type: boolean + cause: + type: string + refresh_selection: + type: Array of string + full_refresh_selection: + type: Array of string + example: + full_refresh: true + description: Starts a new update for the pipeline. If there is already an active + update for the pipeline, the request will fail and the active update will + remain running. +components: + x-stackQL-resources: + pipelines: + id: databricks_workspace.deltalivetables.pipelines + name: pipelines + title: Pipelines + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1pipelines/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listpipelines: + operation: + $ref: '#/paths/~1api~12.0~1pipelines/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.statuses + delete: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1stop/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/listpipelines' + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/stop' + pipeline_events: + id: databricks_workspace.deltalivetables.pipeline_events + name: pipeline_events + title: Pipeline_events + methods: + listpipelineevents: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1events/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.events + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_events/methods/listpipelineevents' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + pipeline_permissions: + id: databricks_workspace.deltalivetables.pipeline_permissions + name: pipeline_permissions + title: Pipeline_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/pipeline_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/pipeline_permissions/methods/setpermissions' + delete: [] + exec: [] + pipeline_permission_levels: + id: databricks_workspace.deltalivetables.pipeline_permission_levels + name: pipeline_permission_levels + title: Pipeline_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1pipelines~1{pipeline_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + pipeline_updates: + id: databricks_workspace.deltalivetables.pipeline_updates + name: pipeline_updates + title: Pipeline_updates + methods: + getupdate: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1updates~1{update_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.update + listupdates: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1updates/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.updates + startupdate: + operation: + $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1updates/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pipeline_updates/methods/listupdates' + - $ref: '#/components/x-stackQL-resources/pipeline_updates/methods/getupdate' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/pipeline_updates/methods/startupdate' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml b/providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml new file mode 100644 index 00000000..79240229 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/deltasharing.yaml @@ -0,0 +1,1768 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Deltasharing API + description: Deltasharing +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.1/unity-catalog/providers: + post: + operationId: providers-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/create + x-stackQL-resource: providers + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new provider was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + authentication_type: + type: string + comment: + type: required + recipient_profile_str: + type: string + example: + name: string + authentication_type: TOKEN + comment: string + recipient_profile_str: string + description: Creates a new authentication provider minimally based on a name + and authentication type. The caller must be an admin on the metastore. + get: + operationId: providers-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/list + x-stackQL-resource: providers + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: data_provider_global_metastore_id + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The provider list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.providers + description: Gets an array of available authentication providers. The caller + must either be a metastore admin or the owner of the providers. Providers + not owned by the caller are not included in the response. There is no guarantee + of a specific ordering of the elements in the array. + /api/2.1/unity-catalog/providers/{name}: + delete: + operationId: providers-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/delete + x-stackQL-resource: providers + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The provider was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes an authentication provider, if the caller is a metastore + admin or is the owner of the provider. + get: + operationId: providers-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/get + x-stackQL-resource: providers + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The provider was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + description: Gets a specific authentication provider. The caller must supply + the name of the provider, and must either be a metastore admin or the owner + of the provider. + patch: + operationId: providers-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/update + x-stackQL-resource: providers + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The provider was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + recipient_profile: + type: object + properties: + share_credentials_version: + type: integer + endpoint: + type: string + bearer_token: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + data_provider_global_metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + recipient_profile_str: + type: string + comment: + type: string + owner: + type: string + new_name: + type: string + example: + recipient_profile_str: string + comment: string + owner: string + new_name: string + description: Updates the information for an authentication provider, if the + caller is a metastore admin or is the owner of the provider. If the update + changes the provider name, the caller must be both a metastore admin and the + owner of the provider. + /api/2.1/unity-catalog/providers/{name}/shares: + get: + operationId: provider-shares-listshares + externalDocs: + url: https://docs.databricks.com/api/workspace/providers/listshares + x-stackQL-resource: provider_shares + x-stackQL-method: listshares + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The provider shares list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + shares: + type: array + items: + type: object + properties: + name: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.shares + description: 'Gets an array of a specified provider''s shares within the metastore + where:' + /api/2.1/unity-catalog/recipients: + post: + operationId: recipients-create + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/create + x-stackQL-resource: recipients + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new recipient was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + authentication_type: + type: string + owner: + type: required + comment: + type: string + data_recipient_global_metastore_id: + type: string + sharing_code: + type: string + expiration_time: + type: string + ip_access_list: + type: object + properties_kvpairs: + type: object + example: + name: string + authentication_type: TOKEN + owner: string + comment: string + ip_access_list: + allowed_ip_addresses: + - string + properties_kvpairs: + properties: + property1: string + property2: string + data_recipient_global_metastore_id: string + sharing_code: string + expiration_time: 0 + description: Creates a new recipient with the delta sharing authentication type + in the metastore. The caller must be a metastore admin or has the + get: + operationId: recipients-list + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/list + x-stackQL-resource: recipients + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: data_recipient_global_metastore_id + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The list of recipients was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + recipients: + type: array + items: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.recipients + description: 'Gets an array of all share recipients within the current metastore + where:' + /api/2.1/unity-catalog/recipients/{name}: + delete: + operationId: recipients-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/delete + x-stackQL-resource: recipients + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the specified recipient from the metastore. The caller + must be the owner of the recipient. + get: + operationId: recipients-get + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/get + x-stackQL-resource: recipients + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + description: 'Gets a share recipient from the metastore if:' + patch: + operationId: recipients-update + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/update + x-stackQL-resource: recipients + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + new_name: + type: string + expiration_time: + type: integer + format: int64 + ip_access_list: + type: object + properties_kvpairs: + type: object + example: + owner: string + comment: string + ip_access_list: + allowed_ip_addresses: + - string + new_name: string + properties_kvpairs: + properties: + property1: string + property2: string + expiration_time: 0 + description: Updates an existing recipient in the metastore. The caller must + be a metastore admin or the owner of the recipient. If the recipient name + will be updated, the user must be both a metastore admin and the owner of + the recipient. + /api/2.1/unity-catalog/recipients/{name}/rotate-token: + post: + operationId: recipients-rotatetoken + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/rotatetoken + x-stackQL-resource: recipients + x-stackQL-method: rotatetoken + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The recipient token was successfully rotated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + authentication_type: + type: string + sharing_code: + type: string + data_recipient_global_metastore_id: + type: string + owner: + type: string + comment: + type: string + ip_access_list: + type: object + properties: + allowed_ip_addresses: + type: array + items: + type: string + properties_kvpairs: + type: object + properties: + properties: + type: object + properties: + property1: + type: string + property2: + type: string + activation_url: + type: string + activated: + type: boolean + created_at: + type: integer + created_by: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + updated_at: + type: integer + updated_by: + type: string + cloud: + type: string + region: + type: string + metastore_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + existing_token_expire_in_seconds: + type: required + example: + existing_token_expire_in_seconds: 0 + description: Refreshes the specified recipient's delta sharing authentication + token with the provided token info. The caller must be the owner of the recipient. + /api/2.1/unity-catalog/public/data_sharing_activation/{activation_url}: + get: + operationId: recipient-activation-token-retrievetoken + externalDocs: + url: https://docs.databricks.com/api/workspace/recipientactivation/retrievetoken + x-stackQL-resource: recipient_activation_token + x-stackQL-method: retrievetoken + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: activation_url + required: true + description: string + in: path + responses: + '200': + description: The access token was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + description: Retrieve access token with an activation url. This is a public + API without any authentication. + /api/2.1/unity-catalog/public/data_sharing_activation_info/{activation_url}: + get: + operationId: recipient-activation-url-getactivationurlinfo + externalDocs: + url: https://docs.databricks.com/api/workspace/recipientactivation/getactivationurlinfo + x-stackQL-resource: recipient_activation_url + x-stackQL-method: getactivationurlinfo + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: activation_url + required: true + description: string + in: path + responses: + '200': + description: The activation URL fetch was successful. + content: + application/json: + schema: + type: object + properties: {} + description: Gets an activation URL for a share. + /api/2.1/unity-catalog/recipients/{name}/share-permissions: + get: + operationId: recipient-share-permissions-sharepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/recipients/sharepermissions + x-stackQL-resource: recipient_share_permissions + x-stackQL-method: sharepermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The recipient share permissions list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + permissions_out: + type: array + items: + type: object + properties: + share_name: + type: string + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.permissions_out + description: Gets the share permissions for the specified Recipient. The caller + must be a metastore admin or the owner of the Recipient. + /api/2.1/unity-catalog/shares: + post: + operationId: shares-create + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/create + x-stackQL-resource: shares + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new share was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + storage_root: + type: string + example: + name: string + comment: string + storage_root: string + description: Creates a new share for data objects. Data objects can be added + after creation with + get: + operationId: shares-list + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/list + x-stackQL-resource: shares + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The shares list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + shares: + type: array + items: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.shares + description: Gets an array of data object shares from the metastore. The caller + must be a metastore admin or the owner of the share. There is no guarantee + of a specific ordering of the elements in the array. + /api/2.1/unity-catalog/shares/{name}: + delete: + operationId: shares-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/delete + x-stackQL-resource: shares + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The share was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a data object share from the metastore. The caller must + be an owner of the share. + get: + operationId: shares-get + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/get + x-stackQL-resource: shares + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_shared_data + in: query + responses: + '200': + description: The share was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + description: Gets a data object share from the metastore. The caller must be + a metastore admin or the owner of the share. + patch: + operationId: shares-update + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/update + x-stackQL-resource: shares + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The share was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + storage_root: + type: string + objects: + type: array + items: + type: object + properties: + name: + type: string + comment: + type: string + shared_as: + type: string + string_shared_as: + type: string + content: + type: string + history_data_sharing_status: + type: string + partitions: + type: array + items: + type: object + properties: + values: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + recipient_property_key: + type: string + op: + type: string + cdf_enabled: + type: boolean + start_version: + type: integer + data_object_type: + type: string + added_at: + type: integer + added_by: + type: string + status: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + storage_root: + type: string + new_name: + type: string + updates: + type: Array of object + example: + owner: string + comment: string + storage_root: string + new_name: string + updates: + - action: ADD + data_object: + name: string + comment: string + shared_as: string + string_shared_as: string + content: string + history_data_sharing_status: ENABLED + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + cdf_enabled: true + start_version: 0 + data_object_type: TABLE + added_at: 0 + added_by: string + status: ACTIVE + description: Updates the share with the changes and data objects in the request. + The caller must be the owner of the share or a metastore admin. + /api/2.1/unity-catalog/shares/{name}/permissions: + get: + operationId: share-permissions-sharepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/sharepermissions + x-stackQL-resource: share_permissions + x-stackQL-method: sharepermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The share permissions list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + x-stackQL-objectKey: $.privilege_assignments + description: Gets the permissions for a data share from the metastore. The caller + must be a metastore admin or the owner of the share. + patch: + operationId: share-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/shares/updatepermissions + x-stackQL-resource: share_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The share permissions were successfully updated. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + changes: + type: Array of object + example: + changes: + - principal: string + add: + - SELECT + remove: + - SELECT + description: Updates the permissions for a data share in the metastore. The + caller must be a metastore admin or an owner of the share. +components: + x-stackQL-resources: + providers: + id: databricks_workspace.deltasharing.providers + name: providers + title: Providers + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.providers + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/providers/methods/get' + - $ref: '#/components/x-stackQL-resources/providers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/providers/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/providers/methods/delete' + exec: [] + provider_shares: + id: databricks_workspace.deltasharing.provider_shares + name: provider_shares + title: Provider_shares + methods: + listshares: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1providers~1{name}~1shares/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.shares + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_shares/methods/listshares' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + recipients: + id: databricks_workspace.deltasharing.recipients + name: recipients + title: Recipients + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.recipients + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + rotatetoken: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}~1rotate-token/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipients/methods/get' + - $ref: '#/components/x-stackQL-resources/recipients/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/recipients/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/recipients/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/recipients/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/recipients/methods/rotatetoken' + recipient_activation_token: + id: databricks_workspace.deltasharing.recipient_activation_token + name: recipient_activation_token + title: Recipient_activation_token + methods: + retrievetoken: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1public~1data_sharing_activation~1{activation_url}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipient_activation_token/methods/retrievetoken' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + recipient_activation_url: + id: databricks_workspace.deltasharing.recipient_activation_url + name: recipient_activation_url + title: Recipient_activation_url + methods: + getactivationurlinfo: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1public~1data_sharing_activation_info~1{activation_url}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/recipient_activation_url/methods/getactivationurlinfo' + recipient_share_permissions: + id: databricks_workspace.deltasharing.recipient_share_permissions + name: recipient_share_permissions + title: Recipient_share_permissions + methods: + sharepermissions: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1recipients~1{name}~1share-permissions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permissions_out + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recipient_share_permissions/methods/sharepermissions' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + shares: + id: databricks_workspace.deltasharing.shares + name: shares + title: Shares + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.shares + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shares/methods/get' + - $ref: '#/components/x-stackQL-resources/shares/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/shares/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/shares/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/shares/methods/delete' + exec: [] + share_permissions: + id: databricks_workspace.deltasharing.share_permissions + name: share_permissions + title: Share_permissions + methods: + sharepermissions: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}~1permissions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.privilege_assignments + updatepermissions: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1shares~1{name}~1permissions/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/share_permissions/methods/sharepermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/share_permissions/methods/updatepermissions' + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml b/providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml new file mode 100644 index 00000000..e3fcf603 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/filemanagement.yaml @@ -0,0 +1,865 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Filemanagement API + description: Filemanagement +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/dbfs/list: + get: + operationId: dbfs-directories-list + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/list + x-stackQL-resource: dbfs_directories + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + files: + type: array + items: + type: object + properties: + path: + type: string + is_dir: + type: boolean + file_size: + type: integer + modification_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.files + description: List the contents of a directory, or details of the file. If the + file or directory does not exist, this call throws an exception with + /api/2.0/dbfs/mkdirs: + post: + operationId: dbfs-directories-mkdirs + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/mkdirs + x-stackQL-resource: dbfs_directories + x-stackQL-method: mkdirs + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + example: + path: /mnt/foo + description: Creates the given directory and necessary parent directories if + they do not exist. If a file (not a directory) exists at any prefix of the + input path, this call throws an exception with + /api/2.0/dbfs/delete: + post: + operationId: dbfs-objects-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/delete + x-stackQL-resource: dbfs_objects + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + recursive: + type: string + example: + path: /mnt/foo + recursive: false + description: Delete the file or directory (optionally recursively delete all + files in the directory). This call throws an exception with + /api/2.0/dbfs/move: + post: + operationId: dbfs-files-move + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/move + x-stackQL-resource: dbfs_files + x-stackQL-method: move + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + source_path: + type: required + destination_path: + type: string + example: + source_path: /mnt/foo + destination_path: /mnt/bar + description: Moves a file from one location to another location within DBFS. + If the source file does not exist, this call throws an exception with + /api/2.0/dbfs/put: + post: + operationId: dbfs-files-put + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/put + x-stackQL-resource: dbfs_files + x-stackQL-method: put + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + contents: + type: string + overwrite: + type: string + example: + path: /mnt/foo + contents: string + overwrite: false + description: Uploads a file through the use of multipart form post. It is mainly + used for streaming uploads, but can also be used as a convenient single call + for data upload. + /api/2.0/dbfs/read: + get: + operationId: dbfs-files-read + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/read + x-stackQL-resource: dbfs_files + x-stackQL-method: read + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + - name: offset + in: query + - name: length + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + bytes_read: + type: integer + data: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Returns the contents of a file. If the file does not exist, this + call throws an exception with + /api/2.0/dbfs/get-status: + get: + operationId: dbfs-objects-getstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/getstatus + x-stackQL-resource: dbfs_objects + x-stackQL-method: getstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + path: + type: string + is_dir: + type: boolean + file_size: + type: integer + modification_time: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the file information for a file or directory. If the file + or directory does not exist, this call throws an exception with + /api/2.0/dbfs/add-block: + post: + operationId: dbfs-streams-addblock + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/addblock + x-stackQL-resource: dbfs_streams + x-stackQL-method: addblock + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + handle: + type: required + data: + type: integer + format: int64 + example: + handle: 0 + data: string + description: Appends a block of data to the stream specified by the input handle. + If the handle does not exist, this call will throw an exception with + /api/2.0/dbfs/close: + post: + operationId: dbfs-streams-close + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/close + x-stackQL-resource: dbfs_streams + x-stackQL-method: close + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + handle: + type: required + example: + handle: 0 + description: Closes the stream specified by the input handle. If the handle + does not exist, this call throws an exception with + /api/2.0/dbfs/create: + post: + operationId: dbfs-streams-create + externalDocs: + url: https://docs.databricks.com/api/workspace/dbfs/create + x-stackQL-resource: dbfs_streams + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + handle: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + overwrite: + type: string + example: + path: /mnt/foo + overwrite: false + description: Opens a stream to write to a file and returns a handle to this + stream. There is a 10 minute idle timeout on this handle. If a file or directory + already exists on the given path and + /api/2.0/fs/directories{directory_path}: + put: + operationId: directories-createdirectory + externalDocs: + url: https://docs.databricks.com/api/workspace/files/createdirectory + x-stackQL-resource: directories + x-stackQL-method: createdirectory + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: directory_path + required: true + description: string + in: path + responses: + '204': + description: The directory was successfully created or already exists. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Creates an empty directory. If necessary, also creates any parent + directories of the new, empty directory (like the shell command + delete: + operationId: directories-deletedirectory + externalDocs: + url: https://docs.databricks.com/api/workspace/files/deletedirectory + x-stackQL-resource: directories + x-stackQL-method: deletedirectory + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: directory_path + required: true + description: string + in: path + responses: + '204': + description: The directory was successfully deleted. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes an empty directory. + get: + operationId: directory-contents-listdirectorycontents + externalDocs: + url: https://docs.databricks.com/api/workspace/files/listdirectorycontents + x-stackQL-resource: directory_contents + x-stackQL-method: listdirectorycontents + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: directory_path + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: An array of DirectoryEntry for the contents of the directory. + If `next_page_token` is set, there may be more entries in the directory. + content: + application/json: + schema: + type: object + properties: + contents: + type: array + items: + type: object + properties: + path: + type: string + is_directory: + type: boolean + file_size: + type: integer + last_modified: + type: integer + name: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + x-stackQL-objectKey: $.contents + description: Returns the contents of a directory. If there is no directory at + the specified path, the API returns a HTTP 404 error. + /api/2.0/fs/files{file_path}: + delete: + operationId: files-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/files/delete + x-stackQL-resource: files + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: file_path + required: true + description: string + in: path + responses: + '204': + description: The file was successfully deleted. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a file. If the request is successful, there is no response + body. + get: + operationId: files-download + externalDocs: + url: https://docs.databricks.com/api/workspace/files/download + x-stackQL-resource: files + x-stackQL-method: download + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: file_path + required: true + description: string + in: path + responses: + '200': + description: '' + description: Downloads a file. The file contents are the response body. This + is a standard HTTP file download, not a JSON RPC. It supports the Range and + If-Unmodified-Since HTTP headers. + put: + operationId: files-upload + externalDocs: + url: https://docs.databricks.com/api/workspace/files/upload + x-stackQL-resource: files + x-stackQL-method: upload + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: file_path + required: true + description: string + in: path + - name: overwrite + in: query + responses: + '204': + description: The file was successfully uploaded. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Uploads a file of up to 5 GiB. The file contents should be sent + as the request body as raw bytes (an octet stream); do not encode or otherwise + modify the bytes before sending. The contents of the resulting file will be + exactly the bytes sent in the request body. If the request is successful, + there is no response body. +components: + x-stackQL-resources: + dbfs_directories: + id: databricks_workspace.filemanagement.dbfs_directories + name: dbfs_directories + title: Dbfs_directories + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.files + mkdirs: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1mkdirs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbfs_directories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dbfs_directories/methods/mkdirs' + update: [] + replace: [] + delete: [] + exec: [] + dbfs_objects: + id: databricks_workspace.filemanagement.dbfs_objects + name: dbfs_objects + title: Dbfs_objects + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getstatus: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1get-status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbfs_objects/methods/getstatus' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dbfs_objects/methods/delete' + exec: [] + dbfs_files: + id: databricks_workspace.filemanagement.dbfs_files + name: dbfs_files + title: Dbfs_files + methods: + move: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1move/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + put: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1put/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + read: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1read/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbfs_files/methods/read' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/dbfs_files/methods/put' + - $ref: '#/components/x-stackQL-resources/dbfs_files/methods/move' + dbfs_streams: + id: databricks_workspace.filemanagement.dbfs_streams + name: dbfs_streams + title: Dbfs_streams + methods: + addblock: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1add-block/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + close: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1close/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1api~12.0~1dbfs~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/dbfs_streams/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dbfs_streams/methods/close' + exec: + - $ref: '#/components/x-stackQL-resources/dbfs_streams/methods/addblock' + directories: + id: databricks_workspace.filemanagement.directories + name: directories + title: Directories + methods: + createdirectory: + operation: + $ref: '#/paths/~1api~12.0~1fs~1directories{directory_path}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletedirectory: + operation: + $ref: '#/paths/~1api~12.0~1fs~1directories{directory_path}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/directories/methods/createdirectory' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/directories/methods/deletedirectory' + exec: [] + directory_contents: + id: databricks_workspace.filemanagement.directory_contents + name: directory_contents + title: Directory_contents + methods: + listdirectorycontents: + operation: + $ref: '#/paths/~1api~12.0~1fs~1directories{directory_path}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.contents + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/directory_contents/methods/listdirectorycontents' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + files: + id: databricks_workspace.filemanagement.files + name: files + title: Files + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1fs~1files{file_path}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + download: + operation: + $ref: '#/paths/~1api~12.0~1fs~1files{file_path}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: '#/paths/~1api~12.0~1fs~1files{file_path}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/files/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/files/methods/upload' + - $ref: '#/components/x-stackQL-resources/files/methods/download' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml new file mode 100644 index 00000000..b52ac9ed --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml @@ -0,0 +1,2891 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Iam API + description: Iam +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/preview/accounts/access-control/assignable-roles: + get: + operationId: assignable-roles-getassignablerolesforresource + externalDocs: + url: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getassignablerolesforresource + x-stackQL-resource: assignable_roles + x-stackQL-method: getassignablerolesforresource + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: resource + required: true + description: string + in: query + responses: + '200': + description: Assignable roles were returned successfully. + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.roles + description: Gets all the roles that can be granted on an account-level resource. + A role is grantable if the rule set on the resource can contain an access + rule of the role. + /api/2.0/preview/scim/v2/Me: + get: + operationId: currentuser-me + externalDocs: + url: https://docs.databricks.com/api/workspace/currentuser/me + x-stackQL-resource: currentuser + x-stackQL-method: me + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: User information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get details about the current method caller's identity. + /api/2.0/preview/scim/v2/Groups: + post: + operationId: groups-create + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/create + x-stackQL-resource: groups + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '201': + description: The group creation request succeeded. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Properties of the new group. + description: Creates a group in the Databricks workspace with a unique name, + using the supplied group details. + get: + operationId: groups-list + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/list + x-stackQL-resource: groups + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List groups operation was succesful. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets all details of the groups associated with the Databricks workspace. + /api/2.0/preview/scim/v2/Groups/{id}: + delete: + operationId: groups-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/delete + x-stackQL-resource: groups + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Group was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a group from the Databricks workspace. + get: + operationId: groups-get + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/get + x-stackQL-resource: groups + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + displayName: + type: string + members: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the information for a specific group in the Databricks workspace. + patch: + operationId: groups-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/patch + x-stackQL-resource: groups + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on group information. + description: Partially updates the details of a group. + put: + operationId: groups-update + externalDocs: + url: https://docs.databricks.com/api/workspace/groups/update + x-stackQL-resource: groups + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Group information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + displayName: + type: string + externalId: + type: string + members: + type: Array of object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: string + displayName: string + members: + - $ref: string + value: string + display: string + primary: true + type: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + description: Operations to be applied on group information. + description: Updates the details of a group by replacing the entire group entity. + /api/2.0/permissions/{request_object_type}/{request_object_id}: + get: + operationId: permissions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/get + x-stackQL-resource: permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an object. Objects can inherit permissions + from their parent objects or root object. + put: + operationId: permissions-set + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/set + x-stackQL-resource: permissions + x-stackQL-method: set + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their parent objects or root object. + patch: + operationId: permissions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/update + x-stackQL-resource: permissions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an object. Objects can inherit permissions + from their parent objects or root object. + /api/2.0/permissions/{request_object_type}/{request_object_id}/permissionLevels: + get: + operationId: permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/permissions/getpermissionlevels + x-stackQL-resource: permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: request_object_type + required: true + description: string + in: path + - name: request_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/preview/accounts/access-control/rule-sets: + get: + operationId: rule-sets-getruleset + externalDocs: + url: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getruleset + x-stackQL-resource: rule_sets + x-stackQL-method: getruleset + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: etag + required: true + description: string + in: query + responses: + '200': + description: The rule set was returned successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + principals: + type: array + items: + type: string + role: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + description: Get a rule set by its name. A rule set is always attached to a + resource and contains a list of access rules on the said resource. Currently + only a default rule set for each resource is supported. + put: + operationId: rule-sets-updateruleset + externalDocs: + url: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/updateruleset + x-stackQL-resource: rule_sets + x-stackQL-method: updateruleset + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Rule sets on the resource was updated successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + grant_rules: + type: array + items: + type: object + properties: + role: + type: string + principals: + type: array + items: + type: string + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + rule_set: + type: object + example: + name: string + rule_set: + name: string + grant_rules: + - principals: + - string + role: string + etag: string + description: The rule set to update to. + description: Replace the rules of a rule set. First, use a GET rule set request + to read the current version of the rule set before modifying it. This pattern + helps prevent conflicts between concurrent updates. + /api/2.0/preview/scim/v2/ServicePrincipals: + post: + operationId: service-principals-create + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/create + x-stackQL-resource: service_principals + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + applicationId: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new service principal. + description: Creates a new service principal in the Databricks workspace. + get: + operationId: service-principals-list + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/list + x-stackQL-resource: service_principals + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List service principals operation was succesful. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + applicationId: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets the set of service principals associated with a Databricks + workspace. + /api/2.0/preview/scim/v2/ServicePrincipals/{id}: + delete: + operationId: service-principals-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/delete + x-stackQL-resource: service_principals + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: Service principal was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete a single service principal in the Databricks workspace. + get: + operationId: service-principals-get + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/get + x-stackQL-resource: service_principals + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + applicationId: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the details for a single service principal define in the Databricks + workspace. + patch: + operationId: service-principals-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/patch + x-stackQL-resource: service_principals + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on service principal information. + description: Partially updates the details of a single service principal in + the Databricks workspace. + put: + operationId: service-principals-update + externalDocs: + url: https://docs.databricks.com/api/workspace/serviceprincipals/update + x-stackQL-resource: service_principals + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: Service principal information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + applicationId: + type: uuid + displayName: + type: string + externalId: + type: string + active: + type: boolean + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal + id: string + applicationId: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + displayName: etl-service + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Updates the details of a single service principal. + /api/2.0/preview/scim/v2/Users: + post: + operationId: users-create + externalDocs: + url: https://docs.databricks.com/api/workspace/users/create + x-stackQL-resource: users + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '201': + description: The user creation request succeeded. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Properties of the new user. + description: Creates a new user in the Databricks workspace. This new user will + also be added to the Databricks account. + get: + operationId: users-list + externalDocs: + url: https://docs.databricks.com/api/workspace/users/list + x-stackQL-resource: users + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: List users operation was succesful. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: integer + startIndex: + type: integer + itemsPerPage: + type: integer + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.Resources + description: Gets details for all the users associated with a Databricks workspace. + /api/2.0/preview/scim/v2/Users/{id}: + delete: + operationId: users-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/users/delete + x-stackQL-resource: users + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '204': + description: User was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a user. Deleting a user from a Databricks workspace also + removes objects associated with the user. + get: + operationId: users-get + externalDocs: + url: https://docs.databricks.com/api/workspace/users/get + x-stackQL-resource: users + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + - name: filter + in: query + - name: attributes + in: query + - name: excludedAttributes + in: query + - name: startIndex + in: query + - name: count + in: query + - name: sortBy + in: query + - name: sortOrder + in: query + responses: + '200': + description: User information was returned successfully. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + userName: + type: string + emails: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + displayName: + type: string + groups: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + roles: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + entitlements: + type: array + items: + type: object + properties: + $ref: + type: string + value: + type: string + display: + type: string + primary: + type: boolean + type: + type: string + externalId: + type: string + active: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets information for a specific user in Databricks workspace. + patch: + operationId: users-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/users/patch + x-stackQL-resource: users + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + Operations: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: string + value: null + description: Operations to be applied on user information. + description: Partially updates a user resource by applying the supplied operations + on specific user attributes. + put: + operationId: users-update + externalDocs: + url: https://docs.databricks.com/api/workspace/users/update + x-stackQL-resource: users + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: int64 + in: path + responses: + '200': + description: User information was updated successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + schemas: + type: Array of string + id: + type: integer + format: int64 + userName: + type: email + displayName: + type: string + externalId: + type: string + active: + type: boolean + emails: + type: Array of object + name: + type: object + groups: + type: Array of object + roles: + type: Array of object + entitlements: + type: Array of object + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: string + userName: user@example.com + emails: + - $ref: string + value: string + display: string + primary: true + type: string + name: + givenName: string + familyName: string + displayName: string + groups: + - $ref: string + value: string + display: string + primary: true + type: string + roles: + - $ref: string + value: string + display: string + primary: true + type: string + entitlements: + - $ref: string + value: string + display: string + primary: true + type: string + externalId: string + active: true + description: Replaces a user's information with the data supplied in request. + /api/2.0/permissions/authorization/passwords: + get: + operationId: user-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/users/getpermissions + x-stackQL-resource: user_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of all passwords. Passwords can inherit permissions + from their root object. + put: + operationId: user-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/users/setpermissions + x-stackQL-resource: user_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: user-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/users/updatepermissions + x-stackQL-resource: user_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Updates the permissions on all passwords. Passwords can inherit + permissions from their root object. + /api/2.0/permissions/authorization/passwords/permissionLevels: + get: + operationId: user-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/users/getpermissionlevels + x-stackQL-resource: user_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + assignable_roles: + id: databricks_workspace.iam.assignable_roles + name: assignable_roles + title: Assignable_roles + methods: + getassignablerolesforresource: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1access-control~1assignable-roles/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assignable_roles/methods/getassignablerolesforresource' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + currentuser: + id: databricks_workspace.iam.currentuser + name: currentuser + title: Currentuser + methods: + me: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Me/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/currentuser/methods/me' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + groups: + id: databricks_workspace.iam.groups + name: groups + title: Groups + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Groups~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete' + exec: [] + permissions: + id: databricks_workspace.iam.permissions + name: permissions + title: Permissions + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + set: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/set' + delete: [] + exec: [] + permission_levels: + id: databricks_workspace.iam.permission_levels + name: permission_levels + title: Permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{request_object_type}~1{request_object_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + rule_sets: + id: databricks_workspace.iam.rule_sets + name: rule_sets + title: Rule_sets + methods: + getruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1access-control~1rule-sets/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateruleset: + operation: + $ref: '#/paths/~1api~12.0~1preview~1accounts~1access-control~1rule-sets/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/getruleset' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/updateruleset' + replace: [] + delete: [] + exec: [] + service_principals: + id: databricks_workspace.iam.service_principals + name: service_principals + title: Service_principals + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1ServicePrincipals~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/get' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/update' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/service_principals/methods/delete' + exec: [] + users: + id: databricks_workspace.iam.users + name: users + title: Users + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.Resources + delete: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1preview~1scim~1v2~1Users~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update' + - $ref: '#/components/x-stackQL-resources/users/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + exec: [] + user_permissions: + id: databricks_workspace.iam.user_permissions + name: user_permissions + title: User_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/user_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/user_permissions/methods/setpermissions' + delete: [] + exec: [] + user_permission_levels: + id: databricks_workspace.iam.user_permission_levels + name: user_permission_levels + title: User_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1passwords~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml b/providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml new file mode 100644 index 00000000..496d9be8 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/lakeview.yaml @@ -0,0 +1,1270 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Lakeview API + description: Lakeview +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/lakeview/dashboards: + post: + operationId: dashboards-create + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/create + x-stackQL-resource: dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + parent_path: + type: string + example: + display_name: Monthly Traffic Report + warehouse_id: 47bb1c472649e711 + etag: '80611980' + serialized_dashboard: '{"pages":[{"name":"b532570b","displayName":"New + Page"}]}' + parent_path: /path/to/dir + description: Create a draft dashboard. + get: + operationId: dashboards-list + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/list + x-stackQL-resource: dashboards + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_size + in: query + - name: page_token + in: query + - name: show_trashed + in: query + - name: view + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboards: + type: array + items: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + lifecycle_state: + type: string + warehouse_id: + type: string + create_time: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.dashboards + /api/2.0/lakeview/dashboards/{dashboard_id}: + get: + operationId: dashboards-get + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/get + x-stackQL-resource: dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a draft dashboard. + delete: + operationId: dashboards-trash + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/trash + x-stackQL-resource: dashboards + x-stackQL-method: trash + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Trash a dashboard. + patch: + operationId: dashboards-update + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/update + x-stackQL-resource: dashboards + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + example: + display_name: Monthly Traffic Report + warehouse_id: 47bb1c472649e711 + etag: '80611980' + serialized_dashboard: '{"pages":[{"name":"b532570b","displayName":"New + Page"}]}' + description: Update a draft dashboard. + /api/2.0/lakeview/dashboards/migrate: + post: + operationId: dashboards-migrate + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/migrate + x-stackQL-resource: dashboards + x-stackQL-method: migrate + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + dashboard_id: + type: string + display_name: + type: string + path: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + etag: + type: string + serialized_dashboard: + type: string + lifecycle_state: + type: string + parent_path: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + source_dashboard_id: + type: required + display_name: + type: string + parent_path: + type: string + update_parameter_syntax: + type: string + example: + source_dashboard_id: 4e443c27-9f61-4f2e-a12d-ea5668460bf1 + display_name: Monthly Traffic Report + parent_path: /path/to/dir + update_parameter_syntax: true + description: Migrates a classic SQL dashboard to Lakeview. + /api/2.0/lakeview/dashboards/{dashboard_id}/published: + post: + operationId: dashboards-publish + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/publish + x-stackQL-resource: dashboards + x-stackQL-method: publish + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + embed_credentials: + type: boolean + revision_create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + embed_credentials: + type: boolean + warehouse_id: + type: string + example: + embed_credentials: true + warehouse_id: string + description: Publish the current draft dashboard. + delete: + operationId: dashboards-unpublish + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/unpublish + x-stackQL-resource: dashboards + x-stackQL-method: unpublish + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Unpublish the dashboard. + get: + operationId: dashboards-published-getpublished + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/getpublished + x-stackQL-resource: dashboards_published + x-stackQL-method: getpublished + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + warehouse_id: + type: string + embed_credentials: + type: boolean + revision_create_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get the current published dashboard. + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules: + post: + operationId: dashboard-schedules-createschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/createschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: createschedule + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pause_status: + type: string + display_name: + type: string + etag: + type: string + warehouse_id: + type: string + cron_schedule: + type: object + example: + cron_schedule: + quartz_cron_expression: 0 0 8 * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + display_name: Monthly Traffic Report Snapshot + etag: '80611980' + warehouse_id: 47bb1c472649e711 + get: + operationId: dashboard-schedules-listschedules + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/listschedules + x-stackQL-resource: dashboard_schedules + x-stackQL-method: listschedules + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedules: + type: array + items: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.schedules + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}: + delete: + operationId: dashboard-schedules-deleteschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/deleteschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: deleteschedule + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: dashboard-schedules-getschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/getschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: getschedule + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + put: + operationId: dashboard-schedules-updateschedule + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/updateschedule + x-stackQL-resource: dashboard_schedules + x-stackQL-method: updateschedule + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + schedule_id: + type: string + dashboard_id: + type: string + cron_schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + display_name: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + warehouse_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pause_status: + type: string + display_name: + type: string + etag: + type: string + warehouse_id: + type: string + cron_schedule: + type: object + example: + cron_schedule: + quartz_cron_expression: 0 0 8 * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + display_name: Monthly Traffic Report Snapshot + etag: '80611980' + warehouse_id: 47bb1c472649e711 + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions: + post: + operationId: dashboard-subscriptions-createsubscription + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/createsubscription + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: createsubscription + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + subscription_id: + type: string + schedule_id: + type: string + dashboard_id: + type: string + subscriber: + type: object + properties: + user_subscriber: + type: object + properties: + user_id: + type: string + created_by_user_id: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + etag: + type: string + subscriber: + type: required + example: + subscriber: + user_subscriber: + user_id: '3294322584244938' + etag: '80611980' + get: + operationId: dashboard-subscriptions-listsubscriptions + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/listsubscriptions + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: listsubscriptions + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: page_size + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + subscriptions: + type: array + items: + type: object + properties: + subscription_id: + type: string + schedule_id: + type: string + dashboard_id: + type: string + subscriber: + type: object + properties: + user_subscriber: + type: object + properties: + user_id: + type: string + created_by_user_id: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.subscriptions + /api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions/{subscription_id}: + delete: + operationId: dashboard-subscriptions-deletesubscription + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/deletesubscription + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: deletesubscription + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: subscription_id + required: true + description: string + in: path + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: dashboard-subscriptions-getsubscription + externalDocs: + url: https://docs.databricks.com/api/workspace/lakeview/getsubscription + x-stackQL-resource: dashboard_subscriptions + x-stackQL-method: getsubscription + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: dashboard_id + required: true + description: string + in: path + - name: schedule_id + required: true + description: string + in: path + - name: subscription_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + subscription_id: + type: string + schedule_id: + type: string + dashboard_id: + type: string + subscriber: + type: object + properties: + user_subscriber: + type: object + properties: + user_id: + type: string + created_by_user_id: + type: string + etag: + type: string + create_time: + type: string + update_time: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. +components: + x-stackQL-resources: + dashboards: + id: databricks_workspace.lakeview.dashboards + name: dashboards + title: Dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.dashboards + get: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + trash: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + migrate: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1migrate/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + publish: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + unpublish: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/get' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/trash' + exec: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/unpublish' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/publish' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/migrate' + dashboards_published: + id: databricks_workspace.lakeview.dashboards_published + name: dashboards_published + title: Dashboards_published + methods: + getpublished: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboards_published/methods/getpublished' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + dashboard_schedules: + id: databricks_workspace.lakeview.dashboard_schedules + name: dashboard_schedules + title: Dashboard_schedules + methods: + createschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listschedules: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.schedules + deleteschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateschedule: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/getschedule' + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/listschedules' + insert: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/createschedule' + update: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/updateschedule' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_schedules/methods/deleteschedule' + exec: [] + dashboard_subscriptions: + id: databricks_workspace.lakeview.dashboard_subscriptions + name: dashboard_subscriptions + title: Dashboard_subscriptions + methods: + createsubscription: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listsubscriptions: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.subscriptions + deletesubscription: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions~1{subscription_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getsubscription: + operation: + $ref: '#/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1schedules~1{schedule_id}~1subscriptions~1{subscription_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/getsubscription' + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/listsubscriptions' + insert: + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/createsubscription' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_subscriptions/methods/deletesubscription' + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml b/providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml new file mode 100644 index 00000000..b80f95ec --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/machinelearning.yaml @@ -0,0 +1,4891 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Machinelearning API + description: Machinelearning +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/mlflow/experiments/create: + post: + operationId: experiments-createexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/createexperiment + x-stackQL-resource: experiments + x-stackQL-method: createexperiment + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + artifact_location: + type: string + tags: + type: Array of object + example: + name: string + artifact_location: string + tags: + - key: string + value: string + description: Creates an experiment with a name. Returns the ID of the newly + created experiment. Validates that another experiment with the same name does + not already exist and fails if another experiment with the same name already + exists. + /api/2.0/mlflow/experiments/delete: + post: + operationId: experiments-deleteexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deleteexperiment + x-stackQL-resource: experiments + x-stackQL-method: deleteexperiment + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + example: + experiment_id: string + description: Marks an experiment and associated metadata, runs, metrics, params, + and tags for deletion. If the experiment uses FileStore, artifacts associated + with experiment are also deleted. + /api/2.0/mlflow/experiments/get-by-name: + get: + operationId: experiments-getbyname + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getbyname + x-stackQL-resource: experiments + x-stackQL-method: getbyname + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_name + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiment: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiment + description: Gets metadata for an experiment. + /api/2.0/mlflow/experiments/get: + get: + operationId: experiments-getexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getexperiment + x-stackQL-resource: experiments + x-stackQL-method: getexperiment + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiment: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiment + description: Gets metadata for an experiment. This method works on deleted experiments. + /api/2.0/mlflow/experiments/list: + get: + operationId: experiments-listexperiments + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/listexperiments + x-stackQL-resource: experiments + x-stackQL-method: listexperiments + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: view_type + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiments: + type: array + items: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiments + description: Gets a list of all experiments. + /api/2.0/mlflow/experiments/restore: + post: + operationId: experiments-restoreexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/restoreexperiment + x-stackQL-resource: experiments + x-stackQL-method: restoreexperiment + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + example: + experiment_id: string + description: Restore an experiment marked for deletion. This also restores associated + metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying + artifacts associated with experiment are also restored. + /api/2.0/mlflow/experiments/search: + post: + operationId: experiments-searchexperiments + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/searchexperiments + x-stackQL-resource: experiments + x-stackQL-method: searchexperiments + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + experiments: + type: array + items: + type: object + properties: + experiment_id: + type: string + name: + type: string + artifact_location: + type: string + lifecycle_stage: + type: string + last_update_time: + type: integer + creation_time: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.experiments + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + max_results: + type: integer + format: int64 + page_token: + type: string + filter: + type: string + order_by: + type: Array of string + view_type: + type: string + example: + max_results: 0 + page_token: string + filter: string + order_by: + - string + view_type: ACTIVE_ONLY + description: Searches for experiments that satisfy specified search criteria. + /api/2.0/mlflow/experiments/update: + post: + operationId: experiments-updateexperiment + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/updateexperiment + x-stackQL-resource: experiments + x-stackQL-method: updateexperiment + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + new_name: + type: string + example: + experiment_id: string + new_name: string + description: Updates experiment metadata. + /api/2.0/mlflow/metrics/get-history: + get: + operationId: experiments-history-gethistory + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/gethistory + x-stackQL-resource: experiments_history + x-stackQL-method: gethistory + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + in: query + - name: run_uuid + in: query + - name: metric_key + required: true + description: string + in: query + - name: page_token + in: query + - name: max_results + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.metrics + description: Gets a list of all values for the specified metric for a given + run. + /api/2.0/mlflow/artifacts/list: + get: + operationId: experiment-artifacts-listartifacts + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/listartifacts + x-stackQL-resource: experiment_artifacts + x-stackQL-method: listartifacts + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: run_id + in: query + - name: run_uuid + in: query + - name: path + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + root_uri: + type: string + files: + type: array + items: + type: object + properties: + path: + type: string + is_dir: + type: boolean + file_size: + type: integer + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: List artifacts for a run. Takes an optional + /api/2.0/permissions/experiments/{experiment_id}: + get: + operationId: experiment-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getpermissions + x-stackQL-resource: experiment_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of an experiment. Experiments can inherit + permissions from their root object. + put: + operationId: experiment-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/setpermissions + x-stackQL-resource: experiment_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: experiment-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/updatepermissions + x-stackQL-resource: experiment_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on an experiment. Experiments can inherit + permissions from their root object. + /api/2.0/permissions/experiments/{experiment_id}/permissionLevels: + get: + operationId: experiment-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getpermissionlevels + x-stackQL-resource: experiment_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: experiment_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/mlflow/runs/create: + post: + operationId: experiment-runs-createrun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/createrun + x-stackQL-resource: experiment_runs + x-stackQL-method: createrun + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + run: + type: object + properties: + info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + data: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + params: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + inputs: + type: object + properties: + dataset_inputs: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + dataset: + type: object + properties: + name: + type: string + digest: + type: string + source_type: + type: string + source: + type: string + schema: + type: string + profile: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: string + user_id: + type: string + start_time: + type: integer + format: int64 + tags: + type: Array of object + example: + experiment_id: string + user_id: string + start_time: 0 + tags: + - key: string + value: string + description: Creates a new run within an experiment. A run is usually a single + execution of a machine learning or data ETL pipeline. MLflow uses runs to + track the + /api/2.0/mlflow/runs/delete: + post: + operationId: experiment-runs-deleterun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deleterun + x-stackQL-resource: experiment_runs + x-stackQL-method: deleterun + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: string + description: Marks a run for deletion. + /api/2.0/mlflow/databricks/runs/delete-runs: + post: + operationId: experiment-runs-deleteruns + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deleteruns + x-stackQL-resource: experiment_runs + x-stackQL-method: deleteruns + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + runs_deleted: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + max_timestamp_millis: + type: string + max_runs: + type: required + example: + experiment_id: string + max_timestamp_millis: 0 + max_runs: '10000' + description: Bulk delete runs in an experiment that were created prior to or + at the specified timestamp. Deletes at most max_runs per request. To call + this API from a Databricks Notebook in Python, you can use the client code + snippet on + /api/2.0/mlflow/runs/get: + get: + operationId: experiment-runs-getrun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/getrun + x-stackQL-resource: experiment_runs + x-stackQL-method: getrun + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: string + in: query + - name: run_uuid + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + run: + type: object + properties: + info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + data: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + params: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + inputs: + type: object + properties: + dataset_inputs: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + dataset: + type: object + properties: + name: + type: string + digest: + type: string + source_type: + type: string + source: + type: string + schema: + type: string + profile: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.run + description: Gets the metadata, metrics, params, and tags for a run. In the + case where multiple metrics with the same key are logged for a run, return + only the value with the latest timestamp. + /api/2.0/mlflow/runs/log-batch: + post: + operationId: experiment-runs-logbatch + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logbatch + x-stackQL-resource: experiment_runs + x-stackQL-method: logbatch + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + metrics: + type: Array of object + params: + type: Array of object + tags: + type: Array of object + example: + run_id: 2a14ed5c6a87499199e0106c3501eab8 + metrics: + - key: mae + value: 2.5 + timestamp: 1552550804 + - key: rmse + value: 2.7 + timestamp: 1552550804 + params: + - key: model_class + value: LogisticRegression + description: Logs a batch of metrics, params, and tags for a run. If any data + failed to be persisted, the server will respond with an error (non-200 status + code). + /api/2.0/mlflow/runs/log-inputs: + post: + operationId: experiment-runs-loginputs + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/loginputs + x-stackQL-resource: experiment_runs + x-stackQL-method: loginputs + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + datasets: + type: Array of object + example: + run_id: string + datasets: + - tags: + - key: string + value: string + dataset: + name: string + digest: string + source_type: string + source: string + schema: string + profile: string + description: 'Experimental: This API may change or be removed in a future release + without warning.' + /api/2.0/mlflow/runs/log-metric: + post: + operationId: experiment-runs-logmetric + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logmetric + x-stackQL-resource: experiment_runs + x-stackQL-method: logmetric + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + key: + type: required + value: + type: string + timestamp: + type: required + step: + type: double + example: + run_id: string + run_uuid: string + key: string + value: 0.1 + timestamp: 0 + step: '0' + description: Logs a metric for a run. A metric is a key-value pair (string key, + float value) with an associated timestamp. Examples include the various metrics + that represent ML model accuracy. A metric can be logged multiple times. + /api/2.0/mlflow/runs/log-model: + post: + operationId: experiment-runs-logmodel + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logmodel + x-stackQL-resource: experiment_runs + x-stackQL-method: logmodel + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + model_json: + type: string + example: + run_id: string + model_json: string + description: 'Experimental: This API may change or be removed in a future release + without warning.' + /api/2.0/mlflow/runs/log-parameter: + post: + operationId: experiment-runs-logparam + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/logparam + x-stackQL-resource: experiment_runs + x-stackQL-method: logparam + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + key: + type: required + value: + type: string + example: + run_id: string + run_uuid: string + key: string + value: string + description: Logs a param used for a run. A param is a key-value pair (string + key, string value). Examples include hyperparameters used for ML model training + and constant dates and values used in an ETL pipeline. A param can be logged + only once for a run. + /api/2.0/mlflow/runs/restore: + post: + operationId: experiment-runs-restorerun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/restorerun + x-stackQL-resource: experiment_runs + x-stackQL-method: restorerun + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: string + description: Restores a deleted run. + /api/2.0/mlflow/databricks/runs/restore-runs: + post: + operationId: experiment-runs-restoreruns + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/restoreruns + x-stackQL-resource: experiment_runs + x-stackQL-method: restoreruns + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + runs_restored: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + min_timestamp_millis: + type: string + max_runs: + type: required + example: + experiment_id: string + min_timestamp_millis: 0 + max_runs: '10000' + description: Bulk restore runs in an experiment that were deleted no earlier + than the specified timestamp. Restores at most max_runs per request. To call + this API from a Databricks Notebook in Python, you can use the client code + snippet on + /api/2.0/mlflow/runs/search: + post: + operationId: experiment-runs-searchruns + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/searchruns + x-stackQL-resource: experiment_runs + x-stackQL-method: searchruns + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + runs: + type: array + items: + type: object + properties: + info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + data: + type: object + properties: + metrics: + type: array + items: + type: object + properties: + key: + type: string + value: + type: number + timestamp: + type: integer + step: + type: string + params: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + inputs: + type: object + properties: + dataset_inputs: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + dataset: + type: object + properties: + name: + type: string + digest: + type: string + source_type: + type: string + source: + type: string + schema: + type: string + profile: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.runs + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_ids: + type: Array of string + filter: + type: string + run_view_type: + type: string + max_results: + type: int32 + order_by: + type: Array of string + page_token: + type: string + example: + experiment_ids: + - string + filter: string + run_view_type: ACTIVE_ONLY + max_results: '1000' + order_by: + - string + page_token: string + description: Searches for runs that satisfy expressions. + /api/2.0/mlflow/runs/update: + post: + operationId: experiment-runs-updaterun + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/updaterun + x-stackQL-resource: experiment_runs + x-stackQL-method: updaterun + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + run_info: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + experiment_id: + type: string + user_id: + type: string + status: + type: string + start_time: + type: integer + end_time: + type: integer + artifact_uri: + type: string + lifecycle_stage: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + status: + type: string + end_time: + type: integer + format: int64 + example: + run_id: string + run_uuid: string + status: RUNNING + end_time: 0 + description: Updates run metadata. + /api/2.0/mlflow/runs/set-tag: + post: + operationId: experiment-run-tags-settag + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/settag + x-stackQL-resource: experiment_run_tags + x-stackQL-method: settag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + run_uuid: + type: string + key: + type: required + value: + type: string + example: + run_id: string + run_uuid: string + key: string + value: string + description: Sets a tag on a run. Tags are run metadata that can be updated + during a run and after a run completes. + /api/2.0/mlflow/runs/delete-tag: + post: + operationId: experiment-tags-deletetag + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/deletetag + x-stackQL-resource: experiment_tags + x-stackQL-method: deletetag + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + key: + type: string + example: + run_id: string + key: string + description: Deletes a tag on a run. Tags are run metadata that can be updated + during a run and after a run completes. + /api/2.0/mlflow/experiments/set-experiment-tag: + post: + operationId: experiment-tags-setexperimenttag + externalDocs: + url: https://docs.databricks.com/api/workspace/experiments/setexperimenttag + x-stackQL-resource: experiment_tags + x-stackQL-method: setexperimenttag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + experiment_id: + type: required + key: + type: string + value: + type: required + example: + experiment_id: string + key: string + value: string + description: Sets a tag on an experiment. Experiment tags are metadata that + can be updated. + /api/2.0/mlflow/registered-models/create: + post: + operationId: models-createmodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createmodel + x-stackQL-resource: models + x-stackQL-method: createmodel + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_model: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + tags: + type: Array of object + example: + name: string + tags: + - key: string + value: string + description: string + description: Creates a new registered model with the name specified in the request + body. + /api/2.0/mlflow/registered-models/delete: + delete: + operationId: models-deletemodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodel + x-stackQL-resource: models + x-stackQL-method: deletemodel + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a registered model. + /api/2.0/mlflow/databricks/registered-models/get: + get: + operationId: models-getmodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getmodel + x-stackQL-resource: models + x-stackQL-method: getmodel + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: query + responses: + '200': + description: Model details were returned successfully. + content: + application/json: + schema: + type: object + properties: + registered_model_databricks: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + id: + type: string + permission_level: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get the details of a model. This is a Databricks workspace version + of the + /api/2.0/mlflow/registered-models/list: + get: + operationId: models-listmodels + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/listmodels + x-stackQL-resource: models + x-stackQL-method: listmodels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_models: + type: array + items: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.registered_models + description: Lists all available registered models, up to the limit specified + in + /api/2.0/mlflow/registered-models/rename: + post: + operationId: models-renamemodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/renamemodel + x-stackQL-resource: models + x-stackQL-method: renamemodel + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_model: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + new_name: + type: string + example: + name: string + new_name: string + description: Renames a registered model. + /api/2.0/mlflow/registered-models/search: + get: + operationId: models-searchmodels + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/searchmodels + x-stackQL-resource: models + x-stackQL-method: searchmodels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: max_results + in: query + - name: order_by + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + registered_models: + type: array + items: + type: object + properties: + name: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + description: + type: string + latest_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.registered_models + description: Search for registered models based on the specified + /api/2.0/mlflow/registered-models/update: + patch: + operationId: models-updatemodel + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatemodel + x-stackQL-resource: models + x-stackQL-method: updatemodel + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + description: + type: string + example: + name: string + description: string + description: Updates a registered model. + /api/2.0/mlflow/registered-models/get-latest-versions: + post: + operationId: model-latest-versions-getlatestversions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getlatestversions + x-stackQL-resource: model_latest_versions + x-stackQL-method: getlatestversions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + x-stackQL-objectKey: $.model_versions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + stages: + type: string + example: + name: string + stages: + - string + description: Gets the latest version of a registered model. + /api/2.0/permissions/registered-models/{registered_model_id}: + get: + operationId: model-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getpermissions + x-stackQL-resource: model_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a registered model. Registered models can + inherit permissions from their root object. + put: + operationId: model-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/setpermissions + x-stackQL-resource: model_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: model-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatepermissions + x-stackQL-resource: model_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a registered model. Registered models + can inherit permissions from their root object. + /api/2.0/permissions/registered-models/{registered_model_id}/permissionLevels: + get: + operationId: model-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getpermissionlevels + x-stackQL-resource: model_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: registered_model_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/mlflow/registered-models/delete-tag: + delete: + operationId: model-tags-deletemodeltag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodeltag + x-stackQL-resource: model_tags + x-stackQL-method: deletemodeltag + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: key + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the tag for a registered model. + /api/2.0/mlflow/registered-models/set-tag: + post: + operationId: model-tags-setmodeltag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/setmodeltag + x-stackQL-resource: model_tags + x-stackQL-method: setmodeltag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + key: + type: string + value: + type: required + example: + name: string + key: string + value: string + description: Sets a tag on a registered model. + /api/2.0/mlflow/transition-requests/approve: + post: + operationId: model-transition-requests-approvetransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/approvetransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: approvetransitionrequest + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Model version's stage was updated successfully. + content: + application/json: + schema: + type: object + properties: + activity: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + activity_type: + type: string + from_stage: + type: string + to_stage: + type: string + comment: + type: string + system_comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + archive_existing_versions: + type: string + comment: + type: required + example: + name: search_ads_model + version: '1' + stage: Staging + archive_existing_versions: true + comment: This version is great! + description: Details required to identify and approve a model version stage + transition request. + description: Approves a model version stage transition request. + /api/2.0/mlflow/transition-requests/create: + post: + operationId: model-transition-requests-createtransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createtransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: createtransitionrequest + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Transition request was made successfully. + content: + application/json: + schema: + type: object + properties: + request: + type: object + properties: + creation_timestamp: + type: integer + to_stage: + type: string + user_id: + type: string + comment: + type: string + available_actions: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + comment: + type: string + example: + name: search_ads_model + version: '1' + stage: Staging + comment: This version is great! + description: Details required to create a model version stage transition request. + description: Creates a model version stage transition request. + /api/2.0/mlflow/transition-requests/delete: + delete: + operationId: model-transition-requests-deletetransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletetransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: deletetransitionrequest + x-stackQL-verb: delete + x-numReqParams: 4 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + - name: stage + required: true + description: string + in: query + - name: creator + required: true + description: email + in: query + - name: comment + in: query + responses: + '200': + description: Transition request was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Cancels a model version stage transition request. + /api/2.0/mlflow/transition-requests/list: + get: + operationId: model-transition-requests-listtransitionrequests + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/listtransitionrequests + x-stackQL-resource: model_transition_requests + x-stackQL-method: listtransitionrequests + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: Fetched all open requests successfully. + content: + application/json: + schema: + type: object + properties: + requests: + type: array + items: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + activity_type: + type: string + from_stage: + type: string + to_stage: + type: string + comment: + type: string + system_comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.requests + description: Gets a list of all open stage transition requests for the model + version. + /api/2.0/mlflow/transition-requests/reject: + post: + operationId: model-transition-requests-rejecttransitionrequest + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/rejecttransitionrequest + x-stackQL-resource: model_transition_requests + x-stackQL-method: rejecttransitionrequest + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Transition request was rejected successfully. + content: + application/json: + schema: + type: object + properties: + activity: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + activity_type: + type: string + from_stage: + type: string + to_stage: + type: string + comment: + type: string + system_comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + comment: + type: string + example: + name: search_ads_model + version: '1' + stage: Staging + comment: This version is great! + description: Details required to identify and reject a model version stage + transition request. + description: Rejects a model version stage transition request. + /api/2.0/mlflow/databricks/model-versions/transition-stage: + post: + operationId: model-transition-requests-transitionstage + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/transitionstage + x-stackQL-resource: model_transition_requests + x-stackQL-method: transitionstage + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Model version's stage was updated successfully. + content: + application/json: + schema: + type: object + properties: + model_version: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + permission_level: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + stage: + type: required + archive_existing_versions: + type: string + comment: + type: required + example: + name: search_ads_model + version: '1' + stage: Staging + archive_existing_versions: true + comment: This version is great! + description: Details required to transition a model version's stage. + description: Transition a model version's stage. This is a Databricks workspace + version of the + /api/2.0/mlflow/model-versions/create: + post: + operationId: model-versions-createmodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createmodelversion + x-stackQL-resource: model_versions + x-stackQL-method: createmodelversion + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_version: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + source: + type: string + run_id: + type: required + run_link: + type: string + description: + type: string + tags: + type: Array of object + example: + name: string + source: string + run_id: string + tags: + - key: string + value: string + run_link: string + description: string + description: Creates a model version. + /api/2.0/mlflow/model-versions/delete: + delete: + operationId: model-versions-deletemodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodelversion + x-stackQL-resource: model_versions + x-stackQL-method: deletemodelversion + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a model version. + /api/2.0/mlflow/model-versions/get: + get: + operationId: model-versions-getmodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getmodelversion + x-stackQL-resource: model_versions + x-stackQL-method: getmodelversion + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_version: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + x-stackQL-objectKey: $.model_version + description: Get a model version. + /api/2.0/mlflow/model-versions/search: + get: + operationId: model-versions-searchmodelversions + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/searchmodelversions + x-stackQL-resource: model_versions + x-stackQL-method: searchmodelversions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: filter + in: query + - name: max_results + in: query + - name: order_by + in: query + - name: page_token + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + model_versions: + type: array + items: + type: object + properties: + name: + type: string + version: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + current_stage: + type: string + description: + type: string + source: + type: string + run_id: + type: string + status: + type: string + status_message: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + run_link: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.model_versions + description: Searches for specific model versions based on the supplied + /api/2.0/mlflow/model-versions/update: + patch: + operationId: model-versions-updatemodelversion + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatemodelversion + x-stackQL-resource: model_versions + x-stackQL-method: updatemodelversion + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + description: + type: required + example: + name: string + version: string + description: string + description: Updates the model version. + /api/2.0/mlflow/comments/create: + post: + operationId: model-version-comments-createcomment + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createcomment + x-stackQL-resource: model_version_comments + x-stackQL-method: createcomment + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Comment was made successfully. + content: + application/json: + schema: + type: object + properties: + comment: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + comment: + type: string + available_actions: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + comment: + type: required + example: + name: search_ads_model + version: '1' + comment: This version is great! + description: Details required to create a comment on a model version. + description: Posts a comment on a model version. A comment can be submitted + either by a user or programmatically to display relevant information about + the model. For example, test results or deployment errors. + /api/2.0/mlflow/comments/delete: + delete: + operationId: model-version-comments-deletecomment + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletecomment + x-stackQL-resource: model_version_comments + x-stackQL-method: deletecomment + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: uuid + in: query + responses: + '200': + description: Comment was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a comment on a model version. + /api/2.0/mlflow/comments/update: + patch: + operationId: model-version-comments-updatecomment + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatecomment + x-stackQL-resource: model_version_comments + x-stackQL-method: updatecomment + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Comment was updated successfully. + content: + application/json: + schema: + type: object + properties: + comment: + type: object + properties: + id: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + user_id: + type: string + comment: + type: string + available_actions: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: required + comment: + type: uuid + example: + id: 6fc74c92704341aaa49e74dcc6031057 + comment: This version is great! + description: Details required to edit a comment on a model version. + description: Post an edit to a comment on a model version. + /api/2.0/mlflow/model-versions/get-download-uri: + get: + operationId: model-version-download-urls-getmodelversiondownloaduri + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/getmodelversiondownloaduri + x-stackQL-resource: model_version_download_urls + x-stackQL-method: getmodelversiondownloaduri + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + artifact_uri: + type: string + description: Gets a URI to download the model version. + /api/2.0/mlflow/model-versions/delete-tag: + delete: + operationId: model-version-tags-deletemodelversiontag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletemodelversiontag + x-stackQL-resource: model_version_tags + x-stackQL-method: deletemodelversiontag + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: name + required: true + description: string + in: query + - name: version + required: true + description: string + in: query + - name: key + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a model version tag. + /api/2.0/mlflow/model-versions/set-tag: + post: + operationId: model-version-tags-setmodelversiontag + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/setmodelversiontag + x-stackQL-resource: model_version_tags + x-stackQL-method: setmodelversiontag + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + version: + type: string + key: + type: required + value: + type: string + example: + name: string + version: string + key: string + value: string + description: Sets a model version tag. + /api/2.0/mlflow/registry-webhooks/create: + post: + operationId: model-web-hooks-createwebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/createwebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: createwebhook + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Registry webhook was created successfully. + content: + application/json: + schema: + type: object + properties: + webhook: + type: object + properties: + id: + type: string + events: + type: array + items: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + description: + type: string + status: + type: string + http_url_spec: + type: object + properties: + url: + type: string + enable_ssl_verification: + type: boolean + model_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + events: + type: required + model_name: + type: Array of string + description: + type: string + status: + type: string + job_spec: + type: object + http_url_spec: + type: object + example: + job_spec: + job_id: '1' + access_token: dapi12345678935845824 + workspace_url: string + http_url_spec: + url: https://hooks.slack.com/services/... + secret: anyRandomString + enable_ssl_verification: true + authorization: Bearer + events: + - MODEL_VERSION_CREATED + - MODEL_VERSION_TRANSITIONED_TO_STAGING + - COMMENT_CREATED + model_name: registered-model-1 + description: Webhook for comment creation + status: ACTIVE + description: Details required to create a registry webhook. + description: ': This endpoint is in Public Preview.' + /api/2.0/mlflow/registry-webhooks/delete: + delete: + operationId: model-web-hooks-deletewebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/deletewebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: deletewebhook + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: id + in: query + responses: + '200': + description: Registry webhook was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: This endpoint is in Public Preview. + /api/2.0/mlflow/registry-webhooks/list: + get: + operationId: model-web-hooks-listwebhooks + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/listwebhooks + x-stackQL-resource: model_web_hooks + x-stackQL-method: listwebhooks + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: model_name + in: query + - name: events + in: query + - name: page_token + in: query + responses: + '200': + description: Registry webhooks listed successfully. + content: + application/json: + schema: + type: object + properties: + webhooks: + type: array + items: + type: object + properties: + id: + type: string + events: + type: array + items: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + description: + type: string + status: + type: string + http_url_spec: + type: object + properties: + url: + type: string + enable_ssl_verification: + type: boolean + model_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.webhooks + description: This endpoint is in Public Preview. + /api/2.0/mlflow/registry-webhooks/test: + post: + operationId: model-web-hooks-testregistrywebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/testregistrywebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: testregistrywebhook + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Registry webhook was tested successfully. + content: + application/json: + schema: + type: object + properties: + webhook: + type: object + properties: + status_code: + type: integer + body: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: required + event: + type: string + example: + id: '124323' + event: MODEL_VERSION_CREATED + description: Details required to test a registry webhook. + description: This endpoint is in Public Preview. + /api/2.0/mlflow/registry-webhooks/update: + patch: + operationId: model-web-hooks-updatewebhook + externalDocs: + url: https://docs.databricks.com/api/workspace/modelregistry/updatewebhook + x-stackQL-resource: model_web_hooks + x-stackQL-method: updatewebhook + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Registry webhook was updated successfully. + content: + application/json: + schema: + type: object + properties: + webhook: + type: object + properties: + id: + type: string + events: + type: array + items: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + description: + type: string + status: + type: string + http_url_spec: + type: object + properties: + url: + type: string + enable_ssl_verification: + type: boolean + model_name: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + id: + type: required + events: + type: string + description: + type: Array of string + status: + type: string + http_url_spec: + type: object + job_spec: + type: object + example: + id: '124323' + status: DISABLED + description: Details required to update a registry webhook. Only the fields + that need to be updated should be specified, and both + description: This endpoint is in Public Preview. +components: + x-stackQL-resources: + experiments: + id: databricks_workspace.machinelearning.experiments + name: experiments + title: Experiments + methods: + createexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleteexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getbyname: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1get-by-name/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiment + getexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiment + listexperiments: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiments + restoreexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1restore/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + searchexperiments: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1search/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.experiments + updateexperiment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiments/methods/searchexperiments' + - $ref: '#/components/x-stackQL-resources/experiments/methods/listexperiments' + - $ref: '#/components/x-stackQL-resources/experiments/methods/getexperiment' + - $ref: '#/components/x-stackQL-resources/experiments/methods/getbyname' + insert: + - $ref: '#/components/x-stackQL-resources/experiments/methods/createexperiment' + update: + - $ref: '#/components/x-stackQL-resources/experiments/methods/updateexperiment' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/experiments/methods/deleteexperiment' + exec: + - $ref: '#/components/x-stackQL-resources/experiments/methods/restoreexperiment' + experiments_history: + id: databricks_workspace.machinelearning.experiments_history + name: experiments_history + title: Experiments_history + methods: + gethistory: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1metrics~1get-history/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metrics + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiments_history/methods/gethistory' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + experiment_artifacts: + id: databricks_workspace.machinelearning.experiment_artifacts + name: experiment_artifacts + title: Experiment_artifacts + methods: + listartifacts: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1artifacts~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_artifacts/methods/listartifacts' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + experiment_permissions: + id: databricks_workspace.machinelearning.experiment_permissions + name: experiment_permissions + title: Experiment_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/experiment_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/experiment_permissions/methods/setpermissions' + delete: [] + exec: [] + experiment_permission_levels: + id: databricks_workspace.machinelearning.experiment_permission_levels + name: experiment_permission_levels + title: Experiment_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1experiments~1{experiment_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + experiment_runs: + id: databricks_workspace.machinelearning.experiment_runs + name: experiment_runs + title: Experiment_runs + methods: + createrun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleterun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleteruns: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1runs~1delete-runs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getrun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.run + logbatch: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-batch/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + loginputs: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-inputs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + logmetric: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-metric/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + logmodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-model/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + logparam: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1log-parameter/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restorerun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1restore/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + restoreruns: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1runs~1restore-runs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + searchruns: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1search/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + updaterun: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/searchruns' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/getrun' + insert: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/createrun' + update: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/updaterun' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/deleteruns' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/deleterun' + exec: + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/restoreruns' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/restorerun' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logparam' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logmodel' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logmetric' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/loginputs' + - $ref: '#/components/x-stackQL-resources/experiment_runs/methods/logbatch' + experiment_run_tags: + id: databricks_workspace.machinelearning.experiment_run_tags + name: experiment_run_tags + title: Experiment_run_tags + methods: + settag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1set-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/experiment_run_tags/methods/settag' + delete: [] + exec: [] + experiment_tags: + id: databricks_workspace.machinelearning.experiment_tags + name: experiment_tags + title: Experiment_tags + methods: + deletetag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1runs~1delete-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setexperimenttag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1set-experiment-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/experiment_tags/methods/setexperimenttag' + delete: + - $ref: '#/components/x-stackQL-resources/experiment_tags/methods/deletetag' + exec: [] + models: + id: databricks_workspace.machinelearning.models + name: models + title: Models + methods: + createmodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletemodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getmodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1registered-models~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listmodels: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.registered_models + renamemodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1rename/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + searchmodels: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1search/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.registered_models + updatemodel: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/models/methods/searchmodels' + - $ref: '#/components/x-stackQL-resources/models/methods/listmodels' + - $ref: '#/components/x-stackQL-resources/models/methods/getmodel' + insert: + - $ref: '#/components/x-stackQL-resources/models/methods/createmodel' + update: + - $ref: '#/components/x-stackQL-resources/models/methods/updatemodel' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/deletemodel' + exec: + - $ref: '#/components/x-stackQL-resources/models/methods/renamemodel' + model_latest_versions: + id: databricks_workspace.machinelearning.model_latest_versions + name: model_latest_versions + title: Model_latest_versions + methods: + getlatestversions: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1get-latest-versions/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_versions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_latest_versions/methods/getlatestversions' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_permissions: + id: databricks_workspace.machinelearning.model_permissions + name: model_permissions + title: Model_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/model_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/model_permissions/methods/setpermissions' + delete: [] + exec: [] + model_permission_levels: + id: databricks_workspace.machinelearning.model_permission_levels + name: model_permission_levels + title: Model_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1registered-models~1{registered_model_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_tags: + id: databricks_workspace.machinelearning.model_tags + name: model_tags + title: Model_tags + methods: + deletemodeltag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1delete-tag/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setmodeltag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registered-models~1set-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/model_tags/methods/setmodeltag' + delete: + - $ref: '#/components/x-stackQL-resources/model_tags/methods/deletemodeltag' + exec: [] + model_transition_requests: + id: databricks_workspace.machinelearning.model_transition_requests + name: model_transition_requests + title: Model_transition_requests + methods: + approvetransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1approve/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + createtransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletetransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listtransitionrequests: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.requests + rejecttransitionrequest: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1transition-requests~1reject/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + transitionstage: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1databricks~1model-versions~1transition-stage/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/listtransitionrequests' + insert: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/createtransitionrequest' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/deletetransitionrequest' + exec: + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/transitionstage' + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/rejecttransitionrequest' + - $ref: '#/components/x-stackQL-resources/model_transition_requests/methods/approvetransitionrequest' + model_versions: + id: databricks_workspace.machinelearning.model_versions + name: model_versions + title: Model_versions + methods: + createmodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletemodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getmodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_version + searchmodelversions: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1search/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_versions + updatemodelversion: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/searchmodelversions' + - $ref: '#/components/x-stackQL-resources/model_versions/methods/getmodelversion' + insert: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/createmodelversion' + update: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/updatemodelversion' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/deletemodelversion' + exec: [] + model_version_comments: + id: databricks_workspace.machinelearning.model_version_comments + name: model_version_comments + title: Model_version_comments + methods: + createcomment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1comments~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletecomment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1comments~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatecomment: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1comments~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/model_version_comments/methods/createcomment' + update: + - $ref: '#/components/x-stackQL-resources/model_version_comments/methods/updatecomment' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_version_comments/methods/deletecomment' + exec: [] + model_version_download_urls: + id: databricks_workspace.machinelearning.model_version_download_urls + name: model_version_download_urls + title: Model_version_download_urls + methods: + getmodelversiondownloaduri: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1get-download-uri/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_version_download_urls/methods/getmodelversiondownloaduri' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_version_tags: + id: databricks_workspace.machinelearning.model_version_tags + name: model_version_tags + title: Model_version_tags + methods: + deletemodelversiontag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1delete-tag/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setmodelversiontag: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1model-versions~1set-tag/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/model_version_tags/methods/setmodelversiontag' + delete: + - $ref: '#/components/x-stackQL-resources/model_version_tags/methods/deletemodelversiontag' + exec: [] + model_web_hooks: + id: databricks_workspace.machinelearning.model_web_hooks + name: model_web_hooks + title: Model_web_hooks + methods: + createwebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletewebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1delete/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listwebhooks: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.webhooks + testregistrywebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1test/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatewebhook: + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1registry-webhooks~1update/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/listwebhooks' + insert: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/createwebhook' + update: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/updatewebhook' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/deletewebhook' + exec: + - $ref: '#/components/x-stackQL-resources/model_web_hooks/methods/testregistrywebhook' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml new file mode 100644 index 00000000..9ddf0000 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml @@ -0,0 +1,4531 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Marketplace API + description: Marketplace +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.1/marketplace-consumer/listings/{listing_id}/fulfillments: + get: + operationId: consumer-fulfillments-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerfulfillments/list + x-stackQL-resource: consumer_fulfillments + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + fulfillments: + type: array + items: + type: object + properties: + listing_id: + type: string + fulfillment_type: + type: string + share_info: + type: object + properties: + name: + type: string + type: + type: string + repo_info: + type: object + properties: + git_repo_url: + type: string + recipient_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.fulfillments + description: Get all listings fulfillments associated with a listing. A + /api/2.1/marketplace-consumer/listings/{listing_id}/installations: + post: + operationId: consumer-installations-create + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/create + x-stackQL-resource: consumer_installations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installation: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + share_name: + type: string + catalog_name: + type: string + recipient_type: + type: string + repo_detail: + type: object + accepted_consumer_terms: + type: object + example: + share_name: string + catalog_name: string + repo_detail: + repo_name: string + repo_path: string + recipient_type: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + accepted_consumer_terms: + version: string + description: Install payload associated with a Databricks Marketplace listing. + get: + operationId: listing-installations-listlistinginstallations + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/listlistinginstallations + x-stackQL-resource: listing_installations + x-stackQL-method: listlistinginstallations + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installations: + type: array + items: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.installations + description: List all installations for a particular listing. + /api/2.1/marketplace-consumer/listings/{listing_id}/installations/{installation_id}: + delete: + operationId: consumer-installations-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/delete + x-stackQL-resource: consumer_installations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: installation_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Uninstall an installation associated with a Databricks Marketplace + listing. + put: + operationId: consumer-installations-update + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/update + x-stackQL-resource: consumer_installations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: installation_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installation: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + rotate_token: + type: boolean + installation: + type: required + example: + installation: + id: string + listing_id: string + share_name: string + catalog_name: string + installed_on: 0 + status: INSTALLED + error_message: string + listing_name: string + repo_name: string + repo_path: string + recipient_type: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + tokens: + - id: string + created_at: 0 + created_by: string + activation_url: string + expiration_time: 0 + updated_at: 0 + updated_by: string + token_detail: + shareCredentialsVersion: 0 + bearerToken: string + endpoint: string + expirationTime: string + rotate_token: true + description: This is a update API that will update the part of the fields defined + in the installation table as well as interact with external services according + to the fields not included in the installation table + /api/2.1/marketplace-consumer/installations: + get: + operationId: consumer-installations-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerinstallations/list + x-stackQL-resource: consumer_installations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + installations: + type: array + items: + type: object + properties: + id: + type: string + listing_id: + type: string + share_name: + type: string + catalog_name: + type: string + installed_on: + type: integer + status: + type: string + error_message: + type: string + listing_name: + type: string + repo_name: + type: string + repo_path: + type: string + recipient_type: + type: string + tokens: + type: array + items: + type: object + properties: + id: + type: string + created_at: + type: integer + created_by: + type: string + activation_url: + type: string + expiration_time: + type: integer + updated_at: + type: integer + updated_by: + type: string + token_detail: + type: object + properties: + shareCredentialsVersion: + type: integer + bearerToken: + type: string + endpoint: + type: string + expirationTime: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.installations + description: List all installations across all listings. + /api/2.1/marketplace-consumer/listings:batchGet: + get: + operationId: consumer-listings-batchget + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/batchget + x-stackQL-resource: consumer_listings + x-stackQL-method: batchget + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: + - name: ids + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + description: Batch get a published listing in the Databricks Marketplace that + the consumer has access to. + /api/2.1/marketplace-consumer/listings/{id}: + get: + operationId: consumer-listings-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/get + x-stackQL-resource: consumer_listings + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + x-stackQL-objectKey: $.listing + description: Get a published listing in the Databricks Marketplace that the + consumer has access to. + /api/2.1/marketplace-consumer/listings: + get: + operationId: consumer-listings-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/list + x-stackQL-resource: consumer_listings + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + - name: assets + in: query + - name: categories + in: query + - name: null + in: query + - name: is_free + in: query + - name: is_private_exchange + in: query + - name: is_staff_pick + in: query + - name: provider_ids + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.listings + description: List all published listings in the Databricks Marketplace that + the consumer has access to. + /api/2.1/marketplace-consumer/search-listings: + get: + operationId: consumer-listings-search + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerlistings/search + x-stackQL-resource: consumer_listings + x-stackQL-method: search + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: query + required: true + description: string + in: query + - name: is_free + in: query + - name: is_private_exchange + in: query + - name: provider_ids + in: query + - name: categories + in: query + - name: assets + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.listings + description: Search published listings in the Databricks Marketplace that the + consumer has access to. This query supports a variety of different search + parameters and performs fuzzy matching. + /api/2.1/marketplace-consumer/listings/{listing_id}/content: + get: + operationId: consumer-listing-content-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerfulfillments/get + x-stackQL-resource: consumer_listing_content + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + shared_data_objects: + type: array + items: + type: object + properties: + name: + type: string + data_object_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.shared_data_objects + description: Get a high level preview of the metadata of listing installable + content. + /api/2.1/marketplace-consumer/listings/{listing_id}/personalization-requests: + post: + operationId: consumer-personalization-requests-create + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/create + x-stackQL-resource: consumer_personalization_requests + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + intended_use: + type: required + first_name: + type: string + last_name: + type: string + company: + type: string + is_from_lighthouse: + type: string + recipient_type: + type: boolean + accepted_consumer_terms: + type: object + example: + comment: string + intended_use: string + first_name: string + last_name: string + company: string + is_from_lighthouse: true + recipient_type: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + accepted_consumer_terms: + version: string + description: Data request messages also creates a lead (maybe) + description: Create a personalization request for a listing. + get: + operationId: consumer-personalization-requests-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/get + x-stackQL-resource: consumer_personalization_requests + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + personalization_requests: + type: array + items: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + x-stackQL-objectKey: $.personalization_requests + description: Get the personalization request for a listing. Each consumer can + make at + /api/2.1/marketplace-consumer/personalization-requests: + get: + operationId: consumer-personalization-requests-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerpersonalizationrequests/list + x-stackQL-resource: consumer_personalization_requests + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + personalization_requests: + type: array + items: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.personalization_requests + description: List personalization requests for a consumer across all listings. + /api/2.1/marketplace-consumer/providers:batchGet: + get: + operationId: consumer-providers-batchget + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerproviders/batchget + x-stackQL-resource: consumer_providers + x-stackQL-method: batchget + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: + - name: ids + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + description: Batch get a provider in the Databricks Marketplace with at least + one visible listing. + /api/2.1/marketplace-consumer/providers/{id}: + get: + operationId: consumer-providers-get + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerproviders/get + x-stackQL-resource: consumer_providers + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + provider: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + x-stackQL-objectKey: $.provider + description: Get a provider in the Databricks Marketplace with at least one + visible listing. + /api/2.1/marketplace-consumer/providers: + get: + operationId: consumer-providers-list + externalDocs: + url: https://docs.databricks.com/api/workspace/consumerproviders/list + x-stackQL-resource: consumer_providers + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + - name: is_featured + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.providers + description: List all providers in the Databricks Marketplace with at least + one visible listing. + /api/2.0/marketplace-provider/provider: + post: + operationId: providers-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/create + x-stackQL-resource: providers + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + provider: + type: object + example: + provider: + id: string + name: string + description: string + icon_file_path: string + business_contact_email: string + support_contact_email: string + is_featured: true + published_by: string + company_website_link: string + icon_file_id: string + term_of_service_link: string + privacy_policy_link: string + dark_mode_icon_file_id: string + dark_mode_icon_file_path: string + description: Create a provider + /api/2.0/marketplace-provider/providers/{id}: + delete: + operationId: providers-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/delete + x-stackQL-resource: providers + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete provider + get: + operationId: providers-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/get + x-stackQL-resource: providers + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + provider: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + x-stackQL-objectKey: $.provider + description: Get provider profile + put: + operationId: providers-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/update + x-stackQL-resource: providers + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + provider: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + provider: + type: object + example: + provider: + id: string + name: string + description: string + icon_file_path: string + business_contact_email: string + support_contact_email: string + is_featured: true + published_by: string + company_website_link: string + icon_file_id: string + term_of_service_link: string + privacy_policy_link: string + dark_mode_icon_file_id: string + dark_mode_icon_file_path: string + description: Update provider profile + /api/2.0/marketplace-provider/providers: + get: + operationId: providers-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerproviders/list + x-stackQL-resource: providers + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + providers: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + description: + type: string + icon_file_path: + type: string + business_contact_email: + type: string + support_contact_email: + type: string + is_featured: + type: boolean + published_by: + type: string + company_website_link: + type: string + icon_file_id: + type: string + term_of_service_link: + type: string + privacy_policy_link: + type: string + dark_mode_icon_file_id: + type: string + dark_mode_icon_file_path: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.providers + description: List provider profiles for account. + /api/2.0/marketplace-provider/analytics_dashboard: + post: + operationId: provider-analytics-dashboards-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/create + x-stackQL-resource: provider_analytics_dashboards + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: Create provider analytics dashboard. Returns Marketplace specific + get: + operationId: provider-analytics-dashboards-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/get + x-stackQL-resource: provider_analytics_dashboards + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + version: + type: integer + dashboard_id: + type: string + description: Get provider analytics dashboard. + /api/2.0/marketplace-provider/analytics_dashboard/{id}: + put: + operationId: provider-analytics-dashboards-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/update + x-stackQL-resource: provider_analytics_dashboards + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + id: + type: string + version: + type: integer + dashboard_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + version: + type: integer + format: int64 + example: + version: 0 + description: Update provider analytics dashboard. + /api/2.0/marketplace-provider/analytics_dashboard/latest: + get: + operationId: provider-analytics-dashboards-latest-getlatestversion + externalDocs: + url: https://docs.databricks.com/api/workspace/providerprovideranalyticsdashboards/getlatestversion + x-stackQL-resource: provider_analytics_dashboards_latest + x-stackQL-method: getlatestversion + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + version: + type: integer + description: Get latest version of provider analytics dashboard. + /api/2.0/marketplace-exchange/exchanges: + post: + operationId: provider-exchanges-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/create + x-stackQL-resource: provider_exchanges + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + example: + exchange: + id: string + name: string + comment: string + filters: + - id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + linked_listings: + - id: string + exchange_id: string + exchange_name: string + listing_id: string + listing_name: string + created_at: 0 + created_by: string + description: Create an exchange + get: + operationId: provider-exchanges-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/list + x-stackQL-resource: provider_exchanges + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchanges: + type: array + items: + type: object + properties: + id: + type: string + name: + type: string + comment: + type: string + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + linked_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.exchanges + description: List exchanges visible to provider + /api/2.0/marketplace-exchange/exchanges/{id}: + delete: + operationId: provider-exchanges-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/delete + x-stackQL-resource: provider_exchanges + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: This removes a listing from marketplace. + get: + operationId: provider-exchanges-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/get + x-stackQL-resource: provider_exchanges + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + properties: + id: + type: string + name: + type: string + comment: + type: string + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + linked_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + x-stackQL-objectKey: $.exchange + description: Get an exchange. + put: + operationId: provider-exchanges-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/update + x-stackQL-resource: provider_exchanges + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + properties: + id: + type: string + name: + type: string + comment: + type: string + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + linked_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + exchange: + type: object + example: + exchange: + id: string + name: string + comment: string + filters: + - id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + linked_listings: + - id: string + exchange_id: string + exchange_name: string + listing_id: string + listing_name: string + created_at: 0 + created_by: string + description: Update an exchange + /api/2.0/marketplace-exchange/filters: + post: + operationId: provider-exchange-filters-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/create + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + filter_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + filter: + type: object + example: + filter: + id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + description: Add an exchange filter. + get: + operationId: provider-exchange-filters-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/list + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: exchange_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + filters: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.filters + description: List exchange filter + /api/2.0/marketplace-exchange/filters/{id}: + delete: + operationId: provider-exchange-filters-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/delete + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete an exchange filter + put: + operationId: provider-exchange-filters-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchangefilters/update + x-stackQL-resource: provider_exchange_filters + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + filter: + type: object + properties: + id: + type: string + exchange_id: + type: string + filter_value: + type: string + name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + filter_type: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + filter: + type: object + example: + filter: + id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + description: Update an exchange filter. + /api/2.0/marketplace-exchange/exchanges-for-listing: + post: + operationId: provider-exchange-listings-addlistingtoexchange + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/addlistingtoexchange + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: addlistingtoexchange + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_for_listing: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + listing_id: + type: required + exchange_id: + type: string + example: + listing_id: string + exchange_id: string + description: Associate an exchange with a listing + get: + operationId: provider-exchange-listings-listexchangesforlisting + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/listexchangesforlisting + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: listexchangesforlisting + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: listing_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_listing: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.exchange_listing + description: List exchanges associated with a listing + /api/2.0/marketplace-exchange/exchanges-for-listing/{id}: + delete: + operationId: provider-exchange-listings-deletelistingfromexchange + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/deletelistingfromexchange + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: deletelistingfromexchange + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Disassociate an exchange with a listing + /api/2.0/marketplace-exchange/listings-for-exchange: + get: + operationId: provider-exchange-listings-listlistingsforexchange + externalDocs: + url: https://docs.databricks.com/api/workspace/providerexchanges/listlistingsforexchange + x-stackQL-resource: provider_exchange_listings + x-stackQL-method: listlistingsforexchange + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: exchange_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + exchange_listings: + type: array + items: + type: object + properties: + id: + type: string + exchange_id: + type: string + exchange_name: + type: string + listing_id: + type: string + listing_name: + type: string + created_at: + type: integer + created_by: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.exchange_listings + description: List listings associated with an exchange + /api/2.0/marketplace-provider/files: + post: + operationId: provider-files-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/create + x-stackQL-resource: provider_files + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + upload_url: + type: string + file_info: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + marketplace_file_type: + type: required + mime_type: + type: string + display_name: + type: required + file_parent: + type: required + example: + file_parent: + parent_id: string + file_parent_type: PROVIDER + marketplace_file_type: PROVIDER_ICON + mime_type: string + display_name: string + description: Create a file. Currently, only provider icons and attached notebooks + are supported. + get: + operationId: provider-files-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/list + x-stackQL-resource: provider_files + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: null + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.file_infos + description: List files attached to a parent entity. + /api/2.0/marketplace-provider/files/{file_id}: + delete: + operationId: provider-files-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/delete + x-stackQL-resource: provider_files + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: file_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a file + get: + operationId: provider-files-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerfiles/get + x-stackQL-resource: provider_files + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: file_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + file_info: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + x-stackQL-objectKey: $.file_info + description: Get a file + /api/2.0/marketplace-provider/listing: + post: + operationId: provider-listings-create + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/create + x-stackQL-resource: provider_listings + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + listing: + type: object + example: + listing: + id: string + summary: + name: string + subtitle: string + status: DRAFT + share: + name: string + type: SAMPLE + provider_region: + cloud: string + region: string + setting: + visibility: PUBLIC + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + published_at: 0 + published_by: string + categories: + - ADVERTISING_AND_MARKETING + listingType: STANDARD + created_by_id: 0 + updated_by_id: 0 + provider_id: string + exchange_ids: + - string + git_repo: + git_repo_url: string + detail: + description: string + terms_of_service: string + documentation_link: string + support_link: string + file_ids: + - string + privacy_policy_link: string + embedded_notebook_file_infos: + - id: string + marketplace_file_type: PROVIDER_ICON + file_parent: + parent_id: string + file_parent_type: PROVIDER + mime_type: string + download_link: string + created_at: 0 + updated_at: 0 + display_name: string + status: FILE_STATUS_PUBLISHED + status_message: string + geographical_coverage: string + cost: FREE + pricing_model: string + update_frequency: + interval: 0 + unit: NONE + collection_granularity: + interval: 0 + unit: NONE + collection_date_start: 0 + collection_date_end: 0 + data_source: string + size: 0.1 + assets: + - ASSET_TYPE_GIT_REPO + license: string + tags: + - tag_name: LISTING_TAG_TYPE_LANGUAGE + tag_values: + - string + description: Create a new listing + /api/2.0/marketplace-provider/listings/{id}: + delete: + operationId: provider-listings-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/delete + x-stackQL-resource: provider_listings + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Delete a listing + get: + operationId: provider-listings-get + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/get + x-stackQL-resource: provider_listings + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + x-stackQL-objectKey: $.listing + description: Get a listing + put: + operationId: provider-listings-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/update + x-stackQL-resource: provider_listings + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listing: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + listing: + type: object + example: + listing: + id: string + summary: + name: string + subtitle: string + status: DRAFT + share: + name: string + type: SAMPLE + provider_region: + cloud: string + region: string + setting: + visibility: PUBLIC + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + published_at: 0 + published_by: string + categories: + - ADVERTISING_AND_MARKETING + listingType: STANDARD + created_by_id: 0 + updated_by_id: 0 + provider_id: string + exchange_ids: + - string + git_repo: + git_repo_url: string + detail: + description: string + terms_of_service: string + documentation_link: string + support_link: string + file_ids: + - string + privacy_policy_link: string + embedded_notebook_file_infos: + - id: string + marketplace_file_type: PROVIDER_ICON + file_parent: + parent_id: string + file_parent_type: PROVIDER + mime_type: string + download_link: string + created_at: 0 + updated_at: 0 + display_name: string + status: FILE_STATUS_PUBLISHED + status_message: string + geographical_coverage: string + cost: FREE + pricing_model: string + update_frequency: + interval: 0 + unit: NONE + collection_granularity: + interval: 0 + unit: NONE + collection_date_start: 0 + collection_date_end: 0 + data_source: string + size: 0.1 + assets: + - ASSET_TYPE_GIT_REPO + license: string + tags: + - tag_name: LISTING_TAG_TYPE_LANGUAGE + tag_values: + - string + description: Update a listing + /api/2.0/marketplace-provider/listings: + get: + operationId: provider-listings-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerlistings/list + x-stackQL-resource: provider_listings + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + listings: + type: array + items: + type: object + properties: + id: + type: string + summary: + type: object + properties: + name: + type: string + subtitle: + type: string + status: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + provider_region: + type: object + properties: + cloud: + type: string + region: + type: string + setting: + type: object + properties: + visibility: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + published_at: + type: integer + published_by: + type: string + categories: + type: array + items: + type: string + listingType: + type: string + created_by_id: + type: integer + updated_by_id: + type: integer + provider_id: + type: string + exchange_ids: + type: array + items: + type: string + git_repo: + type: object + properties: + git_repo_url: + type: string + detail: + type: object + properties: + description: + type: string + terms_of_service: + type: string + documentation_link: + type: string + support_link: + type: string + file_ids: + type: array + items: + type: string + privacy_policy_link: + type: string + embedded_notebook_file_infos: + type: array + items: + type: object + properties: + id: + type: string + marketplace_file_type: + type: string + file_parent: + type: object + properties: + parent_id: + type: string + file_parent_type: + type: string + mime_type: + type: string + download_link: + type: string + created_at: + type: integer + updated_at: + type: integer + display_name: + type: string + status: + type: string + status_message: + type: string + geographical_coverage: + type: string + cost: + type: string + pricing_model: + type: string + update_frequency: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_granularity: + type: object + properties: + interval: + type: integer + unit: + type: string + collection_date_start: + type: integer + collection_date_end: + type: integer + data_source: + type: string + size: + type: number + assets: + type: array + items: + type: string + license: + type: string + tags: + type: array + items: + type: object + properties: + tag_name: + type: string + tag_values: + type: array + items: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.listings + description: List listings owned by this provider + /api/2.0/marketplace-provider/personalization-requests: + get: + operationId: provider-personalization-requests-list + externalDocs: + url: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/list + x-stackQL-resource: provider_personalization_requests + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + personalization_requests: + type: array + items: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.personalization_requests + description: List personalization requests to this provider. This will return + all personalization requests, regardless of which listing they are for. + /api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status: + put: + operationId: provider-personalization-requests-update + externalDocs: + url: https://docs.databricks.com/api/workspace/providerpersonalizationrequests/update + x-stackQL-resource: provider_personalization_requests + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: listing_id + required: true + description: string + in: path + - name: request_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + request: + type: object + properties: + id: + type: string + consumer_region: + type: object + properties: + cloud: + type: string + region: + type: string + contact_info: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + company: + type: string + comment: + type: string + intended_use: + type: string + status: + type: string + status_message: + type: string + share: + type: object + properties: + name: + type: string + type: + type: string + created_at: + type: integer + listing_id: + type: string + updated_at: + type: integer + metastore_id: + type: string + listing_name: + type: string + is_from_lighthouse: + type: boolean + provider_id: + type: string + recipient_type: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + status: + type: required + reason: + type: string + share: + type: object + example: + status: NEW + reason: string + share: + name: string + type: SAMPLE + description: Update personalization request. This method only permits updating + the status of the request. +components: + x-stackQL-resources: + consumer_fulfillments: + id: databricks_workspace.marketplace.consumer_fulfillments + name: consumer_fulfillments + title: Consumer_fulfillments + methods: + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1fulfillments/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.fulfillments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_fulfillments/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + consumer_installations: + id: databricks_workspace.marketplace.consumer_installations + name: consumer_installations + title: Consumer_installations + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations~1{installation_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations~1{installation_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1installations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.installations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/consumer_installations/methods/delete' + exec: [] + listing_installations: + id: databricks_workspace.marketplace.listing_installations + name: listing_installations + title: Listing_installations + methods: + listlistinginstallations: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1installations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.installations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/listing_installations/methods/listlistinginstallations' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + consumer_listings: + id: databricks_workspace.marketplace.consumer_listings + name: consumer_listings + title: Consumer_listings + methods: + batchget: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings:batchGet/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listing + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listings + search: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1search-listings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/search' + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/list' + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/consumer_listings/methods/batchget' + consumer_listing_content: + id: databricks_workspace.marketplace.consumer_listing_content + name: consumer_listing_content + title: Consumer_listing_content + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1content/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.shared_data_objects + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_listing_content/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + consumer_personalization_requests: + id: databricks_workspace.marketplace.consumer_personalization_requests + name: consumer_personalization_requests + title: Consumer_personalization_requests + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1personalization-requests/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1listings~1{listing_id}~1personalization-requests/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.personalization_requests + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1personalization-requests/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.personalization_requests + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_personalization_requests/methods/list' + - $ref: '#/components/x-stackQL-resources/consumer_personalization_requests/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/consumer_personalization_requests/methods/create' + update: [] + replace: [] + delete: [] + exec: [] + consumer_providers: + id: databricks_workspace.marketplace.consumer_providers + name: consumer_providers + title: Consumer_providers + methods: + batchget: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1providers:batchGet/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1providers~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.provider + list: + operation: + $ref: '#/paths/~1api~12.1~1marketplace-consumer~1providers/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.providers + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_providers/methods/list' + - $ref: '#/components/x-stackQL-resources/consumer_providers/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/consumer_providers/methods/batchget' + providers: + id: databricks_workspace.marketplace.providers + name: providers + title: Providers + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1provider/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.provider + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1providers/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.providers + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/providers/methods/list' + - $ref: '#/components/x-stackQL-resources/providers/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/providers/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/providers/methods/delete' + exec: [] + provider_analytics_dashboards: + id: databricks_workspace.marketplace.provider_analytics_dashboards + name: provider_analytics_dashboards + title: Provider_analytics_dashboards + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards/methods/update' + replace: [] + delete: [] + exec: [] + provider_analytics_dashboards_latest: + id: databricks_workspace.marketplace.provider_analytics_dashboards_latest + name: provider_analytics_dashboards_latest + title: Provider_analytics_dashboards_latest + methods: + getlatestversion: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1analytics_dashboard~1latest/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_analytics_dashboards_latest/methods/getlatestversion' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + provider_exchanges: + id: databricks_workspace.marketplace.provider_exchanges + name: provider_exchanges + title: Provider_exchanges + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchanges + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchange + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/get' + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_exchanges/methods/delete' + exec: [] + provider_exchange_filters: + id: databricks_workspace.marketplace.provider_exchange_filters + name: provider_exchange_filters + title: Provider_exchange_filters + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.filters + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1filters~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_exchange_filters/methods/delete' + exec: [] + provider_exchange_listings: + id: databricks_workspace.marketplace.provider_exchange_listings + name: provider_exchange_listings + title: Provider_exchange_listings + methods: + addlistingtoexchange: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges-for-listing/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listexchangesforlisting: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges-for-listing/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchange_listing + deletelistingfromexchange: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1exchanges-for-listing~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listlistingsforexchange: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-exchange~1listings-for-exchange/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.exchange_listings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/listlistingsforexchange' + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/listexchangesforlisting' + insert: + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/addlistingtoexchange' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_exchange_listings/methods/deletelistingfromexchange' + exec: [] + provider_files: + id: databricks_workspace.marketplace.provider_files + name: provider_files + title: Provider_files + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.file_infos + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files~1{file_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1files~1{file_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.file_info + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_files/methods/get' + - $ref: '#/components/x-stackQL-resources/provider_files/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/provider_files/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_files/methods/delete' + exec: [] + provider_listings: + id: databricks_workspace.marketplace.provider_listings + name: provider_listings + title: Provider_listings + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listing/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listing + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.listings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/list' + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/provider_listings/methods/delete' + exec: [] + provider_personalization_requests: + id: databricks_workspace.marketplace.provider_personalization_requests + name: provider_personalization_requests + title: Provider_personalization_requests + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1personalization-requests/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.personalization_requests + update: + operation: + $ref: '#/paths/~1api~12.0~1marketplace-provider~1listings~1{listing_id}~1personalization-requests~1{request_id}~1request-status/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/provider_personalization_requests/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/provider_personalization_requests/methods/update' + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml b/providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml new file mode 100644 index 00000000..779fca1e --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/realtimeserving.yaml @@ -0,0 +1,1882 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Realtimeserving API + description: Realtimeserving +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/serving-endpoints/{name}/ai-gateway: + put: + operationId: ai-gateways-putaigateway + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/putaigateway + x-stackQL-resource: ai_gateways + x-stackQL-method: putaigateway + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint AI Gateway was updated successfully. + content: + application/json: + schema: + type: object + properties: + usage_tracking_config: + type: object + properties: + enabled: + type: boolean + inference_table_config: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + table_name_prefix: + type: string + enabled: + type: boolean + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + guardrails: + type: object + properties: + input: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + output: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + usage_tracking_config: + type: object + inference_table_config: + type: object + rate_limits: + type: Array of object + guardrails: + type: object + example: + usage_tracking_config: + enabled: true + inference_table_config: + catalog_name: my-catalog + schema_name: my-schema + table_name_prefix: my-prefix + enabled: true + rate_limits: + - calls: 15 + key: user + renewal_period: minute + guardrails: + input: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + invalid_keywords: + - keyword1 + output: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + invalid_keywords: + - keyword1 + description: 'Used to update the AI Gateway of a serving endpoint. NOTE: Only + external model endpoints are currently supported.' + /api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/build-logs: + get: + operationId: build-logs-buildlogs + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/buildlogs + x-stackQL-resource: build_logs + x-stackQL-method: buildlogs + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: path + - name: served_model_name + required: true + description: string + in: path + responses: + '200': + description: Build logs were fetched successfully. + content: + application/json: + schema: + type: object + properties: + logs: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the build logs associated with the provided served model. + /api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/logs: + get: + operationId: logs-logs + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/logs + x-stackQL-resource: logs + x-stackQL-method: logs + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: name + required: true + description: string + in: path + - name: served_model_name + required: true + description: string + in: path + responses: + '200': + description: Logs were fetched successfully. + content: + application/json: + schema: + type: object + properties: + logs: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the service logs associated with the provided served + model. + /api/2.0/serving-endpoints/{name}/metrics: + get: + operationId: metrics-exportmetrics + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/exportmetrics + x-stackQL-resource: metrics + x-stackQL-method: exportmetrics + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Metrics for the serving endpoint in Prometheus exposition or + OpenMetrics exposition format were fetched successfully. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the metrics associated with the provided serving endpoint + in either Prometheus or OpenMetrics exposition format. + /api/2.0/serving-endpoints/{name}/openapi: + get: + operationId: schemas-getopenapi + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/getopenapi + x-stackQL-resource: schemas + x-stackQL-method: getopenapi + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The OpenAPI spec for the invocation schema was fetched successfully + content: + application/json: + schema: + type: object + properties: + openapi: + type: string + info: + type: object + properties: + title: + type: string + version: + type: string + servers: + type: array + items: + type: object + properties: + url: + type: string + paths: + type: object + properties: + /served-models/model1/invocations: + type: object + properties: + post: + type: object + properties: + requestBody: + type: object + properties: + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + oneOf: + type: array + items: + type: object + properties: + properties: + type: object + properties: + dataframe_split: + type: object + properties: + properties: + type: object + properties: + columns: + type: object + properties: + type: + type: string + description: + type: string + items: + type: object + properties: + type: + type: string + enum: + type: array + items: + type: string + data: + type: object + properties: + type: + type: string + items: + type: object + properties: + type: + type: string + prefixItems: + type: array + items: + type: object + properties: + type: + type: string + format: + type: string + responses: + type: object + properties: + '200': + type: object + properties: + description: + type: string + content: + type: object + properties: + application/json: + type: object + properties: + schema: + type: object + properties: + properties: + type: object + properties: + predictions: + type: object + properties: + type: + type: string + items: + type: object + properties: + type: + type: string + format: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get the query schema of the serving endpoint in OpenAPI format. + The schema contains information for the supported paths, input and output + format and datatypes. + /api/2.0/serving-endpoints: + post: + operationId: serving-endpoints-create + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/create + x-stackQL-resource: serving_endpoints + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Serving endpoint was created successfully + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + external_model: + type: object + properties: + provider: + type: string + name: + type: string + task: + type: string + openai_config: + type: object + properties: + openai_api_key: + type: string + state: + type: object + properties: + deployment: + type: string + deployment_state_message: + type: string + creator: + type: string + creation_timestamp: + type: integer + traffic_config: + type: object + properties: + routes: + type: array + items: + type: object + properties: + served_model_name: + type: string + traffic_percentage: + type: integer + config_version: + type: integer + ai_gateway: + type: object + properties: + usage_tracking_config: + type: object + properties: + enabled: + type: boolean + inference_table_config: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + table_name_prefix: + type: string + enabled: + type: boolean + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + guardrails: + type: object + properties: + input: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + output: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + id: + type: string + permission_level: + type: string + route_optimized: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + route_optimized: + type: string + config: + type: required + tags: + type: object + rate_limits: + type: Array of object + ai_gateway: + type: Array of object + example: + name: openai_endpoint + config: + served_entities: + - name: openai_embeddings + external_model: + name: text-embedding-ada-002 + provider: openai + task: llm/v1/embeddings + openai_config: + openai_api_key: '{{secrets/my_scope/my_openai_api_key}}' + ai_gateway: + usage_tracking_config: + enabled: true + inference_table_config: + catalog_name: my-catalog + schema_name: my-schema + table_name_prefix: my-prefix + enabled: true + rate_limits: + - calls: 100 + key: user + renewal_period: minute + guardrails: + input: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + - topic2 + invalid_keywords: + - keyword1 + - keyword2 + output: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + - topic2 + invalid_keywords: + - keyword1 + - keyword2 + tags: + - key: team + value: gen-ai + get: + operationId: serving-endpoints-list + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/list + x-stackQL-resource: serving_endpoints + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: List of serving endpoints was retrieved successfully. + content: + application/json: + schema: + type: object + properties: + endpoints: + type: array + items: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config_update: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + external_model: + type: object + properties: + provider: + type: string + name: + type: string + task: + type: string + ai21labs_config: + type: object + properties: + ai21labs_api_key: + type: string + ai21labs_api_key_plaintext: + type: string + anthropic_config: + type: object + properties: + anthropic_api_key: + type: string + anthropic_api_key_plaintext: + type: string + amazon_bedrock_config: + type: object + properties: + aws_region: + type: string + aws_access_key_id: + type: string + aws_access_key_id_plaintext: + type: string + aws_secret_access_key: + type: string + aws_secret_access_key_plaintext: + type: string + bedrock_provider: + type: string + cohere_config: + type: object + properties: + cohere_api_key: + type: string + cohere_api_key_plaintext: + type: string + cohere_api_base: + type: string + google_cloud_vertex_ai_config: + type: object + properties: + private_key: + type: string + private_key_plaintext: + type: string + region: + type: string + project_id: + type: string + databricks_model_serving_config: + type: object + properties: + databricks_api_token: + type: string + databricks_api_token_plaintext: + type: string + databricks_workspace_url: + type: string + openai_config: + type: object + properties: + openai_api_key: + type: string + openai_api_key_plaintext: + type: string + openai_api_type: + type: string + openai_api_base: + type: string + openai_api_version: + type: string + openai_organization: + type: string + openai_deployment_name: + type: string + microsoft_entra_tenant_id: + type: string + microsoft_entra_client_id: + type: string + microsoft_entra_client_secret: + type: string + microsoft_entra_client_secret_plaintext: + type: string + palm_config: + type: object + properties: + palm_api_key: + type: string + palm_api_key_plaintext: + type: string + foundation_model: + type: object + properties: + name: + type: string + display_name: + type: string + docs: + type: string + description: + type: string + entity_name: + type: string + entity_version: + type: string + served_models: + type: array + items: + type: object + properties: + name: + type: string + model_name: + type: string + model_version: + type: string + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + id: + type: string + task: + type: string + ai_gateway: + type: object + properties: + usage_tracking_config: + type: object + properties: + enabled: + type: boolean + inference_table_config: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + table_name_prefix: + type: string + enabled: + type: boolean + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + guardrails: + type: object + properties: + input: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + output: + type: object + properties: + safety: + type: boolean + pii: + type: object + properties: + behavior: + type: string + valid_topics: + type: array + items: + type: string + invalid_keywords: + type: array + items: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.endpoints + /api/2.0/serving-endpoints/{name}: + delete: + operationId: serving-endpoints-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/delete + x-stackQL-resource: serving_endpoints + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint was deleted successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: serving-endpoints-get + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/get + x-stackQL-resource: serving_endpoints + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint was retrieved successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config_update: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + entity_name: + type: string + workload_size: + type: string + scale_to_zero_enabled: + type: boolean + workload_type: + type: string + state: + type: object + properties: + deployment: + type: string + deployment_state_message: + type: string + creator: + type: string + creation_timestamp: + type: integer + traffic_config: + type: object + properties: + routes: + type: array + items: + type: object + properties: + traffic_percentage: + type: integer + served_model_name: + type: string + config_version: + type: integer + tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + id: + type: string + permission_level: + type: string + route_optimized: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the details for a single serving endpoint. + /api/2.0/serving-endpoints/{name}/tags: + patch: + operationId: serving-endpoints-patch + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/patch + x-stackQL-resource: serving_endpoints + x-stackQL-method: patch + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint tags were patched successfully. + content: + application/json: + schema: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + delete_tags: + type: Array of string + add_tags: + type: Array of object + example: + add_tags: + - key: team + value: data science + delete_tags: + - string + description: Used to batch add and delete tags from a serving endpoint with + a single API call. + /api/2.0/serving-endpoints/{name}/rate-limits: + put: + operationId: serving-endpoints-put + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/put + x-stackQL-resource: serving_endpoints + x-stackQL-method: put + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint rate limits were updated successfully. + content: + application/json: + schema: + type: object + properties: + rate_limits: + type: array + items: + type: object + properties: + calls: + type: integer + key: + type: string + renewal_period: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + rate_limits: + type: Array of object + example: + rate_limits: + - calls: 15 + key: user + renewal_period: minute + description: 'Used to update the rate limits of a serving endpoint. NOTE: Only + foundation model endpoints are currently supported. For external models, use + AI Gateway to manage rate limits.' + /serving-endpoints/{name}/invocations: + post: + operationId: serving-endpoints-query + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/query + x-stackQL-resource: serving_endpoints + x-stackQL-method: query + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint was queried successfully and returned predictions. + content: + application/json: + schema: + type: object + properties: + id: + type: string + object: + type: string + created: + type: integer + model: + type: string + choices: + type: array + items: + type: object + properties: + text: + type: string + index: + type: integer + logprobs: + type: 'null' + finish_reason: + type: string + usage: + type: object + properties: + prompt_tokens: + type: integer + completion_tokens: + type: integer + total_tokens: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + prompt: + type: object + input: + type: object + temperature: + type: double + stop: + type: Array of string + max_tokens: + type: integer + n: + type: integer + stream: + type: boolean + dataframe_records: + type: Array of object + instances: + type: Array of object + inputs: + type: object + messages: + type: Array of object + extra_params: + type: object + dataframe_split: + type: object + example: + dataframe_records: + - user_latitude: 37 + user_longitude: 122.4 + destination_id: 10 + /api/2.0/serving-endpoints/{name}/config: + put: + operationId: serving-endpoints-updateconfig + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/updateconfig + x-stackQL-resource: serving_endpoints + x-stackQL-method: updateconfig + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Serving endpoint update was issued successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + state: + type: object + properties: + ready: + type: string + config: + type: object + properties: + served_entities: + type: array + items: + type: object + properties: + name: + type: string + external_model: + type: object + properties: + provider: + type: string + name: + type: string + task: + type: string + openai_config: + type: object + properties: + openai_api_key: + type: string + state: + type: object + properties: + deployment: + type: string + deployment_state_message: + type: string + creator: + type: string + creation_timestamp: + type: integer + traffic_config: + type: object + properties: + routes: + type: array + items: + type: object + properties: + served_model_name: + type: string + traffic_percentage: + type: integer + config_version: + type: integer + id: + type: string + permission_level: + type: string + route_optimized: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + served_entities: + type: Array of object + served_models: + type: Array of object + traffic_config: + type: object + auto_capture_config: + type: object + example: + served_entities: + - name: openai_chat + external_model: + name: gpt-4 + provider: openai + task: llm/v1/chat + openai_config: + openai_api_key: '{{secrets/my_scope/my_openai_api_key}}' + description: Updates any combination of the serving endpoint's served entities, + the compute configuration of those served entities, and the endpoint's traffic + config. An endpoint that already has an update in progress can not be updated + until the current update completes or fails. + /api/2.0/permissions/serving-endpoints/{serving_endpoint_id}: + get: + operationId: serving-endpoints-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/getpermissions + x-stackQL-resource: serving_endpoints_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a serving endpoint. Serving endpoints can + inherit permissions from their root object. + put: + operationId: serving-endpoints-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/setpermissions + x-stackQL-resource: serving_endpoints_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: serving-endpoints-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/updatepermissions + x-stackQL-resource: serving_endpoints_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a serving endpoint. Serving endpoints + can inherit permissions from their root object. + /api/2.0/permissions/serving-endpoints/{serving_endpoint_id}/permissionLevels: + get: + operationId: serving-endpoints-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/servingendpoints/getpermissionlevels + x-stackQL-resource: serving_endpoints_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: serving_endpoint_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. +components: + x-stackQL-resources: + ai_gateways: + id: databricks_workspace.realtimeserving.ai_gateways + name: ai_gateways + title: Ai_gateways + methods: + putaigateway: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1ai-gateway/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/ai_gateways/methods/putaigateway' + build_logs: + id: databricks_workspace.realtimeserving.build_logs + name: build_logs + title: Build_logs + methods: + buildlogs: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1served-models~1{served_model_name}~1build-logs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/build_logs/methods/buildlogs' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + logs: + id: databricks_workspace.realtimeserving.logs + name: logs + title: Logs + methods: + logs: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1served-models~1{served_model_name}~1logs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/logs' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + metrics: + id: databricks_workspace.realtimeserving.metrics + name: metrics + title: Metrics + methods: + exportmetrics: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1metrics/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/metrics/methods/exportmetrics' + schemas: + id: databricks_workspace.realtimeserving.schemas + name: schemas + title: Schemas + methods: + getopenapi: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1openapi/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/getopenapi' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + serving_endpoints: + id: databricks_workspace.realtimeserving.serving_endpoints + name: serving_endpoints + title: Serving_endpoints + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpoints + delete: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1tags/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + put: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1rate-limits/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + query: + operation: + $ref: '#/paths/~1serving-endpoints~1{name}~1invocations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateconfig: + operation: + $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1config/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/updateconfig' + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/put' + delete: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/serving_endpoints/methods/query' + serving_endpoints_permissions: + id: databricks_workspace.realtimeserving.serving_endpoints_permissions + name: serving_endpoints_permissions + title: Serving_endpoints_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permissions/methods/setpermissions' + delete: [] + exec: [] + serving_endpoints_permission_levels: + id: databricks_workspace.realtimeserving.serving_endpoints_permission_levels + name: serving_endpoints_permission_levels + title: Serving_endpoints_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1serving-endpoints~1{serving_endpoint_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/serving_endpoints_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml new file mode 100644 index 00000000..a0a2830e --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/repos.yaml @@ -0,0 +1,906 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Repos API + description: Repos +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/git-credentials: + post: + operationId: git-credentials-create + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/create + x-stackQL-resource: git_credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credential_id: + type: string + git_provider: + type: string + git_username: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + git_provider: + type: required + git_username: + type: string + personal_access_token: + type: string + example: + git_provider: gitHub + git_username: testuser + personal_access_token: something + description: Creates a Git credential entry for the user. Only one Git credential + per user is supported, so any attempts to create credentials if an entry already + exists will fail. Use the PATCH endpoint to update existing credentials, or + the DELETE endpoint to delete existing credentials. + get: + operationId: git-credentials-list + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/list + x-stackQL-resource: git_credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + items: + type: object + properties: + credential_id: + type: string + git_provider: + type: string + git_username: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.credentials + description: Lists the calling user's Git credentials. One credential per user + is supported. + /api/2.0/git-credentials/{credential_id}: + delete: + operationId: git-credentials-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/delete + x-stackQL-resource: git_credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: credential_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes the specified Git credential. + get: + operationId: git-credentials-get + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/get + x-stackQL-resource: git_credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: credential_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credential_id: + type: string + git_provider: + type: string + git_username: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the Git credential with the specified credential ID. + patch: + operationId: git-credentials-update + externalDocs: + url: https://docs.databricks.com/api/workspace/gitcredentials/update + x-stackQL-resource: git_credentials + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: credential_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + personal_access_token: + type: string + git_provider: + type: required + git_username: + type: string + example: + git_provider: gitHub + git_username: testuser + personal_access_token: something + description: Updates the specified Git credential. + /api/2.0/permissions/repos/{repo_id}: + get: + operationId: permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/getpermissions + x-stackQL-resource: permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a repo. Repos can inherit permissions from + their root object. + put: + operationId: permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/setpermissions + x-stackQL-resource: permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/updatepermissions + x-stackQL-resource: permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a repo. Repos can inherit permissions + from their root object. + /api/2.0/permissions/repos/{repo_id}/permissionLevels: + get: + operationId: permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/getpermissionlevels + x-stackQL-resource: permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/repos: + post: + operationId: repos-create + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/create + x-stackQL-resource: repos + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + branch: + type: string + head_commit_id: + type: string + id: + type: string + path: + type: string + provider: + type: string + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string + url: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + url: + type: required + provider: + type: string + path: + type: required + sparse_checkout: + type: object + example: + branch: main + path: /Users/user@company.com/clitest + provider: gitHub + sparse_checkout: + patterns: + - parent-folder/child-folder + - src + - test + url: https://github.com/databricks/cli.git + description: Creates a repo in the workspace and links it to the remote Git + repo specified. Note that repos created programmatically must be linked to + a remote Git repo, unlike repos created in the browser. + get: + operationId: repos-list + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/list + x-stackQL-resource: repos + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: path_prefix + in: query + - name: next_page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + repos: + type: array + items: + type: object + properties: + branch: + type: string + path: + type: string + provider: + type: string + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string + url: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.repos + description: Returns repos that the calling user has Manage permissions on. + Use + /api/2.0/repos/{repo_id}: + delete: + operationId: repos-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/delete + x-stackQL-resource: repos + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes the specified repo. + get: + operationId: repos-get + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/get + x-stackQL-resource: repos + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + branch: + type: string + head_commit_id: + type: string + id: + type: string + path: + type: string + provider: + type: string + url: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Returns the repo with the given repo ID. + patch: + operationId: repos-update + externalDocs: + url: https://docs.databricks.com/api/workspace/repos/update + x-stackQL-resource: repos + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: repo_id + required: true + description: int64 + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + branch: + type: string + tag: + type: string + sparse_checkout: + type: object + example: + branch: main + sparse_checkout: + patterns: + - parent-folder/child-folder + - src + - test + description: Updates the repo to a different branch or tag, or updates the repo + to the latest commit on the same branch. +components: + x-stackQL-resources: + git_credentials: + id: databricks_workspace.repos.git_credentials + name: git_credentials + title: Git_credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.credentials + delete: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials~1{credential_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials~1{credential_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1git-credentials~1{credential_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/git_credentials/methods/delete' + exec: [] + permissions: + id: databricks_workspace.repos.permissions + name: permissions + title: Permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/setpermissions' + delete: [] + exec: [] + permission_levels: + id: databricks_workspace.repos.permission_levels + name: permission_levels + title: Permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1repos~1{repo_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + repos: + id: databricks_workspace.repos.repos + name: repos + title: Repos + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1repos/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1repos/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.repos + delete: + operation: + $ref: '#/paths/~1api~12.0~1repos~1{repo_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1repos~1{repo_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1repos~1{repo_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repos/methods/get' + - $ref: '#/components/x-stackQL-resources/repos/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/repos/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/repos/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/repos/methods/delete' + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml b/providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml new file mode 100644 index 00000000..c0f5bfdd --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/secrets.yaml @@ -0,0 +1,618 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Secrets API + description: Secrets +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/secrets/acls/delete: + post: + operationId: acls-deleteacl + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/deleteacl + x-stackQL-resource: acls + x-stackQL-method: deleteacl + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + principal: + type: string + example: + scope: my-secret-scope + principal: data-scientists + description: Deletes the given ACL on the given scope. + /api/2.0/secrets/acls/get: + get: + operationId: acls-getacl + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/getacl + x-stackQL-resource: acls + x-stackQL-method: getacl + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: scope + required: true + description: string + in: query + - name: principal + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + principal: + type: string + permission: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the details about the given ACL, such as the group and permission. + Users must have the + /api/2.0/secrets/acls/list: + get: + operationId: acls-listacls + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/listacls + x-stackQL-resource: acls + x-stackQL-method: listacls + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: scope + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + acls: + type: array + items: + type: object + properties: + principal: + type: string + permission: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.acls + description: List the ACLs for a given secret scope. Users must have the + /api/2.0/secrets/acls/put: + post: + operationId: acls-putacl + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/putacl + x-stackQL-resource: acls + x-stackQL-method: putacl + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + principal: + type: string + permission: + type: required + example: + scope: my-secret-scope + principal: data-scientists + permission: READ + description: Creates or overwrites the Access Control List (ACL) associated + with the given principal (user or group) on the specified scope point. + /api/2.0/secrets/scopes/create: + post: + operationId: scopes-createscope + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/createscope + x-stackQL-resource: scopes + x-stackQL-method: createscope + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + initial_manage_principal: + type: string + scope_backend_type: + type: string + example: + scope: string + initial_manage_principal: string + scope_backend_type: DATABRICKS + description: The scope name must consist of alphanumeric characters, dashes, + underscores, and periods, and may not exceed 128 characters. + /api/2.0/secrets/scopes/delete: + post: + operationId: scopes-deletescope + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/deletescope + x-stackQL-resource: scopes + x-stackQL-method: deletescope + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + example: + scope: my-secret-scope + description: Deletes a secret scope. + /api/2.0/secrets/scopes/list: + get: + operationId: scopes-listscopes + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/listscopes + x-stackQL-resource: scopes + x-stackQL-method: listscopes + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + scopes: + type: array + items: + type: object + properties: + name: + type: string + backend_type: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.scopes + description: Lists all secret scopes available in the workspace. + /api/2.0/secrets/delete: + post: + operationId: secrets-deletesecret + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/deletesecret + x-stackQL-resource: secrets + x-stackQL-method: deletesecret + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + key: + type: string + example: + scope: my-secret-scope + key: my-secret-key + description: Deletes the secret stored in this secret scope. You must have + /api/2.0/secrets/get: + get: + operationId: secrets-getsecret + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/getsecret + x-stackQL-resource: secrets + x-stackQL-method: getsecret + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: scope + required: true + description: string + in: query + - name: key + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + key: + type: string + value: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the bytes representation of a secret value for the specified + scope and key. + /api/2.0/secrets/list: + get: + operationId: secrets-listsecrets + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/listsecrets + x-stackQL-resource: secrets + x-stackQL-method: listsecrets + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: scope + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + secrets: + type: array + items: + type: object + properties: + key: + type: string + last_updated_timestamp: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.secrets + description: Lists the secret keys that are stored at this scope. This is a + metadata-only operation; secret data cannot be retrieved using this API. Users + need the READ permission to make this call. + /api/2.0/secrets/put: + post: + operationId: secrets-putsecret + externalDocs: + url: https://docs.databricks.com/api/workspace/secrets/putsecret + x-stackQL-resource: secrets + x-stackQL-method: putsecret + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scope: + type: required + key: + type: string + string_value: + type: required + bytes_value: + type: string + example: + scope: my-databricks-scope + key: my-string-key + string_value: foobar + description: Inserts a secret under the provided scope with the given name. If + a secret already exists with the same name, this command overwrites the existing + secret's value. The server encrypts the secret using the secret scope's encryption + settings before storing it. +components: + x-stackQL-resources: + acls: + id: databricks_workspace.secrets.acls + name: acls + title: Acls + methods: + deleteacl: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getacl: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listacls: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.acls + putacl: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1acls~1put/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/listacls' + - $ref: '#/components/x-stackQL-resources/acls/methods/getacl' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/acls/methods/putacl' + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/deleteacl' + exec: [] + scopes: + id: databricks_workspace.secrets.scopes + name: scopes + title: Scopes + methods: + createscope: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1scopes~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deletescope: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1scopes~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listscopes: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1scopes~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.scopes + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scopes/methods/listscopes' + insert: + - $ref: '#/components/x-stackQL-resources/scopes/methods/createscope' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/scopes/methods/deletescope' + exec: [] + secrets: + id: databricks_workspace.secrets.secrets + name: secrets + title: Secrets + methods: + deletesecret: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getsecret: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listsecrets: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.secrets + putsecret: + operation: + $ref: '#/paths/~1api~12.0~1secrets~1put/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/listsecrets' + - $ref: '#/components/x-stackQL-resources/secrets/methods/getsecret' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/secrets/methods/putsecret' + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/deletesecret' + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml b/providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml new file mode 100644 index 00000000..4d3d6ef2 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/unitycatalog.yaml @@ -0,0 +1,7945 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Unitycatalog API + description: Unitycatalog +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.1/unity-catalog/artifact-allowlists/{artifact_type}: + get: + operationId: artifact-allow-lists-get + externalDocs: + url: https://docs.databricks.com/api/workspace/artifactallowlists/get + x-stackQL-resource: artifact_allow_lists + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: artifact_type + required: true + description: string + in: path + responses: + '200': + description: The artifact allowlist was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + artifact_matchers: + type: array + items: + type: object + properties: + artifact: + type: string + match_type: + type: string + metastore_id: + type: string + created_by: + type: string + created_at: + type: integer + description: Get the artifact allowlist of a certain artifact type. The caller + must be a metastore admin or have the + put: + operationId: artifact-allow-lists-update + externalDocs: + url: https://docs.databricks.com/api/workspace/artifactallowlists/update + x-stackQL-resource: artifact_allow_lists + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: artifact_type + required: true + description: string + in: path + responses: + '200': + description: The artifact allowlist of a certain artifact type was updated + content: + application/json: + schema: + type: object + properties: + artifact_matchers: + type: array + items: + type: object + properties: + artifact: + type: string + match_type: + type: string + metastore_id: + type: string + created_by: + type: string + created_at: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + artifact_matchers: + type: required + example: + artifact_matchers: + - artifact: string + match_type: PREFIX_MATCH + description: Set the artifact allowlist of a certain artifact type. The whole + artifact allowlist is replaced with the new allowlist. The caller must be + a metastore admin or have the + /api/2.1/unity-catalog/catalogs: + post: + operationId: catalogs-create + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/create + x-stackQL-resource: catalogs + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new catalog was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + connection_name: + type: string + properties: + type: object + options: + type: object + example: + name: string + comment: string + properties: + property1: string + property2: string + storage_root: string + provider_name: string + share_name: string + connection_name: string + options: + property1: string + property2: string + description: Creates a new catalog instance in the parent metastore if the caller + is a metastore admin or has the + get: + operationId: catalogs-list + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/list + x-stackQL-resource: catalogs + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: include_browse + in: query + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The catalog list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + catalogs: + type: array + items: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + next_page_token: + type: string + x-stackQL-objectKey: $.catalogs + description: Gets an array of catalogs in the metastore. If the caller is the + metastore admin, all catalogs will be retrieved. Otherwise, only catalogs + owned by the caller (or for which the caller has the + /api/2.1/unity-catalog/catalogs/{name}: + delete: + operationId: catalogs-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/delete + x-stackQL-resource: catalogs + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The catalog was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the catalog that matches the supplied name. The caller + must be a metastore admin or the owner of the catalog. + get: + operationId: catalogs-get + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/get + x-stackQL-resource: catalogs + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The catalog was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + description: Gets the specified catalog in a metastore. The caller must be a + metastore admin, the owner of the catalog, or a user that has the + patch: + operationId: catalogs-update + externalDocs: + url: https://docs.databricks.com/api/workspace/catalogs/update + x-stackQL-resource: catalogs + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The catalog was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + provider_name: + type: string + share_name: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + storage_location: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + isolation_mode: + type: string + connection_name: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + isolation_mode: + type: string + enable_predictive_optimization: + type: string + new_name: + type: string + properties: + type: object + example: + owner: string + comment: string + properties: + property1: string + property2: string + isolation_mode: OPEN + enable_predictive_optimization: DISABLE + new_name: string + description: Updates the catalog that matches the supplied name. The caller + must be either the owner of the catalog, or a metastore admin (when changing + the owner field of the catalog). + /api/2.1/unity-catalog/connections: + post: + operationId: connections-create + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/create + x-stackQL-resource: connections + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The connection was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + connection_type: + type: string + read_only: + type: required + comment: + type: string + options: + type: required + properties: + type: object + example: + name: string + connection_type: MYSQL + options: + property1: string + property2: string + read_only: true + comment: string + properties: + property1: string + property2: string + description: Creates a new connection + get: + operationId: connections-list + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/list + x-stackQL-resource: connections + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The connection list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + connections: + type: array + items: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.connections + description: List all connections. + /api/2.1/unity-catalog/connections/{name}: + delete: + operationId: connections-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/delete + x-stackQL-resource: connections + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The connection was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the connection that matches the supplied name. + get: + operationId: connections-get + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/get + x-stackQL-resource: connections + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The connection was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + description: Gets a connection from it's name. + patch: + operationId: connections-update + externalDocs: + url: https://docs.databricks.com/api/workspace/connections/update + x-stackQL-resource: connections + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The connection was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + connection_type: + type: string + options: + type: object + properties: + property1: + type: string + property2: + type: string + owner: + type: string + read_only: + type: boolean + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + full_name: + type: string + url: + type: string + credential_type: + type: string + connection_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + securable_kind: + type: string + securable_type: + type: string + provisioning_info: + type: object + properties: + state: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + new_name: + type: string + options: + type: required + example: + options: + property1: string + property2: string + owner: string + new_name: string + description: Updates the connection that matches the supplied name. + /api/2.1/unity-catalog/credentials: + post: + operationId: credentials-createcredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/createcredential + x-stackQL-resource: credentials + x-stackQL-method: createcredential + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + read_only: + type: string + purpose: + type: boolean + skip_validation: + type: string + aws_iam_role: + type: object + example: + name: string + aws_iam_role: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + comment: string + read_only: true + purpose: STORAGE + skip_validation: false + description: Creates a new credential. The type of credential to be created + is determined by the + get: + operationId: credentials-listcredentials + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/listcredentials + x-stackQL-resource: credentials + x-stackQL-method: listcredentials + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + - name: purpose + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + items: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.credentials + description: Gets an array of credentials (as + /api/2.1/unity-catalog/credentials/{name_arg}: + delete: + operationId: credentials-deletecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/deletecredential + x-stackQL-resource: credentials + x-stackQL-method: deletecredential + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name_arg + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a service or storage credential from the metastore. The + caller must be an owner of the credential. + get: + operationId: credentials-getcredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/getcredential + x-stackQL-resource: credentials + x-stackQL-method: getcredential + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name_arg + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + description: Gets a service or storage credential from the metastore. The caller + must be a metastore admin, the owner of the credential, or have any permission + on the credential. + patch: + operationId: credentials-updatecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/updatecredential + x-stackQL-resource: credentials + x-stackQL-method: updatecredential + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name_arg + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + purpose: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + full_name: + type: string + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_name: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + isolation_mode: + type: string + skip_validation: + type: boolean + force: + type: boolean + aws_iam_role: + type: object + example: + new_name: string + aws_iam_role: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + comment: string + read_only: true + owner: string + isolation_mode: ISOLATION_MODE_OPEN + skip_validation: true + force: true + description: Updates a service or storage credential on the metastore. + /api/2.1/unity-catalog/temporary-service-credentials: + post: + operationId: credentials-generatetemporaryservicecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/generatetemporaryservicecredential + x-stackQL-resource: credentials + x-stackQL-method: generatetemporaryservicecredential + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + aws_temp_credentials: + type: object + properties: + access_key_id: + type: string + secret_access_key: + type: string + session_token: + type: string + access_point: + type: string + expiration_time: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_name: + type: required + example: + credential_name: string + description: Returns a set of temporary credentials generated using the specified + service credential. The caller must be a metastore admin or have the metastore + privilege + /api/2.1/unity-catalog/validate-credentials: + post: + operationId: credential-validation-validatecredential + externalDocs: + url: https://docs.databricks.com/api/workspace/credentials/validatecredential + x-stackQL-resource: credential_validation + x-stackQL-method: validatecredential + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + results: + type: array + items: + type: object + properties: + result: + type: string + message: + type: string + isDir: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credential_name: + type: string + purpose: + type: string + external_location_name: + type: string + url: + type: string + read_only: + type: boolean + aws_iam_role: + type: object + example: + credential_name: string + aws_iam_role: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + purpose: STORAGE + external_location_name: string + url: string + read_only: true + description: Validates a credential. + /api/2.1/unity-catalog/effective-permissions/{securable_type}/{full_name}: + get: + operationId: effective-grants-geteffective + externalDocs: + url: https://docs.databricks.com/api/workspace/grants/geteffective + x-stackQL-resource: effective_grants + x-stackQL-method: geteffective + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: full_name + required: true + description: string + in: path + - name: principal + in: query + responses: + '200': + description: The effective permissions list for securable was successfully + retrieved. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: object + properties: + privilege: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + x-stackQL-objectKey: $.privilege_assignments + description: Gets the effective permissions for a securable. + /api/2.1/unity-catalog/external-locations: + post: + operationId: external-locations-create + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/create + x-stackQL-resource: external_locations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new external location was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + url: + type: string + credential_name: + type: required + read_only: + type: string + comment: + type: required + access_point: + type: string + skip_validation: + type: boolean + example: + name: string + url: string + credential_name: string + read_only: true + comment: string + access_point: string + skip_validation: true + description: Creates a new external location entry in the metastore. The caller + must be a metastore admin or have the + get: + operationId: external-locations-list + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/list + x-stackQL-resource: external_locations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The external location list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + external_locations: + type: array + items: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.external_locations + description: Gets an array of external locations ( + /api/2.1/unity-catalog/external-locations/{name}: + delete: + operationId: external-locations-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/delete + x-stackQL-resource: external_locations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The external location was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the specified external location from the metastore. The + caller must be the owner of the external location. + get: + operationId: external-locations-get + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/get + x-stackQL-resource: external_locations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The external location was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + description: Gets an external location from the metastore. The caller must be + either a metastore admin, the owner of the external location, or a user that + has some privilege on the external location. + patch: + operationId: external-locations-update + externalDocs: + url: https://docs.databricks.com/api/workspace/externallocations/update + x-stackQL-resource: external_locations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The external location was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + metastore_id: + type: string + credential_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + browse_only: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + url: + type: string + credential_name: + type: string + read_only: + type: boolean + comment: + type: string + owner: + type: string + access_point: + type: string + isolation_mode: + type: string + new_name: + type: string + force: + type: boolean + skip_validation: + type: boolean + example: + url: string + credential_name: string + read_only: true + comment: string + owner: string + access_point: string + isolation_mode: ISOLATION_MODE_OPEN + new_name: string + force: true + skip_validation: true + description: Updates an external location in the metastore. The caller must + be the owner of the external location, or be a metastore admin. In the second + case, the admin can only update the name of the external location. + /api/2.1/unity-catalog/functions: + post: + operationId: functions-create + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/create + x-stackQL-resource: functions + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new function was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + function_info: + type: object + example: + function_info: + name: string + catalog_name: string + schema_name: string + input_params: + parameters: + - name: string + type_text: string + type_json: string + type_name: BOOLEAN + type_precision: 0 + type_scale: 0 + type_interval_type: string + position: 0 + parameter_mode: IN + parameter_type: PARAM + parameter_default: string + comment: string + data_type: BOOLEAN + full_data_type: string + return_params: + parameters: + - name: string + type_text: string + type_json: string + type_name: BOOLEAN + type_precision: 0 + type_scale: 0 + type_interval_type: string + position: 0 + parameter_mode: IN + parameter_type: PARAM + parameter_default: string + comment: string + routine_definition: string + routine_dependencies: + dependencies: + - table: + table_full_name: string + function: + function_full_name: string + is_deterministic: true + is_null_call: true + specific_name: string + external_name: string + external_language: string + sql_path: string + comment: string + properties: string + routine_body: SQL + security_type: DEFINER + sql_data_access: CONTAINS_SQL + parameter_style: S + get: + operationId: functions-list + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/list + x-stackQL-resource: functions + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The function list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + functions: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + next_page_token: + type: string + x-stackQL-objectKey: $.functions + description: List functions within the specified parent catalog and schema. + If the user is a metastore admin, all functions are returned in the output + list. Otherwise, the user must have the + /api/2.1/unity-catalog/functions/{name}: + delete: + operationId: functions-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/delete + x-stackQL-resource: functions + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The function was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: 'Deletes the function that matches the supplied name. For the deletion + to succeed, the user must satisfy one of the following conditions:' + get: + operationId: functions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/get + x-stackQL-resource: functions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The function was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + description: 'Gets a function from within a parent catalog and schema. For the + fetch to succeed, the user must satisfy one of the following requirements:' + patch: + operationId: functions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/functions/update + x-stackQL-resource: functions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The function was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + input_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + data_type: + type: string + full_data_type: + type: string + return_params: + type: object + properties: + parameters: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_json: + type: string + type_name: + type: string + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + position: + type: integer + parameter_mode: + type: string + parameter_type: + type: string + parameter_default: + type: string + comment: + type: string + routine_body: + type: string + routine_definition: + type: string + routine_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + parameter_style: + type: string + is_deterministic: + type: boolean + sql_data_access: + type: string + is_null_call: + type: boolean + security_type: + type: string + specific_name: + type: string + external_name: + type: string + external_language: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: string + metastore_id: + type: string + full_name: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + function_id: + type: string + browse_only: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + example: + owner: string + description: Updates the function that matches the supplied name. Only the owner + of the function can be updated. If the user is not a metastore admin, the + user must be a member of the group that is the new function owner. + /api/2.1/unity-catalog/permissions/{securable_type}/{full_name}: + get: + operationId: grants-get + externalDocs: + url: https://docs.databricks.com/api/workspace/grants/get + x-stackQL-resource: grants + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: full_name + required: true + description: string + in: path + - name: principal + in: query + responses: + '200': + description: The permissions list for securable was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + x-stackQL-objectKey: $.privilege_assignments + description: Gets the permissions for a securable. + patch: + operationId: grants-update + externalDocs: + url: https://docs.databricks.com/api/workspace/grants/update + x-stackQL-resource: grants + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The permissions list for securable was successfully updated. + content: + application/json: + schema: + type: object + properties: + privilege_assignments: + type: array + items: + type: object + properties: + principal: + type: string + privileges: + type: array + items: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + changes: + type: Array of object + example: + changes: + - principal: string + add: + - SELECT + remove: + - SELECT + description: Updates the permissions for a securable. + /api/2.1/unity-catalog/metastores: + post: + operationId: metastores-create + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/create + x-stackQL-resource: metastores + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new metastore was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + storage_root: + type: string + region: + type: string + example: + name: string + storage_root: string + region: string + description: Creates a new metastore based on a provided name and optional storage + root path. By default (if the + get: + operationId: metastores-list + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/list + x-stackQL-resource: metastores + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The metastore list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + metastores: + type: array + items: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + x-stackQL-objectKey: $.metastores + description: Gets an array of the available metastores (as + /api/2.1/unity-catalog/metastores/{id}: + delete: + operationId: metastores-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/delete + x-stackQL-resource: metastores + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The metastore was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a metastore. The caller must be a metastore admin. + get: + operationId: metastores-get + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/get + x-stackQL-resource: metastores + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: The metastore was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + description: Gets a metastore that matches the supplied ID. The caller must + be a metastore admin to retrieve this info. + patch: + operationId: metastores-update + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/update + x-stackQL-resource: metastores + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: The metastore was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + storage_root: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + delta_sharing_scope: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + region: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_root_credential_name: + type: string + cloud: + type: string + global_metastore_id: + type: string + external_access_enabled: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + storage_root_credential_id: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + format: int64 + delta_sharing_organization_name: + type: string + owner: + type: string + privilege_model_version: + type: string + new_name: + type: string + delta_sharing_scope: + type: string + example: + storage_root_credential_id: string + delta_sharing_recipient_token_lifetime_in_seconds: 0 + delta_sharing_organization_name: string + owner: string + privilege_model_version: string + new_name: string + delta_sharing_scope: INTERNAL + description: Updates information for a specific metastore. The caller must be + a metastore admin. If the + /api/2.1/unity-catalog/workspaces/{workspace_id}/metastore: + put: + operationId: metastore-assignments-assign + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/assign + x-stackQL-resource: metastore_assignments + x-stackQL-method: assign + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The metastore was successfully assigned. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: required + default_catalog_name: + type: string + example: + metastore_id: string + default_catalog_name: string + description: Creates a new metastore assignment. If an assignment for the same + delete: + operationId: metastore-assignments-unassign + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/unassign + x-stackQL-resource: metastore_assignments + x-stackQL-method: unassign + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: workspace_id + required: true + description: int64 + in: path + - name: metastore_id + required: true + description: string + in: query + responses: + '200': + description: The metastore assignment was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a metastore assignment. The caller must be an account administrator. + patch: + operationId: metastore-assignments-updateassignment + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/updateassignment + x-stackQL-resource: metastore_assignments + x-stackQL-method: updateassignment + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: workspace_id + required: true + description: int64 + in: path + responses: + '200': + description: The metastore assignment was successfully updated. + content: + application/json: + schema: + type: object + properties: {} + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: string + default_catalog_name: + type: string + example: + metastore_id: string + default_catalog_name: string + description: Updates a metastore assignment. This operation can be used to update + /api/2.1/unity-catalog/current-metastore-assignment: + get: + operationId: metastore-assignments-current + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/current + x-stackQL-resource: metastore_assignments + x-stackQL-method: current + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The metastore assignment was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: string + workspace_id: + type: integer + default_catalog_name: + type: string + description: Gets the metastore assignment for the workspace being accessed. + /api/2.1/unity-catalog/metastore_summary: + get: + operationId: metastore-summary-summary + externalDocs: + url: https://docs.databricks.com/api/workspace/metastores/summary + x-stackQL-resource: metastore_summary + x-stackQL-method: summary + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The metastore summary was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + metastore_id: + type: string + name: + type: string + default_data_access_config_id: + type: string + storage_root_credential_id: + type: string + cloud: + type: string + region: + type: string + global_metastore_id: + type: string + storage_root_credential_name: + type: string + privilege_model_version: + type: string + delta_sharing_recipient_token_lifetime_in_seconds: + type: integer + delta_sharing_organization_name: + type: string + storage_root: + type: string + owner: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + external_access_enabled: + type: boolean + delta_sharing_scope: + type: string + description: Gets information about a metastore. This summary includes the storage + credential, the cloud vendor, the cloud region, and the global metastore ID. + /api/2.1/unity-catalog/models/{full_name}/versions/{version}: + delete: + operationId: model-versions-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/delete + x-stackQL-resource: model_versions + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: version + required: true + description: integer + in: path + responses: + '200': + description: Successfully deleted the model version + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a model version from the specified registered model. Any + aliases assigned to the model version will also be deleted. + get: + operationId: model-versions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/get + x-stackQL-resource: model_versions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: version + required: true + description: integer + in: path + - name: include_browse + in: query + - name: include_aliases + in: query + responses: + '200': + description: Successfully retrieved the properties of the model version + content: + application/json: + schema: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a model version. + patch: + operationId: model-versions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/update + x-stackQL-resource: model_versions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: version + required: true + description: integer + in: path + responses: + '200': + description: Successfully updated the properties of the model version + content: + application/json: + schema: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + example: + comment: This is my new model version comment + description: Updates the specified model version. + /api/2.1/unity-catalog/models/{full_name}/aliases/{alias}: + get: + operationId: model-versions-getbyalias + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/getbyalias + x-stackQL-resource: model_versions + x-stackQL-method: getbyalias + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: alias + required: true + description: string + in: path + - name: include_aliases + in: query + responses: + '200': + description: Successfully retrieved the properties of the model version + content: + application/json: + schema: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + aliases: + type: array + items: + type: object + properties: + alias_name: + type: string + version_num: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a model version by alias. + delete: + operationId: registered-model-aliases-deletealias + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/deletealias + x-stackQL-resource: registered_model_aliases + x-stackQL-method: deletealias + x-stackQL-verb: delete + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: alias + required: true + description: string + in: path + responses: + '200': + description: Successfully deleted the registered model alias + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a registered model alias. + put: + operationId: registered-model-aliases-setalias + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/setalias + x-stackQL-resource: registered_model_aliases + x-stackQL-method: setalias + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: full_name + required: true + description: string + in: path + - name: alias + required: true + description: string + in: path + responses: + '200': + description: Successfully set the specified alias on the registered model + content: + application/json: + schema: + type: object + properties: + alias_name: + type: string + version_num: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + full_name: + type: required + alias: + type: string + version_num: + type: required + example: + version_num: 2 + description: Set an alias on the specified registered model. + /api/2.1/unity-catalog/models/{full_name}/versions: + get: + operationId: model-versions-list + externalDocs: + url: https://docs.databricks.com/api/workspace/modelversions/list + x-stackQL-resource: model_versions + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The model version list was successfully retrieved + content: + application/json: + schema: + type: object + properties: + model_versions: + type: array + items: + type: object + properties: + model_name: + type: string + catalog_name: + type: string + schema_name: + type: string + comment: + type: string + source: + type: string + run_id: + type: string + run_workspace_id: + type: string + version: + type: integer + status: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.model_versions + description: List model versions. You can list model versions under a particular + schema, or list all model versions in the current metastore. + /api/2.0/online-tables: + post: + operationId: online-tables-create + externalDocs: + url: https://docs.databricks.com/api/workspace/onlinetables/create + x-stackQL-resource: online_tables + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + spec: + type: object + properties: + run_continuously: + type: object + properties: {} + run_triggered: + type: object + properties: {} + source_table_full_name: + type: string + primary_key_columns: + type: array + items: + type: string + timeseries_key: + type: string + perform_full_copy: + type: boolean + pipeline_id: + type: string + status: + type: object + properties: + detailed_state: + type: string + message: + type: string + provisioning_status: + type: object + properties: + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + continuous_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + triggered_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + triggered_update_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + table_serving_url: + type: string + unity_catalog_provisioning_state: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + spec: + type: object + example: + name: string + spec: + run_continuously: {} + run_triggered: {} + source_table_full_name: string + primary_key_columns: + - string + timeseries_key: string + perform_full_copy: false + pipeline_id: string + description: Online Table information. + description: Create a new Online Table. + /api/2.0/online-tables/{name}: + delete: + operationId: online-tables-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/onlinetables/delete + x-stackQL-resource: online_tables + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + description: 'Delete an online table. Warning: This will delete all the data + in the online table. If the source Delta table was deleted or modified since + this Online Table was created, this will lose the data forever!' + get: + operationId: online-tables-get + externalDocs: + url: https://docs.databricks.com/api/workspace/onlinetables/get + x-stackQL-resource: online_tables + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + name: + type: string + spec: + type: object + properties: + run_continuously: + type: object + properties: {} + run_triggered: + type: object + properties: {} + source_table_full_name: + type: string + primary_key_columns: + type: array + items: + type: string + timeseries_key: + type: string + perform_full_copy: + type: boolean + pipeline_id: + type: string + status: + type: object + properties: + detailed_state: + type: string + message: + type: string + provisioning_status: + type: object + properties: + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + continuous_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + initial_pipeline_sync_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + triggered_update_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + triggered_update_progress: + type: object + properties: + latest_version_currently_processing: + type: integer + synced_row_count: + type: integer + total_row_count: + type: integer + sync_progress_completion: + type: number + estimated_completion_time_seconds: + type: number + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + timestamp: + type: string + table_serving_url: + type: string + unity_catalog_provisioning_state: + type: string + description: Get information about an existing online table and its status. + /api/2.1/unity-catalog/tables/{table_name}/monitor: + post: + operationId: quality-monitors-create + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/create + x-stackQL-resource: quality_monitors + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The new monitor was successfully created. + content: + application/json: + schema: + type: object + properties: + assets_dir: + type: string + output_schema_name: + type: string + inference_log: + type: object + properties: + problem_type: + type: string + timestamp_col: + type: string + granularities: + type: array + items: + type: string + prediction_col: + type: string + label_col: + type: string + model_id_col: + type: string + prediction_proba_col: + type: string + time_series: + type: object + properties: + timestamp_col: + type: string + granularities: + type: array + items: + type: string + snapshot: + type: object + properties: {} + slicing_exprs: + type: array + items: + type: string + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + definition: + type: string + input_columns: + type: array + items: + type: string + output_data_type: + type: string + type: + type: string + baseline_table_name: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + notifications: + type: object + properties: + on_failure: + type: object + properties: + email_addresses: + type: array + items: + type: string + table_name: + type: string + status: + type: string + latest_monitor_failure_msg: + type: string + profile_metrics_table_name: + type: string + drift_metrics_table_name: + type: string + dashboard_id: + type: string + monitor_version: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + skip_builtin_dashboard: + type: boolean + warehouse_id: + type: string + assets_dir: + type: required + output_schema_name: + type: string + snapshot: + type: required + slicing_exprs: + type: string + baseline_table_name: + type: object + inference_log: + type: object + time_series: + type: object + custom_metrics: + type: Array of object + schedule: + type: object + notifications: + type: object + example: + skip_builtin_dashboard: true + warehouse_id: string + assets_dir: string + output_schema_name: string + inference_log: + problem_type: PROBLEM_TYPE_CLASSIFICATION + timestamp_col: string + granularities: + - string + prediction_col: string + label_col: string + model_id_col: string + prediction_proba_col: string + time_series: + timestamp_col: string + granularities: + - string + snapshot: {} + slicing_exprs: + - string + custom_metrics: + - name: string + definition: string + input_columns: + - string + output_data_type: string + type: CUSTOM_METRIC_TYPE_AGGREGATE + baseline_table_name: string + schedule: + quartz_cron_expression: string + timezone_id: string + pause_status: UNPAUSED + notifications: + on_failure: + email_addresses: + - string + description: Creates a new monitor for the specified table. + delete: + operationId: quality-monitors-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/delete + x-stackQL-resource: quality_monitors + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The monitor was successfully deleted. + description: Deletes a monitor for the specified table. + get: + operationId: quality-monitors-get + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/get + x-stackQL-resource: quality_monitors + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The monitor was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + assets_dir: + type: string + output_schema_name: + type: string + inference_log: + type: object + properties: + problem_type: + type: string + timestamp_col: + type: string + granularities: + type: array + items: + type: string + prediction_col: + type: string + label_col: + type: string + model_id_col: + type: string + prediction_proba_col: + type: string + time_series: + type: object + properties: + timestamp_col: + type: string + granularities: + type: array + items: + type: string + snapshot: + type: object + properties: {} + slicing_exprs: + type: array + items: + type: string + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + definition: + type: string + input_columns: + type: array + items: + type: string + output_data_type: + type: string + type: + type: string + baseline_table_name: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + notifications: + type: object + properties: + on_failure: + type: object + properties: + email_addresses: + type: array + items: + type: string + table_name: + type: string + status: + type: string + latest_monitor_failure_msg: + type: string + profile_metrics_table_name: + type: string + drift_metrics_table_name: + type: string + dashboard_id: + type: string + monitor_version: + type: string + description: Gets a monitor for the specified table. + put: + operationId: quality-monitors-update + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/update + x-stackQL-resource: quality_monitors + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The monitor was successfully updated. + content: + application/json: + schema: + type: object + properties: + assets_dir: + type: string + output_schema_name: + type: string + inference_log: + type: object + properties: + problem_type: + type: string + timestamp_col: + type: string + granularities: + type: array + items: + type: string + prediction_col: + type: string + label_col: + type: string + model_id_col: + type: string + prediction_proba_col: + type: string + time_series: + type: object + properties: + timestamp_col: + type: string + granularities: + type: array + items: + type: string + snapshot: + type: object + properties: {} + slicing_exprs: + type: array + items: + type: string + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + definition: + type: string + input_columns: + type: array + items: + type: string + output_data_type: + type: string + type: + type: string + baseline_table_name: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + notifications: + type: object + properties: + on_failure: + type: object + properties: + email_addresses: + type: array + items: + type: string + table_name: + type: string + status: + type: string + latest_monitor_failure_msg: + type: string + profile_metrics_table_name: + type: string + drift_metrics_table_name: + type: string + dashboard_id: + type: string + monitor_version: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + output_schema_name: + type: required + snapshot: + type: string + slicing_exprs: + type: object + baseline_table_name: + type: Array of string + dashboard_id: + type: string + inference_log: + type: object + time_series: + type: object + custom_metrics: + type: Array of object + schedule: + type: object + notifications: + type: object + example: + output_schema_name: string + inference_log: + problem_type: PROBLEM_TYPE_CLASSIFICATION + timestamp_col: string + granularities: + - string + prediction_col: string + label_col: string + model_id_col: string + prediction_proba_col: string + time_series: + timestamp_col: string + granularities: + - string + snapshot: {} + slicing_exprs: + - string + custom_metrics: + - name: string + definition: string + input_columns: + - string + output_data_type: string + type: CUSTOM_METRIC_TYPE_AGGREGATE + baseline_table_name: string + schedule: + quartz_cron_expression: string + timezone_id: string + pause_status: UNPAUSED + notifications: + on_failure: + email_addresses: + - string + dashboard_id: string + description: Updates a monitor for the specified table. + /api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes/{refresh_id}: + get: + operationId: quality-monitor-refreshes-getrefresh + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/getrefresh + x-stackQL-resource: quality_monitor_refreshes + x-stackQL-method: getrefresh + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: table_name + required: true + description: string + in: path + - name: refresh_id + required: true + description: string + in: path + responses: + '200': + description: The refresh info was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + refresh_id: + type: integer + state: + type: string + message: + type: string + start_time_ms: + type: integer + end_time_ms: + type: integer + trigger: + type: string + description: Gets info about a specific monitor refresh using the given refresh + ID. + /api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes: + get: + operationId: quality-monitor-refreshes-listrefreshes + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/listrefreshes + x-stackQL-resource: quality_monitor_refreshes + x-stackQL-method: listrefreshes + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The list of refresh info was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + refreshes: + type: array + items: + type: object + properties: + refresh_id: + type: integer + state: + type: string + message: + type: string + start_time_ms: + type: integer + end_time_ms: + type: integer + trigger: + type: string + x-stackQL-objectKey: $.refreshes + description: Gets an array containing the history of the most recent refreshes + (up to 25) for this table. + post: + operationId: quality-monitor-refreshes-runrefresh + externalDocs: + url: https://docs.databricks.com/api/workspace/qualitymonitors/runrefresh + x-stackQL-resource: quality_monitor_refreshes + x-stackQL-method: runrefresh + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: table_name + required: true + description: string + in: path + responses: + '200': + description: The metric refresh was successfully queued. + content: + application/json: + schema: + type: object + properties: + refresh_id: + type: integer + state: + type: string + message: + type: string + start_time_ms: + type: integer + end_time_ms: + type: integer + trigger: + type: string + description: Queues a metric refresh on the monitor for the specified table. + The refresh will execute in the background. + /api/2.1/unity-catalog/models: + post: + operationId: registered-models-create + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/create + x-stackQL-resource: registered_models + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successfully created the registered model + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: required + schema_name: + type: string + name: + type: required + storage_location: + type: string + comment: + type: required + example: + name: revenue_forecasting_model + catalog_name: main + schema_name: default + comment: This model contains model versions that forecast future revenue, + given historical data + description: Creates a new registered model in Unity Catalog. + get: + operationId: registered-models-list + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/list + x-stackQL-resource: registered_models + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: catalog_name + in: query + - name: schema_name + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The registered model list was successfully retrieved + content: + application/json: + schema: + type: object + properties: + registered_models: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.registered_models + description: List registered models. You can list registered models under a + particular schema, or list all registered models in the current metastore. + /api/2.1/unity-catalog/models/{full_name}: + delete: + operationId: registered-models-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/delete + x-stackQL-resource: registered_models + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: Successfully deleted the registered model + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a registered model and all its model versions from the + specified parent catalog and schema. + get: + operationId: registered-models-get + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/get + x-stackQL-resource: registered_models + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: include_browse + in: query + - name: include_aliases + in: query + responses: + '200': + description: Successfully retrieved the properties of the registered model + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get a registered model. + patch: + operationId: registered-models-update + externalDocs: + url: https://docs.databricks.com/api/workspace/registeredmodels/update + x-stackQL-resource: registered_models + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: Successfully updated the properties of the registered model + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + full_name: + type: string + owner: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + securable_type: + type: string + securable_kind: + type: string + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + new_name: + type: string + example: + new_name: my_new_model + description: Updates the specified registered model. + /api/2.1/unity-catalog/resource-quotas/{parent_securable_type}/{parent_full_name}/{quota_name}: + get: + operationId: resource-quotas-getquota + externalDocs: + url: https://docs.databricks.com/api/workspace/resourcequotas/getquota + x-stackQL-resource: resource_quotas + x-stackQL-method: getquota + x-stackQL-verb: select + x-numReqParams: 3 + parameters: + - name: parent_securable_type + required: true + description: string + in: path + - name: parent_full_name + required: true + description: string + in: path + - name: quota_name + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + quota_info: + type: object + properties: + parent_securable_type: + type: string + parent_full_name: + type: string + quota_name: + type: string + quota_count: + type: integer + quota_limit: + type: integer + last_refreshed_at: + type: integer + x-stackQL-objectKey: $.quota_info + description: The GetQuota API returns usage information for a single resource + quota, defined as a child-parent pair. This API also refreshes the quota count + if it is out of date. Refreshes are triggered asynchronously. The updated + count might not be returned in the first call. + /api/2.1/unity-catalog/resource-quotas/all-resource-quotas: + get: + operationId: resource-quotas-listquotas + externalDocs: + url: https://docs.databricks.com/api/workspace/resourcequotas/listquotas + x-stackQL-resource: resource_quotas + x-stackQL-method: listquotas + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + quotas: + type: array + items: + type: object + properties: + parent_securable_type: + type: string + parent_full_name: + type: string + quota_name: + type: string + quota_count: + type: integer + quota_limit: + type: integer + last_refreshed_at: + type: integer + next_page_token: + type: string + x-stackQL-objectKey: $.quotas + description: ListQuotas returns all quota values under the metastore. There + are no SLAs on the freshness of the counts returned. This API does not trigger + a refresh of quota counts. + /api/2.1/unity-catalog/schemas: + post: + operationId: schemas-create + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/create + x-stackQL-resource: schemas + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new schema was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + catalog_name: + type: string + comment: + type: required + storage_root: + type: string + properties: + type: object + example: + name: string + catalog_name: string + comment: string + properties: + property1: string + property2: string + storage_root: string + description: Creates a new schema for catalog in the Metatastore. The caller + must be a metastore admin, or have the + get: + operationId: schemas-list + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/list + x-stackQL-resource: schemas + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The schemas list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.schemas + description: Gets an array of schemas for a catalog in the metastore. If the + caller is the metastore admin or the owner of the parent catalog, all schemas + for the catalog will be retrieved. Otherwise, only schemas owned by the caller + (or for which the caller has the + /api/2.1/unity-catalog/schemas/{full_name}: + delete: + operationId: schemas-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/delete + x-stackQL-resource: schemas + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The schema was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes the specified schema from the parent catalog. The caller + must be the owner of the schema or an owner of the parent catalog. + get: + operationId: schemas-get + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/get + x-stackQL-resource: schemas + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: The schema was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + description: Gets the specified schema within the metastore. The caller must + be a metastore admin, the owner of the schema, or a user that has the + patch: + operationId: schemas-update + externalDocs: + url: https://docs.databricks.com/api/workspace/schemas/update + x-stackQL-resource: schemas + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The schema was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_root: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + storage_location: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + catalog_type: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + browse_only: + type: boolean + schema_id: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + enable_predictive_optimization: + type: string + new_name: + type: string + properties: + type: object + example: + owner: string + comment: string + properties: + property1: string + property2: string + enable_predictive_optimization: DISABLE + new_name: string + description: Updates a schema for a catalog. The caller must be the owner of + the schema or a metastore admin. If the caller is a metastore admin, only + the + /api/2.1/unity-catalog/storage-credentials: + post: + operationId: storage-credentials-create + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/create + x-stackQL-resource: storage_credentials + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new storage credential was successfully created. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + comment: + type: string + read_only: + type: string + skip_validation: + type: boolean + aws_iam_role: + type: object + example: + name: string + comment: string + read_only: true + aws_iam_role: + role_arn: string + skip_validation: false + description: Creates a new storage credential. + get: + operationId: storage-credentials-list + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/list + x-stackQL-resource: storage_credentials + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The storage credentials list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + storage_credentials: + type: array + items: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.storage_credentials + description: Gets an array of storage credentials (as + /api/2.1/unity-catalog/storage-credentials/{name}: + delete: + operationId: storage-credentials-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/delete + x-stackQL-resource: storage_credentials + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: force + in: query + responses: + '200': + description: The storage credential was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a storage credential from the metastore. The caller must + be an owner of the storage credential. + get: + operationId: storage-credentials-get + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/get + x-stackQL-resource: storage_credentials + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The storage credential was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + description: Gets a storage credential from the metastore. The caller must be + a metastore admin, the owner of the storage credential, or have some permission + on the storage credential. + patch: + operationId: storage-credentials-update + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/update + x-stackQL-resource: storage_credentials + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: The storage credential was successfully updated. + content: + application/json: + schema: + type: object + properties: + name: + type: string + aws_iam_role: + type: object + properties: + role_arn: + type: string + unity_catalog_iam_arn: + type: string + external_id: + type: string + comment: + type: string + read_only: + type: boolean + owner: + type: string + full_name: + type: string + id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + used_for_managed_storage: + type: boolean + isolation_mode: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + comment: + type: string + read_only: + type: boolean + owner: + type: string + isolation_mode: + type: string + new_name: + type: string + skip_validation: + type: boolean + force: + type: boolean + aws_iam_role: + type: object + example: + comment: string + read_only: true + owner: string + aws_iam_role: + role_arn: string + isolation_mode: ISOLATION_MODE_OPEN + new_name: string + skip_validation: false + force: true + description: Updates a storage credential on the metastore. + /api/2.1/unity-catalog/validate-storage-credentials: + post: + operationId: storage-credential-validation-validate + externalDocs: + url: https://docs.databricks.com/api/workspace/storagecredentials/validate + x-stackQL-resource: storage_credential_validation + x-stackQL-method: validate + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The storage credential validation operation completed successfully. + content: + application/json: + schema: + type: object + properties: + isDir: + type: boolean + results: + type: array + items: + type: object + properties: + operation: + type: string + result: + type: string + message: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + storage_credential_name: + type: string + external_location_name: + type: string + url: + type: string + read_only: + type: boolean + aws_iam_role: + type: object + example: + storage_credential_name: string + aws_iam_role: + role_arn: string + external_location_name: string + url: string + read_only: true + description: Validates a storage credential. At least one of + /api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas/{schema_name}: + delete: + operationId: system-schemas-disable + externalDocs: + url: https://docs.databricks.com/api/workspace/systemschemas/disable + x-stackQL-resource: system_schemas + x-stackQL-method: disable + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: metastore_id + required: true + description: string + in: path + - name: schema_name + required: true + description: string + in: path + responses: + '200': + description: The schema was successfully disabled. + description: Disables the system schema and removes it from the system catalog. + The caller must be an account admin or a metastore admin. + put: + operationId: system-schemas-enable + externalDocs: + url: https://docs.databricks.com/api/workspace/systemschemas/enable + x-stackQL-resource: system_schemas + x-stackQL-method: enable + x-stackQL-verb: exec + x-numReqParams: 2 + parameters: + - name: metastore_id + required: true + description: string + in: path + - name: schema_name + required: true + description: string + in: path + responses: + '200': + description: The system schema was successfully enabled. + description: Enables the system schema and adds it to the system catalog. The + caller must be an account admin or a metastore admin. + /api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas: + get: + operationId: system-schemas-list + externalDocs: + url: https://docs.databricks.com/api/workspace/systemschemas/list + x-stackQL-resource: system_schemas + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: metastore_id + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: The schemas list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: object + properties: + schema: + type: string + state: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.schemas + description: Gets an array of system schemas for a metastore. The caller must + be an account admin or a metastore admin. + /api/2.1/unity-catalog/tables/{full_name}: + delete: + operationId: tables-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/delete + x-stackQL-resource: tables + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The table was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a table from the specified parent catalog and schema. The + caller must be the owner of the parent catalog, have the + get: + operationId: tables-get + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/get + x-stackQL-resource: tables + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + - name: include_delta_metadata + in: query + - name: include_browse + in: query + - name: include_manifest_capabilities + in: query + responses: + '200': + description: The table was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + table_type: + type: string + data_source_format: + type: string + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + storage_location: + type: string + view_definition: + type: string + view_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_credential_name: + type: string + table_constraints: + type: array + items: + type: object + properties: + primary_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + foreign_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + parent_table: + type: string + parent_columns: + type: array + items: + type: string + named_table_constraint: + type: object + properties: + name: + type: string + row_filter: + type: object + properties: + function_name: + type: string + input_column_names: + type: array + items: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + data_access_configuration_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + deleted_at: + type: integer + table_id: + type: string + delta_runtime_properties_kvpairs: + type: object + properties: + delta_runtime_properties: + type: object + properties: + property1: + type: string + property2: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + access_point: + type: string + pipeline_id: + type: string + browse_only: + type: boolean + description: 'Gets a table from the metastore for a specific catalog and schema. + The caller must satisfy one of the following requirements:' + /api/2.1/unity-catalog/tables: + get: + operationId: tables-list + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/list + x-stackQL-resource: tables + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_delta_metadata + in: query + - name: omit_columns + in: query + - name: omit_properties + in: query + - name: omit_username + in: query + - name: include_browse + in: query + - name: include_manifest_capabilities + in: query + responses: + '200': + description: The tables list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + tables: + type: array + items: + type: object + properties: + name: + type: string + catalog_name: + type: string + schema_name: + type: string + table_type: + type: string + data_source_format: + type: string + columns: + type: array + items: + type: object + properties: + name: + type: string + type_text: + type: string + type_name: + type: string + position: + type: integer + type_precision: + type: integer + type_scale: + type: integer + type_interval_type: + type: string + type_json: + type: string + comment: + type: string + nullable: + type: boolean + partition_index: + type: integer + mask: + type: object + properties: + function_name: + type: string + using_column_names: + type: array + items: + type: string + storage_location: + type: string + view_definition: + type: string + view_dependencies: + type: object + properties: + dependencies: + type: array + items: + type: object + properties: + table: + type: object + properties: + table_full_name: + type: string + function: + type: object + properties: + function_full_name: + type: string + sql_path: + type: string + owner: + type: string + comment: + type: string + properties: + type: object + properties: + property1: + type: string + property2: + type: string + storage_credential_name: + type: string + table_constraints: + type: array + items: + type: object + properties: + primary_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + foreign_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + parent_table: + type: string + parent_columns: + type: array + items: + type: string + named_table_constraint: + type: object + properties: + name: + type: string + row_filter: + type: object + properties: + function_name: + type: string + input_column_names: + type: array + items: + type: string + enable_predictive_optimization: + type: string + metastore_id: + type: string + full_name: + type: string + data_access_configuration_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + deleted_at: + type: integer + table_id: + type: string + delta_runtime_properties_kvpairs: + type: object + properties: + delta_runtime_properties: + type: object + properties: + property1: + type: string + property2: + type: string + effective_predictive_optimization_flag: + type: object + properties: + value: + type: string + inherited_from_type: + type: string + inherited_from_name: + type: string + access_point: + type: string + pipeline_id: + type: string + browse_only: + type: boolean + next_page_token: + type: string + x-stackQL-objectKey: $.tables + description: Gets an array of all tables for the current metastore under the + parent catalog and schema. The caller must be a metastore admin or an owner + of (or have the + /api/2.1/unity-catalog/constraints: + post: + operationId: table-constraints-create + externalDocs: + url: https://docs.databricks.com/api/workspace/tableconstraints/create + x-stackQL-resource: table_constraints + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: The new table constraint was successfully created. + content: + application/json: + schema: + type: object + properties: + primary_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + foreign_key_constraint: + type: object + properties: + name: + type: string + child_columns: + type: array + items: + type: string + parent_table: + type: string + parent_columns: + type: array + items: + type: string + named_table_constraint: + type: object + properties: + name: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + full_name_arg: + type: required + constraint: + type: required + example: + full_name_arg: string + constraint: + primary_key_constraint: + name: string + child_columns: + - string + foreign_key_constraint: + name: string + child_columns: + - string + parent_table: string + parent_columns: + - string + named_table_constraint: + name: string + description: Creates a new table constraint. + /api/2.1/unity-catalog/constraints/{full_name}: + delete: + operationId: table-constraints-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/tableconstraints/delete + x-stackQL-resource: table_constraints + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 3 + parameters: + - name: full_name + required: true + description: string + in: path + - name: constraint_name + required: true + description: string + in: query + - name: cascade + required: true + description: boolean + in: query + responses: + '200': + description: The table constraint was successfully deleted. + content: + application/json: + schema: + type: object + properties: {} + description: Deletes a table constraint. + /api/2.1/unity-catalog/tables/{full_name}/exists: + get: + operationId: table-exists-exists + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/exists + x-stackQL-resource: table_exists + x-stackQL-method: exists + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: full_name + required: true + description: string + in: path + responses: + '200': + description: The boolean reflecting if the table exists was successfully + returned. + content: + application/json: + schema: + type: object + properties: + table_exists: + type: boolean + description: 'Gets if a table exists in the metastore for a specific catalog + and schema. The caller must satisfy one of the following requirements:' + /api/2.1/unity-catalog/table-summaries: + get: + operationId: table-summaries-listsummaries + externalDocs: + url: https://docs.databricks.com/api/workspace/tables/listsummaries + x-stackQL-resource: table_summaries + x-stackQL-method: listsummaries + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name_pattern + in: query + - name: table_name_pattern + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_manifest_capabilities + in: query + responses: + '200': + description: The table summaries list was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + tables: + type: array + items: + type: object + properties: + full_name: + type: string + table_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.tables + description: 'Gets an array of summaries for tables for a schema and catalog + within the metastore. The table summaries returned are either:' + /api/2.0/unity-catalog/temporary-table-credentials: + post: + operationId: temporary-table-credentials-generatetemporarytablecredentials + externalDocs: + url: https://docs.databricks.com/api/workspace/temporarytablecredentials/generatetemporarytablecredentials + x-stackQL-resource: temporary_table_credentials + x-stackQL-method: generatetemporarytablecredentials + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + aws_temp_credentials: + type: object + properties: + access_key_id: + type: string + secret_access_key: + type: string + session_token: + type: string + access_point: + type: string + azure_user_delegation_sas: + type: object + properties: + sas_token: + type: string + gcp_oauth_token: + type: object + properties: + oauth_token: + type: string + r2_temp_credentials: + type: object + properties: + access_key_id: + type: string + secret_access_key: + type: string + session_token: + type: string + expiration_time: + type: integer + url: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + table_id: + type: string + operation: + type: string + example: + table_id: string + operation: READ + description: Get a short-lived credential for directly accessing the table data + on cloud storage. The metastore must have external_access_enabled flag set + to true (default false). The caller must have EXTERNAL_USE_SCHEMA privilege + on the parent schema and this privilege can only be granted by catalog owners. + /api/2.1/unity-catalog/volumes: + post: + operationId: volumes-create + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/create + x-stackQL-resource: volumes + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successfully created the volume + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: required + schema_name: + type: string + name: + type: required + volume_type: + type: string + storage_location: + type: required + comment: + type: string + example: + catalog_name: main + schema_name: default + name: my_volume + volume_type: EXTERNAL + storage_location: s3://my-bucket/hello/world/my-volume + comment: This is my first volume + description: Creates a new volume. + get: + operationId: volumes-list + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/list + x-stackQL-resource: volumes + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: catalog_name + required: true + description: string + in: query + - name: schema_name + required: true + description: string + in: query + - name: max_results + in: query + - name: page_token + in: query + - name: include_browse + in: query + responses: + '200': + description: The volume list was successfully retrieved + content: + application/json: + schema: + type: object + properties: + volumes: + type: array + items: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + x-stackQL-objectKey: $.volumes + description: Gets an array of volumes for the current metastore under the parent + catalog and schema. + /api/2.1/unity-catalog/volumes/{name}: + delete: + operationId: volumes-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/delete + x-stackQL-resource: volumes + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Successfully deleted the volume + description: Deletes a volume from the specified parent catalog and schema. + get: + operationId: volumes-read + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/read + x-stackQL-resource: volumes + x-stackQL-method: read + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + - name: include_browse + in: query + responses: + '200': + description: Successfully retrieved the properties of the volume + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + description: Gets a volume from the metastore for a specific catalog and schema. + patch: + operationId: volumes-update + externalDocs: + url: https://docs.databricks.com/api/workspace/volumes/update + x-stackQL-resource: volumes + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: Successfully updated the properties of the volume + content: + application/json: + schema: + type: object + properties: + catalog_name: + type: string + schema_name: + type: string + name: + type: string + full_name: + type: string + volume_type: + type: string + owner: + type: string + volume_id: + type: string + metastore_id: + type: string + created_at: + type: integer + created_by: + type: string + updated_at: + type: integer + updated_by: + type: string + storage_location: + type: string + comment: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + comment: + type: string + new_name: + type: string + example: + new_name: my_new_volume + description: Updates the specified volume under the specified parent catalog + and schema. + /api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}: + get: + operationId: workspace-bindings-getbindings + externalDocs: + url: https://docs.databricks.com/api/workspace/workspacebindings/getbindings + x-stackQL-resource: workspace_bindings + x-stackQL-method: getbindings + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: securable_name + required: true + description: string + in: path + - name: max_results + in: query + - name: page_token + in: query + responses: + '200': + description: A list of workspace IDs that are bound to the securable + content: + application/json: + schema: + type: object + properties: + bindings: + type: array + items: + type: object + properties: + workspace_id: + type: integer + binding_type: + type: string + next_page_token: + type: string + x-stackQL-objectKey: $.bindings + description: Gets workspace bindings of the securable. The caller must be a + metastore admin or an owner of the securable. + patch: + operationId: workspace-bindings-updatebindings + externalDocs: + url: https://docs.databricks.com/api/workspace/workspacebindings/updatebindings + x-stackQL-resource: workspace_bindings + x-stackQL-method: updatebindings + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: securable_type + required: true + description: string + in: path + - name: securable_name + required: true + description: string + in: path + responses: + '200': + description: A list of workspace bindings that are bound to the securable. + content: + application/json: + schema: + type: object + properties: + bindings: + type: array + items: + type: object + properties: + workspace_id: + type: integer + binding_type: + type: string + next_page_token: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + add: + type: Array of object + remove: + type: Array of object + example: + add: + - workspace_id: 0 + binding_type: BINDING_TYPE_READ_WRITE + remove: + - workspace_id: 0 + binding_type: BINDING_TYPE_READ_WRITE + description: Updates workspace bindings of the securable. The caller must be + a metastore admin or an owner of the securable. + /api/2.1/unity-catalog/workspace-bindings/catalogs/{name}: + patch: + operationId: workspace-bindings-update + externalDocs: + url: https://docs.databricks.com/api/workspace/workspacebindings/update + x-stackQL-resource: workspace_bindings + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: name + required: true + description: string + in: path + responses: + '200': + description: A list of workspace IDs that are bound to the catalog. + content: + application/json: + schema: + type: object + properties: + workspaces: + type: array + items: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + assign_workspaces: + type: Array of int64 + unassign_workspaces: + type: Array of int64 + example: + assign_workspaces: + - 0 + unassign_workspaces: + - 0 + description: Updates workspace bindings of the catalog. The caller must be a + metastore admin or an owner of the catalog. +components: + x-stackQL-resources: + artifact_allow_lists: + id: databricks_workspace.unitycatalog.artifact_allow_lists + name: artifact_allow_lists + title: Artifact_allow_lists + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1artifact-allowlists~1{artifact_type}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1artifact-allowlists~1{artifact_type}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/artifact_allow_lists/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/artifact_allow_lists/methods/update' + replace: [] + delete: [] + exec: [] + catalogs: + id: databricks_workspace.unitycatalog.catalogs + name: catalogs + title: Catalogs + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.catalogs + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1catalogs~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/get' + - $ref: '#/components/x-stackQL-resources/catalogs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/catalogs/methods/delete' + exec: [] + connections: + id: databricks_workspace.unitycatalog.connections + name: connections + title: Connections + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1connections~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connections/methods/get' + - $ref: '#/components/x-stackQL-resources/connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete' + exec: [] + credentials: + id: databricks_workspace.unitycatalog.credentials + name: credentials + title: Credentials + methods: + createcredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listcredentials: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.credentials + deletecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials~1{name_arg}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getcredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials~1{name_arg}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1credentials~1{name_arg}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + generatetemporaryservicecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1temporary-service-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credentials/methods/generatetemporaryservicecredential' + - $ref: '#/components/x-stackQL-resources/credentials/methods/getcredential' + - $ref: '#/components/x-stackQL-resources/credentials/methods/listcredentials' + insert: + - $ref: '#/components/x-stackQL-resources/credentials/methods/createcredential' + update: + - $ref: '#/components/x-stackQL-resources/credentials/methods/updatecredential' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/credentials/methods/deletecredential' + exec: [] + credential_validation: + id: databricks_workspace.unitycatalog.credential_validation + name: credential_validation + title: Credential_validation + methods: + validatecredential: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1validate-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credential_validation/methods/validatecredential' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + effective_grants: + id: databricks_workspace.unitycatalog.effective_grants + name: effective_grants + title: Effective_grants + methods: + geteffective: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1effective-permissions~1{securable_type}~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.privilege_assignments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/effective_grants/methods/geteffective' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + external_locations: + id: databricks_workspace.unitycatalog.external_locations + name: external_locations + title: External_locations + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.external_locations + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1external-locations~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/get' + - $ref: '#/components/x-stackQL-resources/external_locations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/external_locations/methods/delete' + exec: [] + functions: + id: databricks_workspace.unitycatalog.functions + name: functions + title: Functions + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.functions + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1functions~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/functions/methods/get' + - $ref: '#/components/x-stackQL-resources/functions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/functions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete' + exec: [] + grants: + id: databricks_workspace.unitycatalog.grants + name: grants + title: Grants + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1permissions~1{securable_type}~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.privilege_assignments + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1permissions~1{securable_type}~1{full_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/grants/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/grants/methods/update' + replace: [] + delete: [] + exec: [] + metastores: + id: databricks_workspace.unitycatalog.metastores + name: metastores + title: Metastores + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.metastores + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastores/methods/get' + - $ref: '#/components/x-stackQL-resources/metastores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/metastores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/metastores/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/metastores/methods/delete' + exec: [] + metastore_assignments: + id: databricks_workspace.unitycatalog.metastore_assignments + name: metastore_assignments + title: Metastore_assignments + methods: + assign: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspaces~1{workspace_id}~1metastore/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + unassign: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspaces~1{workspace_id}~1metastore/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updateassignment: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspaces~1{workspace_id}~1metastore/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + current: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1current-metastore-assignment/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/current' + insert: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/assign' + update: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/updateassignment' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/metastore_assignments/methods/unassign' + exec: [] + metastore_summary: + id: databricks_workspace.unitycatalog.metastore_summary + name: metastore_summary + title: Metastore_summary + methods: + summary: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastore_summary/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metastore_summary/methods/summary' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + model_versions: + id: databricks_workspace.unitycatalog.model_versions + name: model_versions + title: Model_versions + methods: + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions~1{version}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions~1{version}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions~1{version}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getbyalias: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1aliases~1{alias}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1versions/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.model_versions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/list' + - $ref: '#/components/x-stackQL-resources/model_versions/methods/getbyalias' + - $ref: '#/components/x-stackQL-resources/model_versions/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/model_versions/methods/delete' + exec: [] + registered_model_aliases: + id: databricks_workspace.unitycatalog.registered_model_aliases + name: registered_model_aliases + title: Registered_model_aliases + methods: + deletealias: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1aliases~1{alias}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setalias: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}~1aliases~1{alias}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/registered_model_aliases/methods/setalias' + delete: + - $ref: '#/components/x-stackQL-resources/registered_model_aliases/methods/deletealias' + exec: [] + online_tables: + id: databricks_workspace.unitycatalog.online_tables + name: online_tables + title: Online_tables + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1online-tables/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1online-tables~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1online-tables~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/online_tables/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/online_tables/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/online_tables/methods/delete' + exec: [] + quality_monitors: + id: databricks_workspace.unitycatalog.quality_monitors + name: quality_monitors + title: Quality_monitors + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/quality_monitors/methods/delete' + exec: [] + quality_monitor_refreshes: + id: databricks_workspace.unitycatalog.quality_monitor_refreshes + name: quality_monitor_refreshes + title: Quality_monitor_refreshes + methods: + getrefresh: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor~1refreshes~1{refresh_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listrefreshes: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor~1refreshes/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.refreshes + runrefresh: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{table_name}~1monitor~1refreshes/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quality_monitor_refreshes/methods/listrefreshes' + - $ref: '#/components/x-stackQL-resources/quality_monitor_refreshes/methods/getrefresh' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/quality_monitor_refreshes/methods/runrefresh' + registered_models: + id: databricks_workspace.unitycatalog.registered_models + name: registered_models + title: Registered_models + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.registered_models + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1models~1{full_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/get' + - $ref: '#/components/x-stackQL-resources/registered_models/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/registered_models/methods/delete' + exec: [] + resource_quotas: + id: databricks_workspace.unitycatalog.resource_quotas + name: resource_quotas + title: Resource_quotas + methods: + getquota: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1resource-quotas~1{parent_securable_type}~1{parent_full_name}~1{quota_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.quota_info + listquotas: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1resource-quotas~1all-resource-quotas/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.quotas + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_quotas/methods/listquotas' + - $ref: '#/components/x-stackQL-resources/resource_quotas/methods/getquota' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + schemas: + id: databricks_workspace.unitycatalog.schemas + name: schemas + title: Schemas + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemas + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1schemas~1{full_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/schemas/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/schemas/methods/delete' + exec: [] + storage_credentials: + id: databricks_workspace.unitycatalog.storage_credentials + name: storage_credentials + title: Storage_credentials + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.storage_credentials + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1storage-credentials~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/storage_credentials/methods/delete' + exec: [] + storage_credential_validation: + id: databricks_workspace.unitycatalog.storage_credential_validation + name: storage_credential_validation + title: Storage_credential_validation + methods: + validate: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1validate-storage-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/storage_credential_validation/methods/validate' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + system_schemas: + id: databricks_workspace.unitycatalog.system_schemas + name: system_schemas + title: System_schemas + methods: + disable: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{metastore_id}~1systemschemas~1{schema_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{metastore_id}~1systemschemas~1{schema_name}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1metastores~1{metastore_id}~1systemschemas/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemas + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/system_schemas/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/system_schemas/methods/enable' + - $ref: '#/components/x-stackQL-resources/system_schemas/methods/disable' + tables: + id: databricks_workspace.unitycatalog.tables + name: tables + title: Tables + methods: + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{full_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.tables + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tables/methods/list' + - $ref: '#/components/x-stackQL-resources/tables/methods/get' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete' + exec: [] + table_constraints: + id: databricks_workspace.unitycatalog.table_constraints + name: table_constraints + title: Table_constraints + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1constraints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1constraints~1{full_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/table_constraints/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/table_constraints/methods/delete' + exec: [] + table_exists: + id: databricks_workspace.unitycatalog.table_exists + name: table_exists + title: Table_exists + methods: + exists: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1tables~1{full_name}~1exists/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/table_exists/methods/exists' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + table_summaries: + id: databricks_workspace.unitycatalog.table_summaries + name: table_summaries + title: Table_summaries + methods: + listsummaries: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1table-summaries/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.tables + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/table_summaries/methods/listsummaries' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + temporary_table_credentials: + id: databricks_workspace.unitycatalog.temporary_table_credentials + name: temporary_table_credentials + title: Temporary_table_credentials + methods: + generatetemporarytablecredentials: + operation: + $ref: '#/paths/~1api~12.0~1unity-catalog~1temporary-table-credentials/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/temporary_table_credentials/methods/generatetemporarytablecredentials' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + volumes: + id: databricks_workspace.unitycatalog.volumes + name: volumes + title: Volumes + methods: + create: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.volumes + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes~1{name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + read: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes~1{name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1volumes~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volumes/methods/read' + - $ref: '#/components/x-stackQL-resources/volumes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volumes/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/delete' + exec: [] + workspace_bindings: + id: databricks_workspace.unitycatalog.workspace_bindings + name: workspace_bindings + title: Workspace_bindings + methods: + getbindings: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1bindings~1{securable_type}~1{securable_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + updatebindings: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1bindings~1{securable_type}~1{securable_name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1workspace-bindings~1catalogs~1{name}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_bindings/methods/getbindings' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/workspace_bindings/methods/update' + - $ref: '#/components/x-stackQL-resources/workspace_bindings/methods/updatebindings' + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml new file mode 100644 index 00000000..0aa67f26 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml @@ -0,0 +1,982 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Vectorsearch API + description: Vectorsearch +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/vector-search/indexes/{index_name}/delete-data: + post: + operationId: data-vector-indexes-deletedatavectorindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/deletedatavectorindex + x-stackQL-resource: data_vector_indexes + x-stackQL-method: deletedatavectorindex + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Response indicating the result of the delete operation. + content: + application/json: + schema: + type: object + properties: + status: + type: string + result: + type: object + properties: + success_row_count: + type: integer + failed_primary_keys: + type: array + items: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + primary_keys: + type: required + example: + primary_keys: + - '1' + description: Data to be deleted from the vector index. + description: Handles the deletion of data from a specified vector index. + /api/2.0/vector-search/indexes/{index_name}/upsert-data: + post: + operationId: data-vector-indexes-upsertdatavectorindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/upsertdatavectorindex + x-stackQL-resource: data_vector_indexes + x-stackQL-method: upsertdatavectorindex + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Response indicating the result of the upsert operation. + content: + application/json: + schema: + type: object + properties: + status: + type: string + result: + type: object + properties: + success_row_count: + type: integer + failed_primary_keys: + type: array + items: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + inputs_json: + type: required + example: + inputs_json: '[{"id": "1", "text": "hello world", "text_vector": [1.0, + 2.0, 3.0]}]' + description: Data to be upserted into the vector index. + description: Handles the upserting of data into a specified vector index. + /api/2.0/vector-search/endpoints: + post: + operationId: endpoints-createendpoint + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/createendpoint + x-stackQL-resource: endpoints + x-stackQL-method: createendpoint + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successful response with details of the created endpoint + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + endpoint_type: + type: string + last_updated_user: + type: string + id: + type: string + endpoint_status: + type: object + properties: + state: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + endpoint_type: + type: string + example: + name: docs-endpoint + endpoint_type: STANDARD + description: Create a new endpoint. + get: + operationId: endpoints-listendpoints + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/listendpoints + x-stackQL-resource: endpoints + x-stackQL-method: listendpoints + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + responses: + '200': + description: List of all endpoints + content: + application/json: + schema: + type: object + properties: + endpoints: + type: array + items: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + endpoint_type: + type: string + last_updated_user: + type: string + id: + type: string + endpoint_status: + type: object + properties: + state: + type: string + message: + type: string + num_indexes: + type: integer + next_page_token: + type: string + x-stackQL-objectKey: $.endpoints + /api/2.0/vector-search/endpoints/{endpoint_name}: + delete: + operationId: endpoints-deleteendpoint + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/deleteendpoint + x-stackQL-resource: endpoints + x-stackQL-method: deleteendpoint + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: endpoint_name + required: true + description: string + in: path + responses: + '200': + description: Endpoint deletion initiated. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + get: + operationId: endpoints-getendpoint + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchendpoints/getendpoint + x-stackQL-resource: endpoints + x-stackQL-method: getendpoint + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: endpoint_name + required: true + description: string + in: path + responses: + '200': + description: Details of the endpoint. + content: + application/json: + schema: + type: object + properties: + name: + type: string + creator: + type: string + creation_timestamp: + type: integer + last_updated_timestamp: + type: integer + endpoint_type: + type: string + last_updated_user: + type: string + id: + type: string + endpoint_status: + type: object + properties: + state: + type: string + message: + type: string + num_indexes: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + /api/2.0/vector-search/indexes: + post: + operationId: indexes-createindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex + x-stackQL-resource: indexes + x-stackQL-method: createindex + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Successful response with details of the created index + content: + application/json: + schema: + type: object + properties: + name: + type: string + endpoint_name: + type: string + primary_key: + type: string + index_type: + type: string + delta_sync_index_spec: + type: object + properties: + source_table: + type: string + embedding_source_columns: + type: array + items: + type: object + properties: + name: + type: string + embedding_model_endpoint_name: + type: string + columns_to_sync: + type: array + items: + type: string + pipeline_type: + type: string + pipeline_id: + type: string + status: + type: object + properties: + message: + type: string + indexed_row_count: + type: integer + ready: + type: boolean + index_url: + type: string + creator: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: required + endpoint_name: + type: string + primary_key: + type: required + index_type: + type: string + delta_sync_index_spec: + type: object + direct_access_index_spec: + type: object + example: + name: main_catalog.docs.en_wiki_index + primary_key: id + index_type: DELTA_SYNC + delta_sync_index_spec: + source_table: main_catalog.docs.en_wiki + pipeline_type: TRIGGERED + embedding_source_columns: + - name: text + embedding_model_endpoint_name: e5-small-v2 + columns_to_sync: + - id + - text + description: Create a new index. + get: + operationId: indexes-listindexes + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/listindexes + x-stackQL-resource: indexes + x-stackQL-method: listindexes + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: endpoint_name + required: true + description: string + in: query + - name: page_token + in: query + responses: + '200': + description: Successful response with list of endpoints. + content: + application/json: + schema: + type: object + properties: + vector_indexes: + type: array + items: + type: object + properties: + name: + type: string + endpoint_name: + type: string + primary_key: + type: string + index_type: + type: string + creator: + type: string + next_page_token: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.vector_indexes + description: List all indexes in the given endpoint. + /api/2.0/vector-search/indexes/{index_name}: + delete: + operationId: indexes-deleteindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/deleteindex + x-stackQL-resource: indexes + x-stackQL-method: deleteindex + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Index deletion has been initiated. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Delete an index. + get: + operationId: indexes-getindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/getindex + x-stackQL-resource: indexes + x-stackQL-method: getindex + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with details of the index + content: + application/json: + schema: + type: object + properties: + name: + type: string + endpoint_name: + type: string + primary_key: + type: string + index_type: + type: string + delta_sync_index_spec: + type: object + properties: + source_table: + type: string + embedding_source_columns: + type: array + items: + type: object + properties: + name: + type: string + embedding_model_endpoint_name: + type: string + pipeline_type: + type: string + pipeline_id: + type: string + status: + type: object + properties: + message: + type: string + indexed_row_count: + type: integer + ready: + type: boolean + index_url: + type: string + creator: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Get an index. + /api/2.0/vector-search/indexes/{index_name}/query-next-page: + post: + operationId: indexes-querynextpage + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/querynextpage + x-stackQL-resource: indexes + x-stackQL-method: querynextpage + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with query results. + content: + application/json: + schema: + type: object + properties: + manifest: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + result: + type: object + properties: + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + endpoint_name: + type: string + page_token: + type: string + example: + endpoint_name: demo-endpoint + page_token: dummy-page-token + description: Use + /api/2.0/vector-search/indexes/{index_name}/sync: + post: + operationId: indexes-syncindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/syncindex + x-stackQL-resource: indexes + x-stackQL-method: syncindex + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response indicating the sync process has been initiated. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Triggers a synchronization process for a specified vector index. + /api/2.0/vector-search/indexes/{index_name}/query: + post: + operationId: index-query-queryindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/queryindex + x-stackQL-resource: index_query + x-stackQL-method: queryindex + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with query results. + content: + application/json: + schema: + type: object + properties: + manifest: + type: object + properties: + column_count: + type: integer + columns: + type: array + items: + type: object + properties: + name: + type: string + result: + type: object + properties: + row_count: + type: integer + data_array: + type: array + items: + type: array + items: + type: string + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_results: + type: integer + columns: + type: required + filters_json: + type: Array of string + query_vector: + type: string + query_text: + type: Array of double + score_threshold: + type: string + query_type: + type: double + example: + query_vector: + - 1 + - 2 + - 3 + columns: + - id + - text + num_results: 10 + description: Query the specified vector index. + /api/2.0/vector-search/indexes/{index_name}/scan: + post: + operationId: index-scan-scanindex + externalDocs: + url: https://docs.databricks.com/api/workspace/vectorsearchindexes/scanindex + x-stackQL-resource: index_scan + x-stackQL-method: scanindex + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: index_name + required: true + description: string + in: path + responses: + '200': + description: Successful response with scan results. + content: + application/json: + schema: + type: object + properties: + last_primary_key: + type: string + data: + type: array + items: + type: object + properties: + fields: + type: array + items: + type: object + properties: + key: + type: string + value: + type: object + properties: + number_value: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + num_results: + type: integer + last_primary_key: + type: string + example: + num_results: 2 + description: Scan the specified vector index and return the first +components: + x-stackQL-resources: + data_vector_indexes: + id: databricks_workspace.vectorsearch.data_vector_indexes + name: data_vector_indexes + title: Data_vector_indexes + methods: + deletedatavectorindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1delete-data/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + upsertdatavectorindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1upsert-data/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/data_vector_indexes/methods/upsertdatavectorindex' + delete: + - $ref: '#/components/x-stackQL-resources/data_vector_indexes/methods/deletedatavectorindex' + exec: [] + endpoints: + id: databricks_workspace.vectorsearch.endpoints + name: endpoints + title: Endpoints + methods: + createendpoint: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listendpoints: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpoints + deleteendpoint: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getendpoint: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/getendpoint' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/listendpoints' + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/createendpoint' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/deleteendpoint' + exec: [] + indexes: + id: databricks_workspace.vectorsearch.indexes + name: indexes + title: Indexes + methods: + createindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listindexes: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.vector_indexes + deleteindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + querynextpage: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1query-next-page/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + syncindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1sync/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indexes/methods/getindex' + - $ref: '#/components/x-stackQL-resources/indexes/methods/listindexes' + insert: + - $ref: '#/components/x-stackQL-resources/indexes/methods/createindex' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/indexes/methods/deleteindex' + exec: + - $ref: '#/components/x-stackQL-resources/indexes/methods/syncindex' + - $ref: '#/components/x-stackQL-resources/indexes/methods/querynextpage' + index_query: + id: databricks_workspace.vectorsearch.index_query + name: index_query + title: Index_query + methods: + queryindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1query/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/index_query/methods/queryindex' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + index_scan: + id: databricks_workspace.vectorsearch.index_scan + name: index_scan + title: Index_scan + methods: + scanindex: + operation: + $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1scan/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/index_scan/methods/scanindex' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml b/providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml new file mode 100644 index 00000000..f9fe6d13 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/workflows.yaml @@ -0,0 +1,4507 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Workflows API + description: Workflows +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.2/jobs/create: + post: + operationId: jobs-create + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/create + x-stackQL-resource: jobs + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: + type: string + timeout_seconds: + type: int32 + max_concurrent_runs: + type: int32 + format: + type: string + edit_mode: + type: string + email_notifications: + type: object + webhook_notifications: + type: object + notification_settings: + type: object + health: + type: object + schedule: + type: object + trigger: + type: object + continuous: + type: object + tasks: + type: Array of object + job_clusters: + type: Array of object + git_source: + type: object + tags: + type: object + queue: + type: object + parameters: + type: Array of object + run_as: + type: object + deployment: + type: object + environments: + type: Array of object + access_control_list: + type: Array of object + example: + name: A multitask job + description: This job contain multiple tasks that are required to + produce the weekly shark sightings report. + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + schedule: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + trigger: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + continuous: + pause_status: UNPAUSED + max_concurrent_runs: 10 + tasks: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + job_clusters: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + tags: + cost-center: engineering + team: jobs + format: SINGLE_TASK + queue: + enabled: true + parameters: + - default: users + name: table + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + edit_mode: UI_LOCKED + deployment: + kind: BUNDLE + metadata_file_path: string + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Create a new job. + /api/2.2/jobs/delete: + post: + operationId: jobs-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/delete + x-stackQL-resource: jobs + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + example: + job_id: 11223344 + description: Deletes a job. + /api/2.2/jobs/get: + get: + operationId: jobs-get + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/get + x-stackQL-resource: jobs + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: int64 + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + creator_user_name: + type: string + run_as_user_name: + type: string + settings: + type: object + properties: + name: + type: string + description: + type: string + email_notifications: + type: object + properties: + on_start: + type: array + items: + type: string + on_success: + type: array + items: + type: string + on_failure: + type: array + items: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: string + no_alert_for_skipped_runs: + type: boolean + webhook_notifications: + type: object + properties: + on_start: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_success: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_failure: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + notification_settings: + type: object + properties: + no_alert_for_skipped_runs: + type: boolean + no_alert_for_canceled_runs: + type: boolean + timeout_seconds: + type: integer + health: + type: object + properties: + rules: + type: array + items: + type: object + properties: + metric: + type: string + op: + type: string + value: + type: integer + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + trigger: + type: object + properties: + pause_status: + type: string + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + wait_after_last_change_seconds: + type: integer + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + continuous: + type: object + properties: + pause_status: + type: string + max_concurrent_runs: + type: integer + tasks: + type: array + items: + type: object + properties: + max_retries: + type: integer + task_key: + type: string + description: + type: string + min_retry_interval_millis: + type: integer + depends_on: + type: array + items: {} + timeout_seconds: + type: integer + spark_jar_task: + type: object + properties: + main_class_name: + type: string + parameters: + type: array + items: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + retry_on_timeout: + type: boolean + existing_cluster_id: + type: string + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + tags: + type: object + properties: + cost-center: + type: string + team: + type: string + format: + type: string + queue: + type: object + properties: + enabled: + type: boolean + parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + run_as: + type: object + properties: + user_name: + type: string + service_principal_name: + type: string + edit_mode: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + environments: + type: array + items: + type: object + properties: + environment_key: + type: string + spec: + type: object + properties: + client: + type: string + dependencies: + type: array + items: + type: string + created_time: + type: integer + has_more: + type: boolean + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Retrieves the details for a single job. + /api/2.2/jobs/list: + get: + operationId: jobs-list + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/list + x-stackQL-resource: jobs + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: offset + in: query + - name: limit + in: query + - name: expand_tasks + in: query + - name: name + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + jobs: + type: array + items: + type: object + properties: + job_id: + type: integer + creator_user_name: + type: string + settings: + type: object + properties: + name: + type: string + description: + type: string + email_notifications: + type: object + properties: + on_start: + type: array + items: + type: string + on_success: + type: array + items: + type: string + on_failure: + type: array + items: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: string + no_alert_for_skipped_runs: + type: boolean + webhook_notifications: + type: object + properties: + on_start: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_success: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_failure: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + notification_settings: + type: object + properties: + no_alert_for_skipped_runs: + type: boolean + no_alert_for_canceled_runs: + type: boolean + timeout_seconds: + type: integer + health: + type: object + properties: + rules: + type: array + items: + type: object + properties: + metric: + type: string + op: + type: string + value: + type: integer + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + trigger: + type: object + properties: + pause_status: + type: string + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + wait_after_last_change_seconds: + type: integer + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + continuous: + type: object + properties: + pause_status: + type: string + max_concurrent_runs: + type: integer + tasks: + type: array + items: + type: object + properties: + max_retries: + type: integer + task_key: + type: string + description: + type: string + min_retry_interval_millis: + type: integer + depends_on: + type: array + items: {} + timeout_seconds: + type: integer + spark_jar_task: + type: object + properties: + main_class_name: + type: string + parameters: + type: array + items: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + retry_on_timeout: + type: boolean + existing_cluster_id: + type: string + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + tags: + type: object + properties: + cost-center: + type: string + team: + type: string + format: + type: string + queue: + type: object + properties: + enabled: + type: boolean + parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + run_as: + type: object + properties: + user_name: + type: string + service_principal_name: + type: string + edit_mode: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + environments: + type: array + items: + type: object + properties: + environment_key: + type: string + spec: + type: object + properties: + client: + type: string + dependencies: + type: array + items: + type: string + created_time: + type: integer + has_more: + type: boolean + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.jobs + description: Retrieves a list of jobs. + /api/2.2/jobs/reset: + post: + operationId: jobs-reset + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/reset + x-stackQL-resource: jobs + x-stackQL-method: reset + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + new_settings: + type: required + example: + job_id: 11223344 + new_settings: + name: A multitask job + description: This job contain multiple tasks that are required to + produce the weekly shark sightings report. + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + schedule: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + trigger: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + continuous: + pause_status: UNPAUSED + max_concurrent_runs: 10 + tasks: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + job_clusters: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + tags: + cost-center: engineering + team: jobs + format: SINGLE_TASK + queue: + enabled: true + parameters: + - default: users + name: table + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + edit_mode: UI_LOCKED + deployment: + kind: BUNDLE + metadata_file_path: string + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + description: Overwrite all settings for the given job. Use the + /api/2.2/jobs/run-now: + post: + operationId: jobs-runnow + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/runnow + x-stackQL-resource: jobs + x-stackQL-method: runnow + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + run_id: + type: integer + number_in_job: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + idempotency_token: + type: integer + format: int64 + job_parameters: + type: object + pipeline_params: + type: object + queue: + type: object + example: + job_id: 11223344 + job_parameters: + property1: string + property2: string + pipeline_params: + full_refresh: false + idempotency_token: 8f018174-4792-40d5-bcbc-3e6a527352c8 + queue: + enabled: true + description: Run a job and return the + /api/2.2/jobs/runs/submit: + post: + operationId: jobs-submit + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/submit + x-stackQL-resource: jobs + x-stackQL-method: submit + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + run_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_name: + type: string + timeout_seconds: + type: int32 + idempotency_token: + type: string + health: + type: object + tasks: + type: Array of object + git_source: + type: object + webhook_notifications: + type: object + email_notifications: + type: object + notification_settings: + type: object + environments: + type: Array of object + access_control_list: + type: Array of object + queue: + type: object + run_as: + type: object + example: + run_name: A multitask job run + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + idempotency_token: 8f018174-4792-40d5-bcbc-3e6a527352c8 + tasks: + - task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - task_key: Orders_Ingest + description: Ingests order data + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + existing_cluster_id: 0923-164208-meows279 + - task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + queue: + enabled: true + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + description: "Submit a one-time run. This endpoint allows you to submit a workload\ + \ directly without creating a job. Runs submitted using this endpoint don\u2019\ + t display in the UI. Use the" + /api/2.2/jobs/update: + post: + operationId: jobs-update + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/update + x-stackQL-resource: jobs + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + fields_to_remove: + type: integer + format: int64 + new_settings: + type: object + example: + job_id: 11223344 + new_settings: + name: A multitask job + description: This job contain multiple tasks that are required to + produce the weekly shark sightings report. + email_notifications: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + webhook_notifications: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + notification_settings: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + timeout_seconds: 86400 + health: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + schedule: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + trigger: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + continuous: + pause_status: UNPAUSED + max_concurrent_runs: 10 + tasks: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + job_clusters: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + git_source: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + tags: + cost-center: engineering + team: jobs + format: SINGLE_TASK + queue: + enabled: true + parameters: + - default: users + name: table + run_as: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + edit_mode: UI_LOCKED + deployment: + kind: BUNDLE + metadata_file_path: string + environments: + - environment_key: string + spec: + client: '1' + dependencies: + - string + fields_to_remove: + - libraries + - schedule + - tasks/task_1 + - job_clusters/Default + description: Add, update, or remove specific settings of an existing job. Use + the + /api/2.0/policies/jobs/enforce-compliance: + post: + operationId: job-compliance-enforcecompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforjobs/enforcecompliance + x-stackQL-resource: job_compliance + x-stackQL-method: enforcecompliance + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + has_changes: + type: boolean + job_cluster_changes: + type: array + items: + type: object + properties: + field: + type: string + previous_value: + type: string + new_value: + type: string + settings: + type: object + properties: + name: + type: string + description: + type: string + email_notifications: + type: object + properties: + on_start: + type: array + items: + type: string + on_success: + type: array + items: + type: string + on_failure: + type: array + items: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: string + no_alert_for_skipped_runs: + type: boolean + webhook_notifications: + type: object + properties: + on_start: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_success: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_failure: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_duration_warning_threshold_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + on_streaming_backlog_exceeded: + type: array + items: + type: array + items: + type: object + properties: + id: + type: string + notification_settings: + type: object + properties: + no_alert_for_skipped_runs: + type: boolean + no_alert_for_canceled_runs: + type: boolean + timeout_seconds: + type: integer + health: + type: object + properties: + rules: + type: array + items: + type: object + properties: + metric: + type: string + op: + type: string + value: + type: integer + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + trigger: + type: object + properties: + pause_status: + type: string + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + wait_after_last_change_seconds: + type: integer + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + continuous: + type: object + properties: + pause_status: + type: string + max_concurrent_runs: + type: integer + tasks: + type: array + items: + type: object + properties: + max_retries: + type: integer + task_key: + type: string + description: + type: string + min_retry_interval_millis: + type: integer + depends_on: + type: array + items: {} + timeout_seconds: + type: integer + spark_jar_task: + type: object + properties: + main_class_name: + type: string + parameters: + type: array + items: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + retry_on_timeout: + type: boolean + existing_cluster_id: + type: string + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + tags: + type: object + properties: + cost-center: + type: string + team: + type: string + format: + type: string + queue: + type: object + properties: + enabled: + type: boolean + parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + run_as: + type: object + properties: + user_name: + type: string + service_principal_name: + type: string + edit_mode: + type: string + deployment: + type: object + properties: + kind: + type: string + metadata_file_path: + type: string + environments: + type: array + items: + type: object + properties: + environment_key: + type: string + spec: + type: object + properties: + client: + type: string + dependencies: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: required + validate_only: + type: integer + format: int64 + example: + job_id: 0 + validate_only: false + description: Updates a job so the job clusters that are created when running + the job (specified in + /api/2.0/policies/jobs/get-compliance: + get: + operationId: job-compliance-getcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforjobs/getcompliance + x-stackQL-resource: job_compliance + x-stackQL-method: getcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: int64 + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + is_compliant: + type: boolean + violations: + type: object + properties: + job_clusters[job_cluster_key].new_cluster.custom_tags.test_tag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Returns the policy compliance status of a job. Jobs could be out + of compliance if a cluster policy they use was updated after the job was last + edited and some of its job clusters no longer comply with their updated policies. + /api/2.0/policies/jobs/list-compliance: + get: + operationId: job-compliance-listcompliance + externalDocs: + url: https://docs.databricks.com/api/workspace/policycomplianceforjobs/listcompliance + x-stackQL-resource: job_compliance + x-stackQL-method: listcompliance + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: policy_id + required: true + description: string + in: query + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + jobs: + type: array + items: + type: object + properties: + job_id: + type: integer + is_compliant: + type: boolean + violations: + type: object + properties: + job_clusters[job_cluster_key].new_cluster.custom_tags.test_tag: + type: string + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.jobs + description: Returns the policy compliance status of all jobs that use a given + policy. Jobs could be out of compliance if a cluster policy they use was updated + after the job was last edited and its job clusters no longer comply with the + updated policy. + /api/2.0/permissions/jobs/{job_id}: + get: + operationId: job-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getpermissions + x-stackQL-resource: job_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a job. Jobs can inherit permissions from + their root object. + put: + operationId: job-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/setpermissions + x-stackQL-resource: job_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: job-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/updatepermissions + x-stackQL-resource: job_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a job. Jobs can inherit permissions + from their root object. + /api/2.0/permissions/jobs/{job_id}/permissionLevels: + get: + operationId: job-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getpermissionlevels + x-stackQL-resource: job_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: job_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.2/jobs/runs/cancel-all: + post: + operationId: job-runs-cancelallruns + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/cancelallruns + x-stackQL-resource: job_runs + x-stackQL-method: cancelallruns + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + format: int64 + all_queued_runs: + type: boolean + example: + job_id: 11223344 + all_queued_runs: false + description: Cancels all active runs of a job. The runs are canceled asynchronously, + so it doesn't prevent new runs from being started. + /api/2.2/jobs/runs/cancel: + post: + operationId: job-runs-cancelrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/cancelrun + x-stackQL-resource: job_runs + x-stackQL-method: cancelrun + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: 455644833 + description: Cancels a job run or a task run. The run is canceled asynchronously, + so it may still be running when this request completes. + /api/2.2/jobs/runs/delete: + post: + operationId: job-runs-deleterun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/deleterun + x-stackQL-resource: job_runs + x-stackQL-method: deleterun + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + example: + run_id: 455644833 + description: Deletes a non-active run. Returns an error if the run is active. + /api/2.2/jobs/runs/export: + get: + operationId: job-runs-exportrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/exportrun + x-stackQL-resource: job_runs + x-stackQL-method: exportrun + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: int64 + in: query + - name: views_to_export + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + views: + type: array + items: + type: object + properties: + content: + type: string + name: + type: string + type: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Export and retrieve the job run task. + /api/2.2/jobs/runs/get: + get: + operationId: job-runs-getrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getrun + x-stackQL-resource: job_runs + x-stackQL-method: getrun + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: int64 + in: query + - name: include_history + in: query + - name: include_resolved_values + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + job_id: + type: integer + run_id: + type: integer + creator_user_name: + type: string + number_in_job: + type: integer + original_attempt_run_id: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + cluster_spec: + type: object + properties: + existing_cluster_id: + type: string + new_cluster: + type: object + properties: + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + kind: + type: string + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: boolean + is_single_node: + type: boolean + spark_conf: + type: object + properties: + property1: + type: string + property2: + type: string + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + instance_pool_id: + type: string + policy_id: + type: string + enable_local_disk_encryption: + type: boolean + driver_instance_pool_id: + type: string + workload_type: + type: object + properties: + clients: + type: object + properties: + notebooks: + type: string + jobs: + type: string + runtime_engine: + type: string + docker_image: + type: object + properties: + url: + type: string + basic_auth: + type: object + properties: + username: + type: string + password: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: boolean + job_cluster_key: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + job_parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + value: + type: string + overriding_parameters: + type: object + properties: + pipeline_params: + type: object + properties: + full_refresh: + type: boolean + start_time: + type: integer + setup_duration: + type: integer + execution_duration: + type: integer + cleanup_duration: + type: integer + end_time: + type: integer + run_duration: + type: integer + queue_duration: + type: integer + trigger: + type: string + trigger_info: + type: object + properties: + run_id: + type: integer + run_name: + type: string + run_page_url: + type: string + run_type: + type: string + tasks: + type: array + items: + type: object + properties: + setup_duration: + type: integer + start_time: + type: integer + task_key: + type: string + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + description: + type: string + job_cluster_key: + type: string + end_time: + type: integer + run_page_url: + type: string + run_id: + type: integer + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + spark_jar_task: + type: object + properties: + main_class_name: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + attempt_number: + type: integer + cleanup_duration: + type: integer + execution_duration: + type: integer + run_if: + type: string + description: + type: string + attempt_number: + type: integer + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + repair_history: + type: array + items: + type: object + properties: + type: + type: string + start_time: + type: integer + end_time: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + id: + type: integer + task_run_ids: + type: array + items: + type: integer + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + job_run_id: + type: integer + has_more: + type: boolean + next_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Retrieves the metadata of a run. + /api/2.2/jobs/runs/list: + get: + operationId: job-runs-listruns + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/listruns + x-stackQL-resource: job_runs + x-stackQL-method: listruns + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: job_id + in: query + - name: active_only + in: query + - name: completed_only + in: query + - name: offset + in: query + - name: limit + in: query + - name: run_type + in: query + - name: expand_tasks + in: query + - name: start_time_from + in: query + - name: start_time_to + in: query + - name: page_token + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + runs: + type: array + items: + type: object + properties: + job_id: + type: integer + run_id: + type: integer + creator_user_name: + type: string + number_in_job: + type: integer + original_attempt_run_id: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + cluster_spec: + type: object + properties: + existing_cluster_id: + type: string + new_cluster: + type: object + properties: + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + kind: + type: string + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: boolean + is_single_node: + type: boolean + spark_conf: + type: object + properties: + property1: + type: string + property2: + type: string + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + instance_pool_id: + type: string + policy_id: + type: string + enable_local_disk_encryption: + type: boolean + driver_instance_pool_id: + type: string + workload_type: + type: object + properties: + clients: + type: object + properties: + notebooks: + type: string + jobs: + type: string + runtime_engine: + type: string + docker_image: + type: object + properties: + url: + type: string + basic_auth: + type: object + properties: + username: + type: string + password: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: boolean + job_cluster_key: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + job_parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + value: + type: string + overriding_parameters: + type: object + properties: + pipeline_params: + type: object + properties: + full_refresh: + type: boolean + start_time: + type: integer + setup_duration: + type: integer + execution_duration: + type: integer + cleanup_duration: + type: integer + end_time: + type: integer + run_duration: + type: integer + queue_duration: + type: integer + trigger: + type: string + trigger_info: + type: object + properties: + run_id: + type: integer + run_name: + type: string + run_page_url: + type: string + run_type: + type: string + tasks: + type: array + items: + type: object + properties: + setup_duration: + type: integer + start_time: + type: integer + task_key: + type: string + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + description: + type: string + job_cluster_key: + type: string + end_time: + type: integer + run_page_url: + type: string + run_id: + type: integer + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + spark_jar_task: + type: object + properties: + main_class_name: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + attempt_number: + type: integer + cleanup_duration: + type: integer + execution_duration: + type: integer + run_if: + type: string + description: + type: string + attempt_number: + type: integer + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + repair_history: + type: array + items: + type: object + properties: + type: + type: string + start_time: + type: integer + end_time: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + id: + type: integer + task_run_ids: + type: array + items: + type: integer + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + job_run_id: + type: integer + has_more: + type: boolean + next_page_token: + type: string + prev_page_token: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + x-stackQL-objectKey: $.runs + description: List runs in descending order by start time. + /api/2.2/jobs/runs/repair: + post: + operationId: job-runs-repairrun + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/repairrun + x-stackQL-resource: job_runs + x-stackQL-method: repairrun + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + repair_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + run_id: + type: required + latest_repair_id: + type: integer + format: int64 + rerun_tasks: + type: integer + format: int64 + rerun_all_failed_tasks: + type: Array of string + rerun_dependent_tasks: + type: boolean + job_parameters: + type: object + pipeline_params: + type: object + example: + run_id: 455644833 + latest_repair_id: 734650698524280 + rerun_tasks: + - task0 + - task1 + job_parameters: + property1: string + property2: string + pipeline_params: + full_refresh: false + rerun_all_failed_tasks: false + rerun_dependent_tasks: false + description: Re-run one or more tasks. Tasks are re-run as part of the original + job run. They use the current job and task settings, and can be viewed in + the history for the original job run. + /api/2.2/jobs/runs/get-output: + get: + operationId: job-run-output-getrunoutput + externalDocs: + url: https://docs.databricks.com/api/workspace/jobs/getrunoutput + x-stackQL-resource: job_run_output + x-stackQL-method: getrunoutput + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: run_id + required: true + description: int64 + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + metadata: + type: object + properties: + job_id: + type: integer + run_id: + type: integer + creator_user_name: + type: string + number_in_job: + type: integer + original_attempt_run_id: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + schedule: + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + pause_status: + type: string + cluster_spec: + type: object + properties: + existing_cluster_id: + type: string + new_cluster: + type: object + properties: + num_workers: + type: integer + autoscale: + type: object + properties: + min_workers: + type: integer + max_workers: + type: integer + kind: + type: string + cluster_name: + type: string + spark_version: + type: string + use_ml_runtime: + type: boolean + is_single_node: + type: boolean + spark_conf: + type: object + properties: + property1: + type: string + property2: + type: string + aws_attributes: + type: object + properties: + first_on_demand: + type: string + availability: + type: string + zone_id: + type: string + instance_profile_arn: + type: string + spot_bid_price_percent: + type: string + ebs_volume_type: + type: string + ebs_volume_count: + type: string + ebs_volume_size: + type: integer + ebs_volume_iops: + type: integer + ebs_volume_throughput: + type: integer + node_type_id: + type: string + driver_node_type_id: + type: string + ssh_public_keys: + type: array + items: + type: string + custom_tags: + type: object + properties: + property1: + type: string + property2: + type: string + cluster_log_conf: + type: object + properties: + dbfs: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + init_scripts: + type: array + items: + type: object + properties: + workspace: + type: object + properties: + destination: + type: string + volumes: + type: object + properties: + destination: + type: string + s3: + type: object + properties: + destination: + type: string + region: + type: string + endpoint: + type: string + enable_encryption: + type: boolean + encryption_type: + type: string + kms_key: + type: string + canned_acl: + type: string + file: + type: object + properties: + destination: + type: string + dbfs: + type: object + properties: + destination: + type: string + abfss: + type: object + properties: + destination: + type: string + gcs: + type: object + properties: + destination: + type: string + spark_env_vars: + type: object + properties: + property1: + type: string + property2: + type: string + autotermination_minutes: + type: integer + enable_elastic_disk: + type: boolean + instance_pool_id: + type: string + policy_id: + type: string + enable_local_disk_encryption: + type: boolean + driver_instance_pool_id: + type: string + workload_type: + type: object + properties: + clients: + type: object + properties: + notebooks: + type: string + jobs: + type: string + runtime_engine: + type: string + docker_image: + type: object + properties: + url: + type: string + basic_auth: + type: object + properties: + username: + type: string + password: + type: string + data_security_mode: + type: string + single_user_name: + type: string + apply_policy_default_values: + type: boolean + job_cluster_key: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + egg: + type: string + pypi: + type: object + properties: + package: + type: string + repo: + type: string + maven: + type: object + properties: + coordinates: + type: string + repo: + type: string + exclusions: + type: array + items: + type: string + cran: + type: object + properties: + package: + type: string + repo: + type: string + whl: + type: string + requirements: + type: string + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + job_parameters: + type: array + items: + type: object + properties: + default: + type: string + name: + type: string + value: + type: string + overriding_parameters: + type: object + properties: + pipeline_params: + type: object + properties: + full_refresh: + type: boolean + start_time: + type: integer + setup_duration: + type: integer + execution_duration: + type: integer + cleanup_duration: + type: integer + end_time: + type: integer + run_duration: + type: integer + queue_duration: + type: integer + trigger: + type: string + trigger_info: + type: object + properties: + run_id: + type: integer + run_name: + type: string + run_page_url: + type: string + run_type: + type: string + tasks: + type: array + items: + type: object + properties: + setup_duration: + type: integer + start_time: + type: integer + task_key: + type: string + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + description: + type: string + job_cluster_key: + type: string + end_time: + type: integer + run_page_url: + type: string + run_id: + type: integer + cluster_instance: + type: object + properties: + cluster_id: + type: string + spark_context_id: + type: string + spark_jar_task: + type: object + properties: + main_class_name: + type: string + libraries: + type: array + items: + type: object + properties: + jar: + type: string + attempt_number: + type: integer + cleanup_duration: + type: integer + execution_duration: + type: integer + run_if: + type: string + description: + type: string + attempt_number: + type: integer + job_clusters: + type: array + items: + type: object + properties: + job_cluster_key: + type: string + new_cluster: + type: object + properties: + autoscale: + type: object + properties: + max_workers: + type: integer + min_workers: + type: integer + node_type_id: + type: 'null' + spark_conf: + type: object + properties: + spark.speculation: + type: boolean + spark_version: + type: string + git_source: + type: object + properties: + git_branch: + type: string + git_provider: + type: string + git_url: + type: string + repair_history: + type: array + items: + type: object + properties: + type: + type: string + start_time: + type: integer + end_time: + type: integer + state: + type: object + properties: + life_cycle_state: + type: string + result_state: + type: string + state_message: + type: string + user_cancelled_or_timedout: + type: boolean + queue_reason: + type: string + id: + type: integer + task_run_ids: + type: array + items: + type: integer + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + status: + type: object + properties: + state: + type: string + termination_details: + type: object + properties: + code: + type: string + type: + type: string + message: + type: string + queue_details: + type: object + properties: + code: + type: string + message: + type: string + job_run_id: + type: integer + has_more: + type: boolean + next_page_token: + type: string + error: + type: string + logs: + type: string + logs_truncated: + type: boolean + error_trace: + type: string + info: + type: string + notebook_output: + type: object + properties: + result: + type: string + truncated: + type: boolean + sql_output: + type: object + properties: + query_output: + type: object + properties: + query_text: + type: string + endpoint_id: + type: string + sql_statements: + type: array + items: + type: object + properties: + lookup_key: + type: string + output_link: + type: string + warehouse_id: + type: string + dashboard_output: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + widget_id: + type: string + widget_title: + type: string + output_link: + type: string + status: + type: string + error: + type: object + properties: + message: + type: string + start_time: + type: integer + end_time: + type: integer + warehouse_id: + type: string + alert_output: + type: object + properties: + query_text: + type: string + sql_statements: + type: array + items: + type: object + properties: + lookup_key: + type: string + output_link: + type: string + warehouse_id: + type: string + alert_state: + type: string + dbt_output: + type: object + properties: + artifacts_link: + type: string + artifacts_headers: + type: object + properties: + property1: + type: string + property2: + type: string + run_job_output: + type: object + properties: + run_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '429': + description: Operation is rejected due to throttling, e.g. some resource + has been exhausted, per-user quota. + '500': + description: Internal error. + description: Retrieve the output and metadata of a single task run. When a notebook + task returns a value through the +components: + x-stackQL-resources: + jobs: + id: databricks_workspace.workflows.jobs + name: jobs + title: Jobs + methods: + create: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + reset: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1reset/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + runnow: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1run-now/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + submit: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1submit/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1update/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/jobs/methods/reset' + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/jobs/methods/submit' + - $ref: '#/components/x-stackQL-resources/jobs/methods/runnow' + job_compliance: + id: databricks_workspace.workflows.job_compliance + name: job_compliance + title: Job_compliance + methods: + enforcecompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1jobs~1enforce-compliance/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1jobs~1get-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listcompliance: + operation: + $ref: '#/paths/~1api~12.0~1policies~1jobs~1list-compliance/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_compliance/methods/listcompliance' + - $ref: '#/components/x-stackQL-resources/job_compliance/methods/getcompliance' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/job_compliance/methods/enforcecompliance' + delete: [] + exec: [] + job_permissions: + id: databricks_workspace.workflows.job_permissions + name: job_permissions + title: Job_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/job_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/job_permissions/methods/setpermissions' + delete: [] + exec: [] + job_permission_levels: + id: databricks_workspace.workflows.job_permission_levels + name: job_permission_levels + title: Job_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1jobs~1{job_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + job_runs: + id: databricks_workspace.workflows.job_runs + name: job_runs + title: Job_runs + methods: + cancelallruns: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1cancel-all/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + cancelrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1cancel/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + deleterun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + exportrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1export/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + getrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1get/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listruns: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + repairrun: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1repair/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_runs/methods/listruns' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/getrun' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/job_runs/methods/deleterun' + exec: + - $ref: '#/components/x-stackQL-resources/job_runs/methods/repairrun' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/exportrun' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/cancelrun' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/cancelallruns' + job_run_output: + id: databricks_workspace.workflows.job_run_output + name: job_run_output + title: Job_run_output + methods: + getrunoutput: + operation: + $ref: '#/paths/~1api~12.2~1jobs~1runs~1get-output/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_run_output/methods/getrunoutput' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml new file mode 100644 index 00000000..d9c75d98 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml @@ -0,0 +1,3401 @@ +openapi: 3.0.0 +info: + version: 2024-12-19-stackql-generated + contact: + name: StackQL Studios + url: https://stackql.io/ + email: info@stackql.io + title: Databricks Workspace API + description: Workspace +servers: +- url: https://{deployment_name}.cloud.databricks.com + variables: + deployment_name: + description: The Databricks Workspace Deployment Name + default: dbc-abcd0123-a1bc +paths: + /api/2.0/settings/types/automatic_cluster_update/names/default: + get: + operationId: automatic-cluster-update-get + externalDocs: + url: https://docs.databricks.com/api/workspace/automaticclusterupdate/get + x-stackQL-resource: automatic_cluster_update + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + automatic_cluster_update_workspace: + type: object + properties: + enabled: + type: boolean + can_toggle: + type: boolean + maintenance_window: + type: object + properties: + week_day_based_schedule: + type: object + properties: + frequency: + type: string + day_of_week: + type: string + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + enablement_details: + type: object + properties: + unavailable_for_non_enterprise_tier: + type: boolean + unavailable_for_disabled_entitlement: + type: boolean + forced_for_compliance_mode: + type: boolean + restart_even_if_no_updates_available: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the automatic cluster update setting. + patch: + operationId: automatic-cluster-update-update + externalDocs: + url: https://docs.databricks.com/api/workspace/automaticclusterupdate/update + x-stackQL-resource: automatic_cluster_update + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + automatic_cluster_update_workspace: + type: object + properties: + enabled: + type: boolean + can_toggle: + type: boolean + maintenance_window: + type: object + properties: + week_day_based_schedule: + type: object + properties: + frequency: + type: string + day_of_week: + type: string + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + enablement_details: + type: object + properties: + unavailable_for_non_enterprise_tier: + type: boolean + unavailable_for_disabled_entitlement: + type: boolean + forced_for_compliance_mode: + type: boolean + restart_even_if_no_updates_available: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + automatic_cluster_update_workspace: + enabled: true + can_toggle: true + maintenance_window: + week_day_based_schedule: + frequency: FIRST_OF_MONTH + day_of_week: MONDAY + window_start_time: + hours: 0 + minutes: 0 + enablement_details: + unavailable_for_non_enterprise_tier: true + unavailable_for_disabled_entitlement: true + forced_for_compliance_mode: true + restart_even_if_no_updates_available: true + field_mask: string + description: Details required to update a setting. + description: Updates the automatic cluster update setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/settings/types/shield_csp_enablement_ws_db/names/default: + get: + operationId: compliance-security-profile-get + externalDocs: + url: https://docs.databricks.com/api/workspace/compliancesecurityprofile/get + x-stackQL-resource: compliance_security_profile + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + compliance_security_profile_workspace: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the compliance security profile setting. + patch: + operationId: compliance-security-profile-update + externalDocs: + url: https://docs.databricks.com/api/workspace/compliancesecurityprofile/update + x-stackQL-resource: compliance_security_profile + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + compliance_security_profile_workspace: + type: object + properties: + is_enabled: + type: boolean + compliance_standards: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + compliance_security_profile_workspace: + is_enabled: true + compliance_standards: + - NONE + field_mask: string + description: Details required to update a setting. + description: Updates the compliance security profile setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/settings/types/aibi_dash_embed_ws_acc_policy/names/default: + delete: + operationId: dashboard-embedding-access-policy-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingaccesspolicy/delete + x-stackQL-resource: dashboard_embedding_access_policy + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Delete the AI/BI dashboard embedding access policy, reverting back + to the default. + get: + operationId: dashboard-embedding-access-policy-get + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingaccesspolicy/get + x-stackQL-resource: dashboard_embedding_access_policy + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_access_policy: + type: object + properties: + access_policy_type: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the AI/BI dashboard embedding access policy. The default + setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded + on approved domains. + patch: + operationId: dashboard-embedding-access-policy-update + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingaccesspolicy/update + x-stackQL-resource: dashboard_embedding_access_policy + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_access_policy: + type: object + properties: + access_policy_type: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + aibi_dashboard_embedding_access_policy: + access_policy_type: ALLOW_ALL_DOMAINS + field_mask: string + description: Details required to update a setting. + description: Updates the AI/BI dashboard embedding access policy at the workspace + level. + /api/2.0/settings/types/aibi_dash_embed_ws_apprvd_domains/names/default: + delete: + operationId: dashboard-embedding-approved-domains-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingapproveddomains/delete + x-stackQL-resource: dashboard_embedding_approved_domains + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Delete the list of domains approved to host embedded AI/BI dashboards, + reverting back to the default empty list. + get: + operationId: dashboard-embedding-approved-domains-get + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingapproveddomains/get + x-stackQL-resource: dashboard_embedding_approved_domains + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Retrieves the list of domains approved to host embedded AI/BI dashboards. + patch: + operationId: dashboard-embedding-approved-domains-update + externalDocs: + url: https://docs.databricks.com/api/workspace/aibidashboardembeddingapproveddomains/update + x-stackQL-resource: dashboard_embedding_approved_domains + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + aibi_dashboard_embedding_approved_domains: + approved_domains: + - string + field_mask: string + description: Details required to update a setting. + description: Updates the list of domains approved to host embedded AI/BI dashboards. + This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS. + /api/2.0/workspace/list: + get: + operationId: directories-list + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/list + x-stackQL-resource: directories + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + - name: notebooks_modified_after + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + objects: + type: array + items: + type: object + properties: + path: + type: string + object_type: + type: string + object_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.objects + description: Lists the contents of a directory, or the object if it is not a + directory. If the input path does not exist, this call returns an error + /api/2.0/workspace/mkdirs: + post: + operationId: directories-mkdirs + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/mkdirs + x-stackQL-resource: directories + x-stackQL-method: mkdirs + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + example: + path: /Users/user@example.com/project + description: Creates the specified directory (and necessary parent directories + if they do not exist). If there is an object (not a directory) at any prefix + of the input path, this call returns an error + /api/2.0/settings/types/shield_esm_enablement_ws_db/names/default: + get: + operationId: enhanced-security-monitoring-get + externalDocs: + url: https://docs.databricks.com/api/workspace/enhancedsecuritymonitoring/get + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + enhanced_security_monitoring_workspace: + type: object + properties: + is_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the enhanced security monitoring setting. + patch: + operationId: enhanced-security-monitoring-update + externalDocs: + url: https://docs.databricks.com/api/workspace/enhancedsecuritymonitoring/update + x-stackQL-resource: enhanced_security_monitoring + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + enhanced_security_monitoring_workspace: + type: object + properties: + is_enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + enhanced_security_monitoring_workspace: + is_enabled: true + field_mask: string + description: Details required to update a setting. + description: Updates the enhanced security monitoring setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/workspace-conf: + get: + operationId: feature-status-getstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/workspaceconf/getstatus + x-stackQL-resource: feature_status + x-stackQL-method: getstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: keys + required: true + description: string + in: query + responses: + '200': + description: Status was returned successfully. + content: + application/json: + schema: + type: object + properties: + property1: + type: string + property2: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Enables or disables a specified feature for a workspace. + patch: + operationId: feature-status-setstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/workspaceconf/setstatus + x-stackQL-resource: feature_status + x-stackQL-method: setstatus + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '204': + description: Enabling or disabling feature was successful. + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Enables or disables a specified feature for a workspace. + /api/2.0/ip-access-lists: + post: + operationId: ip-access-lists-create + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/create + x-stackQL-resource: ip_access_lists + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + description: Details required to configure a block list or allow list. + description: Creates an IP access list for this workspace. + get: + operationId: ip-access-lists-list + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/list + x-stackQL-resource: ip_access_lists + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_lists: + type: array + items: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_lists + description: Gets all IP access lists for the specified workspace. + /api/2.0/ip-access-lists/{ip_access_list_id}: + delete: + operationId: ip-access-lists-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/delete + x-stackQL-resource: ip_access_lists + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes an IP access list, specified by its list ID. + get: + operationId: ip-access-lists-get + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/get + x-stackQL-resource: ip_access_lists + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + ip_access_list: + type: object + properties: + list_id: + type: string + label: + type: string + ip_addresses: + type: array + items: + type: string + address_count: + type: integer + list_type: + type: string + created_at: + type: integer + created_by: + type: integer + updated_at: + type: integer + updated_by: + type: integer + enabled: + type: boolean + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.ip_access_list + description: Gets an IP access list, specified by its list ID. + put: + operationId: ip-access-lists-replace + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/replace + x-stackQL-resource: ip_access_lists + x-stackQL-method: replace + x-stackQL-verb: replace + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: required + list_type: + type: string + ip_addresses: + type: required + enabled: + type: string + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to replace an IP access list. + description: Replaces an IP access list, specified by its ID. + patch: + operationId: ip-access-lists-update + externalDocs: + url: https://docs.databricks.com/api/workspace/ipaccesslists/update + x-stackQL-resource: ip_access_lists + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: ip_access_list_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + label: + type: string + list_type: + type: string + ip_addresses: + type: Array of string + enabled: + type: boolean + example: + label: Office VPN + list_type: ALLOW + ip_addresses: + - 192.168.100.0/22 + enabled: true + description: Details required to update an IP access list. + description: Updates an existing IP access list, specified by its ID. + /api/2.0/notification-destinations: + post: + operationId: notification-destinations-create + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/create + x-stackQL-resource: notification_destinations + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + config: + type: object + properties: + generic_webhook: + type: object + properties: + password_set: + type: boolean + url_set: + type: boolean + username_set: + type: boolean + destination_type: + type: string + display_name: + type: string + id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + config: + type: object + example: + config: + generic_webhook: + password: my-password + url: https://my-webhook.com + username: my-username + display_name: My webhook destination + description: Creates a notification destination. Requires workspace admin permissions. + get: + operationId: notification-destinations-list + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/list + x-stackQL-resource: notification_destinations + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: page_token + in: query + - name: page_size + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + next_page_token: + type: string + results: + type: array + items: + type: object + properties: + destination_type: + type: string + display_name: + type: string + id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.results + description: Lists notification destinations. + /api/2.0/notification-destinations/{id}: + delete: + operationId: notification-destinations-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/delete + x-stackQL-resource: notification_destinations + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a notification destination. Requires workspace admin permissions. + get: + operationId: notification-destinations-get + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/get + x-stackQL-resource: notification_destinations + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + destination_type: + type: string + display_name: + type: string + id: + type: string + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets a notification destination. + patch: + operationId: notification-destinations-update + externalDocs: + url: https://docs.databricks.com/api/workspace/notificationdestinations/update + x-stackQL-resource: notification_destinations + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 1 + parameters: + - name: id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + config: + type: object + properties: + slack: + type: object + properties: + url_set: + type: boolean + destination_type: + type: string + display_name: + type: string + id: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + config: + type: object + example: + config: + slack: + url: https://hooks.slack.com/services/T00000000/B00000000/AAAAAAAAAAAAAAAA + display_name: My slack destination updated + id: fe25e731-92f2-4838-9fb2-1ca364320a3d + description: Updates a notification destination. Requires workspace admin permissions. + At least one field is required in the request body. + /api/2.0/workspace/delete: + post: + operationId: objects-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/delete + x-stackQL-resource: objects + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + recursive: + type: string + example: + path: /Users/me@example.com/MyFolder + recursive: true + description: Deletes an object or a directory (and optionally recursively deletes + all objects in the directory). + /api/2.0/workspace/export: + get: + operationId: objects-export + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/export + x-stackQL-resource: objects + x-stackQL-method: export + x-stackQL-verb: exec + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + - name: format + in: query + - name: direct_download + in: query + responses: + '200': + description: The request field `direct_download` determines whether a JSON + response or binary contents are returned by this endpoint. + content: + application/json: + schema: + type: object + properties: + content: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Exports an object or the contents of an entire directory. + /api/2.0/workspace/import: + post: + operationId: objects-import + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/import + x-stackQL-resource: objects + x-stackQL-method: import + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: {} + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + path: + type: required + format: + type: string + language: + type: string + content: + type: string + overwrite: + type: string + example: + format: SOURCE + path: /Users/user@example.com/project/ScalaExampleNotebook + language: SCALA + content: MSsx + overwrite: true + description: Imports a workspace object (for example, a notebook or file) or + the contents of an entire directory. If + /api/2.0/permissions/{workspace_object_type}/{workspace_object_id}: + get: + operationId: object-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/getpermissions + x-stackQL-resource: object_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of a workspace object. Workspace objects can + inherit permissions from their parent objects or root object. + put: + operationId: object-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/setpermissions + x-stackQL-resource: object_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their parent objects or root object. + patch: + operationId: object-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/updatepermissions + x-stackQL-resource: object_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + description: Updates the permissions on a workspace object. Workspace objects + can inherit permissions from their parent objects or root object. + /api/2.0/permissions/{workspace_object_type}/{workspace_object_id}/permissionLevels: + get: + operationId: object-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/getpermissionlevels + x-stackQL-resource: object_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 2 + parameters: + - name: workspace_object_type + required: true + description: string + in: path + - name: workspace_object_id + required: true + description: string + in: path + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/workspace/get-status: + get: + operationId: object-status-getstatus + externalDocs: + url: https://docs.databricks.com/api/workspace/workspace/getstatus + x-stackQL-resource: object_status + x-stackQL-method: getstatus + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: path + required: true + description: string + in: query + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + path: + type: string + language: + type: string + object_type: + type: string + object_id: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the status of an object or a directory. If + /api/2.0/settings/types/default_namespace_ws/names/default: + delete: + operationId: permissions-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/defaultnamespace/delete + x-stackQL-resource: permissions + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Deletes the default namespace setting for the workspace. A fresh + etag needs to be provided in + get: + operationId: permissions-get + externalDocs: + url: https://docs.databricks.com/api/workspace/defaultnamespace/get + x-stackQL-resource: permissions + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + namespace: + type: object + properties: + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the default namespace setting. + patch: + operationId: permissions-update + externalDocs: + url: https://docs.databricks.com/api/workspace/defaultnamespace/update + x-stackQL-resource: permissions + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + namespace: + type: object + properties: + value: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + namespace: + value: string + field_mask: string + description: Details required to update a setting. + description: Updates the default namespace setting for the workspace. A fresh + etag needs to be provided in + /api/2.0/settings/types/restrict_workspace_admins/names/default: + delete: + operationId: restrict-admins-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/delete + x-stackQL-resource: restrict_admins + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + description: Reverts the restrict workspace admins setting status for the workspace. + A fresh etag needs to be provided in + get: + operationId: restrict-admins-get + externalDocs: + url: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/get + x-stackQL-resource: restrict_admins + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: etag + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + restrict_workspace_admins: + type: object + properties: + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the restrict workspace admins setting. + patch: + operationId: restrict-admins-update + externalDocs: + url: https://docs.databricks.com/api/workspace/restrictworkspaceadmins/update + x-stackQL-resource: restrict_admins + x-stackQL-method: update + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + etag: + type: string + setting_name: + type: string + restrict_workspace_admins: + type: object + properties: + status: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '409': + description: Request was rejected due a conflict with an existing resource. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + allow_missing: + type: required + field_mask: + type: boolean + setting: + type: object + example: + allow_missing: true + setting: + etag: string + setting_name: string + restrict_workspace_admins: + status: ALLOW_ALL + field_mask: string + description: Details required to update a setting. + description: Updates the restrict workspace admins setting for the workspace. + A fresh etag needs to be provided in + /api/2.0/token-management/on-behalf-of/tokens: + post: + operationId: tokens-createobotoken + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/createobotoken + x-stackQL-resource: tokens + x-stackQL-method: createobotoken + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_value: + type: string + token_info: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + created_by_id: + type: integer + created_by_username: + type: string + owner_id: + type: integer + workspace_id: + type: integer + last_used_day: + type: integer + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + application_id: + type: required + lifetime_seconds: + type: string + comment: + type: integer + format: int64 + example: + application_id: 6f5ccf28-d83a-4957-9bfb-5bbfac551410 + lifetime_seconds: 3600 + comment: This is for the ABC department automation scripts. + description: Configuration details for creating on-behalf tokens. + description: Creates a token on behalf of a service principal. + /api/2.0/token-management/tokens/{token_id}: + delete: + operationId: tokens-delete + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/delete + x-stackQL-resource: tokens + x-stackQL-method: delete + x-stackQL-verb: delete + x-numReqParams: 1 + parameters: + - name: token_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Deletes a token, specified by its ID. + get: + operationId: tokens-get + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/get + x-stackQL-resource: tokens + x-stackQL-method: get + x-stackQL-verb: select + x-numReqParams: 1 + parameters: + - name: token_id + required: true + description: string + in: path + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_info: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + created_by_id: + type: integer + created_by_username: + type: string + owner_id: + type: integer + workspace_id: + type: integer + last_used_day: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.token_info + description: Gets information about a token, specified by its ID. + /api/2.0/token-management/tokens: + get: + operationId: tokens-list + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/list + x-stackQL-resource: tokens + x-stackQL-method: list + x-stackQL-verb: select + x-numReqParams: 0 + parameters: + - name: created_by_id + in: query + - name: created_by_username + in: query + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_infos: + type: array + items: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + created_by_id: + type: integer + created_by_username: + type: string + owner_id: + type: integer + workspace_id: + type: integer + last_used_day: + type: integer + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '500': + description: Internal error. + x-stackQL-objectKey: $.token_infos + description: Lists all tokens associated with the specified workspace or user. + /api/2.0/permissions/authorization/tokens: + get: + operationId: token-permissions-getpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/getpermissions + x-stackQL-resource: token_permissions + x-stackQL-method: getpermissions + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + description: Gets the permissions of all tokens. Tokens can inherit permissions + from their root object. + put: + operationId: token-permissions-setpermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/setpermissions + x-stackQL-resource: token_permissions + x-stackQL-method: setpermissions + x-stackQL-verb: replace + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Sets permissions on an object, replacing existing permissions if + they exist. Deletes all direct permissions if none are specified. Objects + can inherit permissions from their root object. + patch: + operationId: token-permissions-updatepermissions + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/updatepermissions + x-stackQL-resource: token_permissions + x-stackQL-method: updatepermissions + x-stackQL-verb: update + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object_id: + type: string + object_type: + type: string + access_control_list: + type: array + items: + type: object + properties: + user_name: + type: string + group_name: + type: string + service_principal_name: + type: string + display_name: + type: string + all_permissions: + type: array + items: + type: object + properties: + permission_level: + type: string + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: Array of object + example: + access_control_list: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_USE + description: Updates the permissions on all tokens. Tokens can inherit permissions + from their root object. + /api/2.0/permissions/authorization/tokens/permissionLevels: + get: + operationId: token-permission-levels-getpermissionlevels + externalDocs: + url: https://docs.databricks.com/api/workspace/tokenmanagement/getpermissionlevels + x-stackQL-resource: token_permission_levels + x-stackQL-method: getpermissionlevels + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + permission_levels: + type: array + items: + type: object + properties: + permission_level: + type: string + description: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '403': + description: Caller does not have permission to execute the specified operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + x-stackQL-objectKey: $.permission_levels + description: Gets the permission levels that a user can have on an object. + /api/2.0/token/create: + post: + operationId: user-tokens-create + externalDocs: + url: https://docs.databricks.com/api/workspace/tokens/create + x-stackQL-resource: user_tokens + x-stackQL-method: create + x-stackQL-verb: insert + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_value: + type: string + token_info: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + '400': + description: Request is invalid or malformed. + '401': + description: The request does not have valid authentication credentials + for the operation. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + lifetime_seconds: + type: integer + format: int64 + comment: + type: string + example: + lifetime_seconds: 0 + comment: string + description: Creates and returns a token for a user. If this call is made through + token authentication, it creates a token with the same client ID as the authenticated + token. If the user's token quota is exceeded, this call returns an error + /api/2.0/token/list: + get: + operationId: user-tokens-listtokens + externalDocs: + url: https://docs.databricks.com/api/workspace/tokens/listtokens + x-stackQL-resource: user_tokens + x-stackQL-method: listtokens + x-stackQL-verb: select + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: + token_infos: + type: array + items: + type: object + properties: + token_id: + type: string + creation_time: + type: integer + expiry_time: + type: integer + comment: + type: string + x-stackQL-objectKey: $.token_infos + description: Lists all the valid tokens for a user-workspace pair. + /api/2.0/token/delete: + post: + operationId: user-tokens-revoketoken + externalDocs: + url: https://docs.databricks.com/api/workspace/tokens/revoketoken + x-stackQL-resource: user_tokens + x-stackQL-method: revoketoken + x-stackQL-verb: exec + x-numReqParams: 0 + parameters: [] + responses: + '200': + description: Request completed successfully. + content: + application/json: + schema: + type: object + properties: {} + '401': + description: The request does not have valid authentication credentials + for the operation. + '404': + description: Operation was performed on a resource that does not exist. + '500': + description: Internal error. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token_id: + type: required + example: + token_id: string + description: Revokes an access token. +components: + x-stackQL-resources: + automatic_cluster_update: + id: databricks_workspace.workspace.automatic_cluster_update + name: automatic_cluster_update + title: Automatic_cluster_update + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1automatic_cluster_update~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1automatic_cluster_update~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/automatic_cluster_update/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/automatic_cluster_update/methods/update' + replace: [] + delete: [] + exec: [] + compliance_security_profile: + id: databricks_workspace.workspace.compliance_security_profile + name: compliance_security_profile + title: Compliance_security_profile + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_csp_enablement_ws_db~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_csp_enablement_ws_db~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/compliance_security_profile/methods/update' + replace: [] + delete: [] + exec: [] + dashboard_embedding_access_policy: + id: databricks_workspace.workspace.dashboard_embedding_access_policy + name: dashboard_embedding_access_policy + title: Dashboard_embedding_access_policy + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_acc_policy~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_acc_policy~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_acc_policy~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_access_policy/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_access_policy/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_access_policy/methods/delete' + exec: [] + dashboard_embedding_approved_domains: + id: databricks_workspace.workspace.dashboard_embedding_approved_domains + name: dashboard_embedding_approved_domains + title: Dashboard_embedding_approved_domains + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_apprvd_domains~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_apprvd_domains~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1aibi_dash_embed_ws_apprvd_domains~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_approved_domains/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_approved_domains/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dashboard_embedding_approved_domains/methods/delete' + exec: [] + directories: + id: databricks_workspace.workspace.directories + name: directories + title: Directories + methods: + list: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.objects + mkdirs: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1mkdirs/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/directories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/directories/methods/mkdirs' + update: [] + replace: [] + delete: [] + exec: [] + enhanced_security_monitoring: + id: databricks_workspace.workspace.enhanced_security_monitoring + name: enhanced_security_monitoring + title: Enhanced_security_monitoring + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_esm_enablement_ws_db~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1shield_esm_enablement_ws_db~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/enhanced_security_monitoring/methods/update' + replace: [] + delete: [] + exec: [] + feature_status: + id: databricks_workspace.workspace.feature_status + name: feature_status + title: Feature_status + methods: + getstatus: + operation: + $ref: '#/paths/~1api~12.0~1workspace-conf/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setstatus: + operation: + $ref: '#/paths/~1api~12.0~1workspace-conf/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_status/methods/getstatus' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/feature_status/methods/setstatus' + delete: [] + exec: [] + ip_access_lists: + id: databricks_workspace.workspace.ip_access_lists + name: ip_access_lists + title: Ip_access_lists + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_lists + delete: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.ip_access_list + replace: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1ip-access-lists~1{ip_access_list_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/update' + replace: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/replace' + delete: + - $ref: '#/components/x-stackQL-resources/ip_access_lists/methods/delete' + exec: [] + notification_destinations: + id: databricks_workspace.workspace.notification_destinations + name: notification_destinations + title: Notification_destinations + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.results + delete: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations~1{id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations~1{id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1notification-destinations~1{id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/get' + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/notification_destinations/methods/delete' + exec: [] + objects: + id: databricks_workspace.workspace.objects + name: objects + title: Objects + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1export/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + import: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1import/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/objects/methods/delete' + exec: + - $ref: '#/components/x-stackQL-resources/objects/methods/import' + - $ref: '#/components/x-stackQL-resources/objects/methods/export' + object_permissions: + id: databricks_workspace.workspace.object_permissions + name: object_permissions + title: Object_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/object_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/object_permissions/methods/setpermissions' + delete: [] + exec: [] + object_permission_levels: + id: databricks_workspace.workspace.object_permission_levels + name: object_permission_levels + title: Object_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1{workspace_object_type}~1{workspace_object_id}~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + object_status: + id: databricks_workspace.workspace.object_status + name: object_status + title: Object_status + methods: + getstatus: + operation: + $ref: '#/paths/~1api~12.0~1workspace~1get-status/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_status/methods/getstatus' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + permissions: + id: databricks_workspace.workspace.permissions + name: permissions + title: Permissions + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1default_namespace_ws~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1default_namespace_ws~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1default_namespace_ws~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + exec: [] + restrict_admins: + id: databricks_workspace.workspace.restrict_admins + name: restrict_admins + title: Restrict_admins + methods: + delete: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1restrict_workspace_admins~1names~1default/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1restrict_workspace_admins~1names~1default/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1api~12.0~1settings~1types~1restrict_workspace_admins~1names~1default/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/restrict_admins/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/restrict_admins/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/restrict_admins/methods/delete' + exec: [] + tokens: + id: databricks_workspace.workspace.tokens + name: tokens + title: Tokens + methods: + createobotoken: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1on-behalf-of~1tokens/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1tokens~1{token_id}/delete' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1tokens~1{token_id}/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.token_info + list: + operation: + $ref: '#/paths/~1api~12.0~1token-management~1tokens/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.token_infos + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/list' + - $ref: '#/components/x-stackQL-resources/tokens/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/createobotoken' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete' + exec: [] + token_permissions: + id: databricks_workspace.workspace.token_permissions + name: token_permissions + title: Token_permissions + methods: + getpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + setpermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens/put' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + updatepermissions: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens/patch' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/token_permissions/methods/getpermissions' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/token_permissions/methods/updatepermissions' + replace: + - $ref: '#/components/x-stackQL-resources/token_permissions/methods/setpermissions' + delete: [] + exec: [] + token_permission_levels: + id: databricks_workspace.workspace.token_permission_levels + name: token_permission_levels + title: Token_permission_levels + methods: + getpermissionlevels: + operation: + $ref: '#/paths/~1api~12.0~1permissions~1authorization~1tokens~1permissionLevels/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.permission_levels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/token_permission_levels/methods/getpermissionlevels' + insert: [] + update: [] + replace: [] + delete: [] + exec: [] + user_tokens: + id: databricks_workspace.workspace.user_tokens + name: user_tokens + title: User_tokens + methods: + create: + operation: + $ref: '#/paths/~1api~12.0~1token~1create/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + listtokens: + operation: + $ref: '#/paths/~1api~12.0~1token~1list/get' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + objectKey: $.token_infos + revoketoken: + operation: + $ref: '#/paths/~1api~12.0~1token~1delete/post' + response: + mediaType: application/json + overrideMediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/listtokens' + insert: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/create' + update: [] + replace: [] + delete: [] + exec: + - $ref: '#/components/x-stackQL-resources/user_tokens/methods/revoketoken' diff --git a/providers/src/googleworkspace/v00.00.00000/provider.yaml b/providers/src/googleworkspace/v00.00.00000/provider.yaml new file mode 100644 index 00000000..f83241ee --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/provider.yaml @@ -0,0 +1,53 @@ +id: googleworkspace +name: googleworkspace +version: v00.00.00000 +providerServices: + driveactivityv2: + id: driveactivityv2:v00.00.00000 + name: driveactivityv2 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/driveactivityv2.yaml + title: Drive Activity API + version: v00.00.00000 + description: Provides a historical view of activity in Google Drive. + drivelabelsv2: + id: drivelabelsv2:v00.00.00000 + name: drivelabelsv2 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivelabelsv2.yaml + title: Drive Labels API + version: v00.00.00000 + description: An API for managing Drive Labels + drivelabelsv2beta: + id: drivelabelsv2beta:v00.00.00000 + name: drivelabelsv2beta + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml + title: Drive Labels API + version: v00.00.00000 + description: An API for managing Drive Labels + drivev2: + id: drivev2:v00.00.00000 + name: drivev2 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivev2.yaml + title: Google Drive API + version: v00.00.00000 + description: The Google Drive API allows clients to access resources from Google Drive. + drivev3: + id: drivev3:v00.00.00000 + name: drivev3 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivev3.yaml + title: Google Drive API + version: v00.00.00000 + description: The Google Drive API allows clients to access resources from Google Drive. +config: + auth: + credentialsenvvar: GOOGLE_CREDENTIALS + type: service_account diff --git a/providers/src/googleworkspace/v00.00.00000/services/driveactivityv2.yaml b/providers/src/googleworkspace/v00.00.00000/services/driveactivityv2.yaml new file mode 100644 index 00000000..dbff2568 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/driveactivityv2.yaml @@ -0,0 +1,1296 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Drive Activity API + description: Provides a historical view of activity in Google Drive. + version: v2 + x-discovery-doc-revision: '20241203' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/activity/ +servers: + - url: https://driveactivity.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive.activity: View and add to the activity record of files in your Google Drive + https://www.googleapis.com/auth/drive.activity.readonly: View the activity record of files in your Google Drive + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + QueryDriveActivityRequest: + id: QueryDriveActivityRequest + description: The request message for querying Drive activity. + type: object + properties: + itemName: + description: >- + Return activities for this Drive item. The format is + `items/ITEM_ID`. + type: string + ancestorName: + description: >- + Return activities for this Drive folder, plus all children and + descendants. The format is `items/ITEM_ID`. + type: string + consolidationStrategy: + description: >- + Details on how to consolidate related actions that make up the + activity. If not set, then related actions aren't consolidated. + $ref: '#/components/schemas/ConsolidationStrategy' + pageSize: + description: >- + The minimum number of activities desired in the response; the server + attempts to return at least this quantity. The server may also + return fewer activities if it has a partial response ready before + the request times out. If not set, a default value is used. + type: integer + format: int32 + pageToken: + description: >- + The token identifies which page of results to return. Set this to + the next_page_token value returned from a previous query to obtain + the following page of results. If not set, the first page of results + is returned. + type: string + filter: + description: >- + The filtering for items returned from this query request. The format + of the filter string is a sequence of expressions, joined by an + optional "AND", where each expression is of the form "field operator + value". Supported fields: - `time`: Uses numerical operators on date + values either in terms of milliseconds since Jan 1, 1970 or in RFC + 3339 format. Examples: - `time > 1452409200000 AND time <= + 1492812924310` - `time >= "2016-01-10T01:02:03-05:00"` - + `detail.action_detail_case`: Uses the "has" operator (:) and either + a singular value or a list of allowed action types enclosed in + parentheses, separated by a space. To exclude a result from the + response, prepend a hyphen (`-`) to the beginning of the filter + string. Examples: - `detail.action_detail_case:RENAME` - + `detail.action_detail_case:(CREATE RESTORE)` - + `-detail.action_detail_case:MOVE` + type: string + ConsolidationStrategy: + id: ConsolidationStrategy + description: >- + How the individual activities are consolidated. If a set of activities + is related they can be consolidated into one combined activity, such as + one actor performing the same action on multiple targets, or multiple + actors performing the same action on a single target. The strategy + defines the rules for which activities are related. + type: object + properties: + none: + description: The individual activities are not consolidated. + $ref: '#/components/schemas/NoConsolidation' + legacy: + description: >- + The individual activities are consolidated using the legacy + strategy. + $ref: '#/components/schemas/Legacy' + NoConsolidation: + id: NoConsolidation + description: A strategy that does no consolidation of individual activities. + type: object + properties: {} + Legacy: + id: Legacy + description: >- + A strategy that consolidates activities using the grouping rules from + the legacy V1 Activity API. Similar actions occurring within a window of + time can be grouped across multiple targets (such as moving a set of + files at once) or multiple actors (such as several users editing the + same item). Grouping rules for this strategy are specific to each type + of action. + type: object + properties: {} + QueryDriveActivityResponse: + id: QueryDriveActivityResponse + description: Response message for querying Drive activity. + type: object + properties: + activities: + description: List of activity requested. + type: array + items: + $ref: '#/components/schemas/DriveActivity' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + DriveActivity: + id: DriveActivity + description: >- + A single Drive activity comprising one or more Actions by one or more + Actors on one or more Targets. Some Action groupings occur + spontaneously, such as moving an item into a shared folder triggering a + permission change. Other groupings of related Actions, such as multiple + Actors editing one item or moving multiple files into a new folder, are + controlled by the selection of a ConsolidationStrategy in the + QueryDriveActivityRequest. + type: object + properties: + primaryActionDetail: + description: >- + Key information about the primary action for this activity. This is + either representative, or the most important, of all actions in the + activity, according to the ConsolidationStrategy in the request. + $ref: '#/components/schemas/ActionDetail' + actors: + description: All actor(s) responsible for the activity. + type: array + items: + $ref: '#/components/schemas/Actor' + actions: + description: Details on all actions in this activity. + type: array + items: + $ref: '#/components/schemas/Action' + targets: + description: >- + All Google Drive objects this activity is about (e.g. file, folder, + drive). This represents the state of the target immediately after + the actions occurred. + type: array + items: + $ref: '#/components/schemas/Target' + timestamp: + description: The activity occurred at this specific time. + type: string + format: google-datetime + timeRange: + description: The activity occurred over this time range. + $ref: '#/components/schemas/TimeRange' + ActionDetail: + id: ActionDetail + description: Data describing the type and additional information of an action. + type: object + properties: + create: + description: An object was created. + $ref: '#/components/schemas/Create' + edit: + description: An object was edited. + $ref: '#/components/schemas/Edit' + move: + description: An object was moved. + $ref: '#/components/schemas/Move' + rename: + description: An object was renamed. + $ref: '#/components/schemas/Rename' + delete: + description: An object was deleted. + $ref: '#/components/schemas/Delete' + restore: + description: A deleted object was restored. + $ref: '#/components/schemas/Restore' + permissionChange: + description: The permission on an object was changed. + $ref: '#/components/schemas/PermissionChange' + comment: + description: A change about comments was made. + $ref: '#/components/schemas/Comment' + dlpChange: + description: A change happened in data leak prevention status. + $ref: '#/components/schemas/DataLeakPreventionChange' + reference: + description: An object was referenced in an application outside of Drive/Docs. + $ref: '#/components/schemas/ApplicationReference' + settingsChange: + description: Settings were changed. + $ref: '#/components/schemas/SettingsChange' + appliedLabelChange: + description: Label was changed. + $ref: '#/components/schemas/AppliedLabelChange' + Create: + id: Create + description: An object was created. + type: object + properties: + new: + description: >- + If present, indicates the object was newly created (e.g. as a blank + document), not derived from a Drive object or external object. + $ref: '#/components/schemas/New' + upload: + description: >- + If present, indicates the object originated externally and was + uploaded to Drive. + $ref: '#/components/schemas/Upload' + copy: + description: >- + If present, indicates the object was created by copying an existing + Drive object. + $ref: '#/components/schemas/Copy' + New: + id: New + description: An object was created from scratch. + type: object + properties: {} + Upload: + id: Upload + description: An object was uploaded into Drive. + type: object + properties: {} + Copy: + id: Copy + description: An object was created by copying an existing object. + type: object + properties: + originalObject: + description: The original object. + $ref: '#/components/schemas/TargetReference' + TargetReference: + id: TargetReference + description: A lightweight reference to the target of activity. + type: object + properties: + driveItem: + description: The target is a Drive item. + $ref: '#/components/schemas/DriveItemReference' + drive: + description: The target is a shared drive. + $ref: '#/components/schemas/DriveReference' + teamDrive: + description: This field is deprecated; please use the `drive` field instead. + deprecated: true + $ref: '#/components/schemas/TeamDriveReference' + DriveItemReference: + id: DriveItemReference + description: A lightweight reference to a Drive item, such as a file or folder. + type: object + properties: + name: + description: The target Drive item. The format is `items/ITEM_ID`. + type: string + title: + description: The title of the Drive item. + type: string + file: + description: This field is deprecated; please use the `driveFile` field instead. + deprecated: true + $ref: '#/components/schemas/File' + folder: + description: >- + This field is deprecated; please use the `driveFolder` field + instead. + deprecated: true + $ref: '#/components/schemas/Folder' + driveFile: + description: The Drive item is a file. + $ref: '#/components/schemas/DriveFile' + driveFolder: + description: >- + The Drive item is a folder. Includes information about the type of + folder. + $ref: '#/components/schemas/DriveFolder' + File: + id: File + deprecated: true + description: This item is deprecated; please see `DriveFile` instead. + type: object + properties: {} + Folder: + id: Folder + deprecated: true + description: This item is deprecated; please see `DriveFolder` instead. + type: object + properties: + type: + description: This field is deprecated; please see `DriveFolder.type` instead. + type: string + enumDescriptions: + - This item is deprecated; please see `DriveFolder.Type` instead. + - This item is deprecated; please see `DriveFolder.Type` instead. + - This item is deprecated; please see `DriveFolder.Type` instead. + - This item is deprecated; please see `DriveFolder.Type` instead. + enum: + - TYPE_UNSPECIFIED + - MY_DRIVE_ROOT + - TEAM_DRIVE_ROOT + - STANDARD_FOLDER + DriveFile: + id: DriveFile + description: A Drive item which is a file. + type: object + properties: {} + DriveFolder: + id: DriveFolder + description: A Drive item which is a folder. + type: object + properties: + type: + description: The type of Drive folder. + type: string + enumDescriptions: + - The folder type is unknown. + - The folder is the root of a user's MyDrive. + - The folder is the root of a shared drive. + - The folder is a standard, non-root, folder. + enum: + - TYPE_UNSPECIFIED + - MY_DRIVE_ROOT + - SHARED_DRIVE_ROOT + - STANDARD_FOLDER + DriveReference: + id: DriveReference + description: A lightweight reference to a shared drive. + type: object + properties: + name: + description: >- + The resource name of the shared drive. The format is + `COLLECTION_ID/DRIVE_ID`. Clients should not assume a specific + collection ID for this resource name. + type: string + title: + description: The title of the shared drive. + type: string + TeamDriveReference: + id: TeamDriveReference + deprecated: true + description: This item is deprecated; please see `DriveReference` instead. + type: object + properties: + name: + description: This field is deprecated; please see `DriveReference.name` instead. + type: string + title: + description: This field is deprecated; please see `DriveReference.title` instead. + type: string + Edit: + id: Edit + description: An empty message indicating an object was edited. + type: object + properties: {} + Move: + id: Move + description: An object was moved. + type: object + properties: + addedParents: + description: The added parent object(s). + type: array + items: + $ref: '#/components/schemas/TargetReference' + removedParents: + description: The removed parent object(s). + type: array + items: + $ref: '#/components/schemas/TargetReference' + Rename: + id: Rename + description: An object was renamed. + type: object + properties: + oldTitle: + description: The previous title of the drive object. + type: string + newTitle: + description: The new title of the drive object. + type: string + Delete: + id: Delete + description: An object was deleted. + type: object + properties: + type: + description: The type of delete action taken. + type: string + enumDescriptions: + - Deletion type is not available. + - An object was put into the trash. + - An object was deleted permanently. + enum: + - TYPE_UNSPECIFIED + - TRASH + - PERMANENT_DELETE + Restore: + id: Restore + description: A deleted object was restored. + type: object + properties: + type: + description: The type of restore action taken. + type: string + enumDescriptions: + - The type is not available. + - An object was restored from the trash. + enum: + - TYPE_UNSPECIFIED + - UNTRASH + PermissionChange: + id: PermissionChange + description: A change of the permission setting on an item. + type: object + properties: + addedPermissions: + description: The set of permissions added by this change. + type: array + items: + $ref: '#/components/schemas/Permission' + removedPermissions: + description: The set of permissions removed by this change. + type: array + items: + $ref: '#/components/schemas/Permission' + Permission: + id: Permission + description: The permission setting of an object. + type: object + properties: + role: + description: >- + Indicates the [Google Drive permissions + role](https://developers.google.com/drive/web/manage-sharing#roles). + The role determines a user's ability to read, write, and comment on + items. + type: string + enumDescriptions: + - The role is not available. + - A role granting full access. + - A role granting the ability to manage people and settings. + - A role granting the ability to contribute and manage content. + - >- + A role granting the ability to contribute content. This role is + sometimes also known as "writer". + - A role granting the ability to view and comment on content. + - >- + A role granting the ability to view content. This role is + sometimes also known as "reader". + - >- + A role granting the ability to view content only after it has been + published to the web. This role is sometimes also known as + "published reader". See + https://support.google.com/sites/answer/6372880 for more + information. + enum: + - ROLE_UNSPECIFIED + - OWNER + - ORGANIZER + - FILE_ORGANIZER + - EDITOR + - COMMENTER + - VIEWER + - PUBLISHED_VIEWER + user: + description: The user to whom this permission applies. + $ref: '#/components/schemas/User' + group: + description: The group to whom this permission applies. + $ref: '#/components/schemas/Group' + domain: + description: The domain to whom this permission applies. + $ref: '#/components/schemas/Domain' + anyone: + description: If set, this permission applies to anyone, even logged out users. + $ref: '#/components/schemas/Anyone' + allowDiscovery: + description: >- + If true, the item can be discovered (e.g. in the user's "Shared with + me" collection) without needing a link to the item. + type: boolean + User: + id: User + description: Information about an end user. + type: object + properties: + knownUser: + description: A known user. + $ref: '#/components/schemas/KnownUser' + deletedUser: + description: A user whose account has since been deleted. + $ref: '#/components/schemas/DeletedUser' + unknownUser: + description: A user about whom nothing is currently known. + $ref: '#/components/schemas/UnknownUser' + KnownUser: + id: KnownUser + description: A known user. + type: object + properties: + personName: + description: >- + The identifier for this user that can be used with the People API to + get more information. The format is `people/ACCOUNT_ID`. See + https://developers.google.com/people/. + type: string + isCurrentUser: + description: True if this is the user making the request. + type: boolean + DeletedUser: + id: DeletedUser + description: A user whose account has since been deleted. + type: object + properties: {} + UnknownUser: + id: UnknownUser + description: A user about whom nothing is currently known. + type: object + properties: {} + Group: + id: Group + description: Information about a group. + type: object + properties: + email: + description: The email address of the group. + type: string + title: + description: The title of the group. + type: string + Domain: + id: Domain + description: Information about a domain. + type: object + properties: + name: + description: The name of the domain, e.g. `google.com`. + type: string + legacyId: + description: An opaque string used to identify this domain. + type: string + Anyone: + id: Anyone + description: Represents any user (including a logged out user). + type: object + properties: {} + Comment: + id: Comment + description: A change about comments on an object. + type: object + properties: + post: + description: A change on a regular posted comment. + $ref: '#/components/schemas/Post' + assignment: + description: A change on an assignment. + $ref: '#/components/schemas/Assignment' + suggestion: + description: A change on a suggestion. + $ref: '#/components/schemas/Suggestion' + mentionedUsers: + description: Users who are mentioned in this comment. + type: array + items: + $ref: '#/components/schemas/User' + Post: + id: Post + description: A regular posted comment. + type: object + properties: + subtype: + description: The sub-type of this event. + type: string + enumDescriptions: + - Subtype not available. + - A post was added. + - A post was deleted. + - A reply was added. + - A reply was deleted. + - A posted comment was resolved. + - A posted comment was reopened. + enum: + - SUBTYPE_UNSPECIFIED + - ADDED + - DELETED + - REPLY_ADDED + - REPLY_DELETED + - RESOLVED + - REOPENED + Assignment: + id: Assignment + description: A comment with an assignment. + type: object + properties: + subtype: + description: The sub-type of this event. + type: string + enumDescriptions: + - Subtype not available. + - An assignment was added. + - An assignment was deleted. + - An assignment reply was added. + - An assignment reply was deleted. + - An assignment was resolved. + - A resolved assignment was reopened. + - An assignment was reassigned. + enum: + - SUBTYPE_UNSPECIFIED + - ADDED + - DELETED + - REPLY_ADDED + - REPLY_DELETED + - RESOLVED + - REOPENED + - REASSIGNED + assignedUser: + description: The user to whom the comment was assigned. + $ref: '#/components/schemas/User' + Suggestion: + id: Suggestion + description: A suggestion. + type: object + properties: + subtype: + description: The sub-type of this event. + type: string + enumDescriptions: + - Subtype not available. + - A suggestion was added. + - A suggestion was deleted. + - A suggestion reply was added. + - A suggestion reply was deleted. + - A suggestion was accepted. + - A suggestion was rejected. + - An accepted suggestion was deleted. + - A rejected suggestion was deleted. + enum: + - SUBTYPE_UNSPECIFIED + - ADDED + - DELETED + - REPLY_ADDED + - REPLY_DELETED + - ACCEPTED + - REJECTED + - ACCEPT_DELETED + - REJECT_DELETED + DataLeakPreventionChange: + id: DataLeakPreventionChange + description: A change in the object's data leak prevention status. + type: object + properties: + type: + description: The type of Data Leak Prevention (DLP) change. + type: string + enumDescriptions: + - An update to the DLP state that is neither FLAGGED or CLEARED. + - Document has been flagged as containing sensitive content. + - Document is no longer flagged as containing sensitive content. + enum: + - TYPE_UNSPECIFIED + - FLAGGED + - CLEARED + ApplicationReference: + id: ApplicationReference + description: Activity in applications other than Drive. + type: object + properties: + type: + description: The reference type corresponding to this event. + type: string + enumDescriptions: + - The type is not available. + - The links of one or more Drive items were posted. + - Comments were made regarding a Drive item. + enum: + - UNSPECIFIED_REFERENCE_TYPE + - LINK + - DISCUSS + SettingsChange: + id: SettingsChange + description: Information about settings changes. + type: object + properties: + restrictionChanges: + description: The set of changes made to restrictions. + type: array + items: + $ref: '#/components/schemas/RestrictionChange' + RestrictionChange: + id: RestrictionChange + description: Information about restriction policy changes to a feature. + type: object + properties: + feature: + description: The feature which had a change in restriction policy. + type: string + enumDescriptions: + - The feature which changed restriction settings was not available. + - >- + When restricted, this prevents items from being shared outside the + domain. + - When restricted, this prevents direct sharing of individual items. + - >- + When restricted, this prevents actions like copy, download, and + print that might result in uncontrolled duplicates of items. + - When restricted, this prevents use of Drive File Stream. + - When restricted, this limits sharing of folders to managers only. + enum: + - FEATURE_UNSPECIFIED + - SHARING_OUTSIDE_DOMAIN + - DIRECT_SHARING + - ITEM_DUPLICATION + - DRIVE_FILE_STREAM + - FILE_ORGANIZER_CAN_SHARE_FOLDERS + newRestriction: + description: The restriction in place after the change. + type: string + enumDescriptions: + - The type of restriction is not available. + - The feature is available without restriction. + - The use of this feature is fully restricted. + enum: + - RESTRICTION_UNSPECIFIED + - UNRESTRICTED + - FULLY_RESTRICTED + AppliedLabelChange: + id: AppliedLabelChange + description: Label changes that were made on the Target. + type: object + properties: + changes: + description: Changes that were made to the Label on the Target. + type: array + items: + $ref: '#/components/schemas/AppliedLabelChangeDetail' + AppliedLabelChangeDetail: + id: AppliedLabelChangeDetail + description: A change made to a Label on the Target. + type: object + properties: + label: + description: >- + The Label name representing the Label that changed. This name always + contains the revision of the Label that was used when this Action + occurred. The format is `labels/id@revision`. + type: string + types: + description: The types of changes made to the Label on the Target. + type: array + items: + type: string + enumDescriptions: + - The type of change to this Label is not available. + - The identified Label was added to the Target. + - The identified Label was removed from the Target. + - Field values were changed on the Target. + - The Label was applied as a side-effect of Drive item creation. + enum: + - TYPE_UNSPECIFIED + - LABEL_ADDED + - LABEL_REMOVED + - LABEL_FIELD_VALUE_CHANGED + - LABEL_APPLIED_BY_ITEM_CREATE + title: + description: The human-readable title of the label that changed. + type: string + fieldChanges: + description: >- + Field Changes. Only present if `types` contains + `LABEL_FIELD_VALUE_CHANGED`. + type: array + items: + $ref: '#/components/schemas/FieldValueChange' + FieldValueChange: + id: FieldValueChange + description: Change to a Field value. + type: object + properties: + fieldId: + description: The ID of this field. Field IDs are unique within a Label. + type: string + oldValue: + description: >- + The value that was previously set on the field. If not present, the + field was newly set. At least one of {old_value|new_value} is always + set. + $ref: '#/components/schemas/FieldValue' + newValue: + description: >- + The value that is now set on the field. If not present, the field + was cleared. At least one of {old_value|new_value} is always set. + $ref: '#/components/schemas/FieldValue' + displayName: + description: The human-readable display name for this field. + type: string + FieldValue: + id: FieldValue + description: Contains a value of a Field. + type: object + properties: + text: + description: Text Field value. + $ref: '#/components/schemas/Text' + textList: + description: Text List Field value. + $ref: '#/components/schemas/TextList' + selection: + description: Selection Field value. + $ref: '#/components/schemas/Selection' + selectionList: + description: Selection List Field value. + $ref: '#/components/schemas/SelectionList' + integer: + description: Integer Field value. + $ref: '#/components/schemas/Integer' + user: + description: User Field value. + $ref: '#/components/schemas/SingleUser' + userList: + description: User List Field value. + $ref: '#/components/schemas/UserList' + date: + description: Date Field value. + $ref: '#/components/schemas/Date' + Text: + id: Text + description: Wrapper for Text Field value. + type: object + properties: + value: + description: Value of Text Field. + type: string + TextList: + id: TextList + description: Wrapper for Text List Field value. + type: object + properties: + values: + description: Text values. + type: array + items: + $ref: '#/components/schemas/Text' + Selection: + id: Selection + description: >- + Wrapper for Selection Field value as combined value/display_name pair + for selected choice. + type: object + properties: + value: + description: Selection value as Field Choice ID. + type: string + displayName: + description: Selection value as human-readable display string. + type: string + SelectionList: + id: SelectionList + description: Wrapper for SelectionList Field value. + type: object + properties: + values: + description: Selection values. + type: array + items: + $ref: '#/components/schemas/Selection' + Integer: + id: Integer + description: Wrapper for Integer Field value. + type: object + properties: + value: + description: Integer value. + type: string + format: int64 + SingleUser: + id: SingleUser + description: Wrapper for User Field value. + type: object + properties: + value: + description: User value as email. + type: string + UserList: + id: UserList + description: Wrapper for UserList Field value. + type: object + properties: + values: + description: User values. + type: array + items: + $ref: '#/components/schemas/SingleUser' + Date: + id: Date + description: Wrapper for Date Field value. + type: object + properties: + value: + description: Date value. + type: string + format: google-datetime + Actor: + id: Actor + description: The actor of a Drive activity. + type: object + properties: + user: + description: An end user. + $ref: '#/components/schemas/User' + anonymous: + description: An anonymous user. + $ref: '#/components/schemas/AnonymousUser' + impersonation: + description: An account acting on behalf of another. + $ref: '#/components/schemas/Impersonation' + system: + description: A non-user actor (i.e. system triggered). + $ref: '#/components/schemas/SystemEvent' + administrator: + description: An administrator. + $ref: '#/components/schemas/Administrator' + AnonymousUser: + id: AnonymousUser + description: >- + Empty message representing an anonymous user or indicating the + authenticated user should be anonymized. + type: object + properties: {} + Impersonation: + id: Impersonation + description: >- + Information about an impersonation, where an admin acts on behalf of an + end user. Information about the acting admin is not currently available. + type: object + properties: + impersonatedUser: + description: The impersonated user. + $ref: '#/components/schemas/User' + SystemEvent: + id: SystemEvent + description: Event triggered by system operations instead of end users. + type: object + properties: + type: + description: The type of the system event that may triggered activity. + type: string + enumDescriptions: + - The event type is unspecified. + - The event is a consequence of a user account being deleted. + - The event is due to the system automatically purging trash. + enum: + - TYPE_UNSPECIFIED + - USER_DELETION + - TRASH_AUTO_PURGE + Administrator: + id: Administrator + description: Empty message representing an administrator. + type: object + properties: {} + Action: + id: Action + description: Information about the action. + type: object + properties: + detail: + description: The type and detailed information about the action. + $ref: '#/components/schemas/ActionDetail' + actor: + description: >- + The actor responsible for this action (or empty if all actors are + responsible). + $ref: '#/components/schemas/Actor' + target: + description: >- + The target this action affects (or empty if affecting all targets). + This represents the state of the target immediately after this + action occurred. + $ref: '#/components/schemas/Target' + timestamp: + description: The action occurred at this specific time. + type: string + format: google-datetime + timeRange: + description: The action occurred over this time range. + $ref: '#/components/schemas/TimeRange' + Target: + id: Target + description: >- + Information about the target of activity. For more information on how + activity history is shared with users, see [Activity history + visibility](https://developers.google.com/drive/activity/v2#activityhistory). + type: object + properties: + driveItem: + description: The target is a Drive item. + $ref: '#/components/schemas/DriveItem' + drive: + description: The target is a shared drive. + $ref: '#/components/schemas/Drive' + fileComment: + description: The target is a comment on a Drive file. + $ref: '#/components/schemas/FileComment' + teamDrive: + description: This field is deprecated; please use the `drive` field instead. + deprecated: true + $ref: '#/components/schemas/TeamDrive' + DriveItem: + id: DriveItem + description: A Drive item, such as a file or folder. + type: object + properties: + name: + description: The target Drive item. The format is `items/ITEM_ID`. + type: string + title: + description: The title of the Drive item. + type: string + file: + description: This field is deprecated; please use the `driveFile` field instead. + deprecated: true + $ref: '#/components/schemas/File' + folder: + description: >- + This field is deprecated; please use the `driveFolder` field + instead. + deprecated: true + $ref: '#/components/schemas/Folder' + driveFile: + description: The Drive item is a file. + $ref: '#/components/schemas/DriveFile' + driveFolder: + description: >- + The Drive item is a folder. Includes information about the type of + folder. + $ref: '#/components/schemas/DriveFolder' + mimeType: + description: >- + The MIME type of the Drive item. See + https://developers.google.com/drive/v3/web/mime-types. + type: string + owner: + description: Information about the owner of this Drive item. + $ref: '#/components/schemas/Owner' + Owner: + id: Owner + description: Information about the owner of a Drive item. + type: object + properties: + user: + description: The user that owns the Drive item. + $ref: '#/components/schemas/User' + drive: + description: The drive that owns the item. + $ref: '#/components/schemas/DriveReference' + teamDrive: + description: This field is deprecated; please use the `drive` field instead. + deprecated: true + $ref: '#/components/schemas/TeamDriveReference' + domain: + description: The domain of the Drive item owner. + $ref: '#/components/schemas/Domain' + Drive: + id: Drive + description: Information about a shared drive. + type: object + properties: + name: + description: >- + The resource name of the shared drive. The format is + `COLLECTION_ID/DRIVE_ID`. Clients should not assume a specific + collection ID for this resource name. + type: string + title: + description: The title of the shared drive. + type: string + root: + description: The root of this shared drive. + $ref: '#/components/schemas/DriveItem' + FileComment: + id: FileComment + description: A comment on a file. + type: object + properties: + legacyCommentId: + description: >- + The comment in the discussion thread. This identifier is an opaque + string compatible with the Drive API; see + https://developers.google.com/drive/v3/reference/comments/get + type: string + legacyDiscussionId: + description: >- + The discussion thread to which the comment was added. This + identifier is an opaque string compatible with the Drive API and + references the first comment in a discussion; see + https://developers.google.com/drive/v3/reference/comments/get + type: string + linkToDiscussion: + description: >- + The link to the discussion thread containing this comment, for + example, `https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID`. + type: string + parent: + description: The Drive item containing this comment. + $ref: '#/components/schemas/DriveItem' + TeamDrive: + id: TeamDrive + deprecated: true + description: This item is deprecated; please see `Drive` instead. + type: object + properties: + name: + description: This field is deprecated; please see `Drive.name` instead. + type: string + title: + description: This field is deprecated; please see `Drive.title` instead. + type: string + root: + description: This field is deprecated; please see `Drive.root` instead. + $ref: '#/components/schemas/DriveItem' + TimeRange: + id: TimeRange + description: Information about time ranges. + type: object + properties: + startTime: + description: The start of the time range. + type: string + format: google-datetime + endTime: + description: The end of the time range. + type: string + format: google-datetime + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + activity: + id: googleworkspace.driveactivityv2.activity + name: activity + title: Activity + methods: + query: + operation: + $ref: '#/paths/~1v2~1activity:query/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2/activity:query: + parameters: + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: Query past activity in Google Drive. + operationId: driveactivity.activity.query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDriveActivityRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.activity + Oauth2c: + - https://www.googleapis.com/auth/drive.activity + - Oauth2: + - https://www.googleapis.com/auth/drive.activity.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.activity.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDriveActivityResponse' + parameters: [] diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2.yaml new file mode 100644 index 00000000..637d6e24 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2.yaml @@ -0,0 +1,3394 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Drive Labels API + description: An API for managing Drive Labels + version: v2 + x-discovery-doc-revision: '20241204' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/labels +servers: + - url: https://drivelabels.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive.admin.labels: >- + See, edit, create, and delete all Google Drive labels in your + organization, and see your organization's label-related admin + policies + https://www.googleapis.com/auth/drive.labels.readonly: See your Google Drive labels + https://www.googleapis.com/auth/drive.labels: See, edit, create, and delete your Google Drive labels + https://www.googleapis.com/auth/drive.admin.labels.readonly: >- + See all Google Drive labels and label-related admin policies in + your organization + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest: + properties: + selectionOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptions' + description: Update field to Selection. + id: + description: Required. The Field to update. + type: string + updateMask: + type: string + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root of `type_options` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + textOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldTextOptions' + description: Update field to Text. + integerOptions: + description: Update field to Integer. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldIntegerOptions' + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDateOptions' + description: Update field to Date. + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldUserOptions' + description: Update field to User. + description: Request to change the type of a Field. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest + type: object + GoogleAppsDriveLabelsV2BadgeColors: + id: GoogleAppsDriveLabelsV2BadgeColors + type: object + description: >- + The color derived from BadgeConfig and changed to the closest + recommended supported color. + properties: + soloColor: + readOnly: true + $ref: '#/components/schemas/GoogleTypeColor' + description: Output only. Color that can be used for text without a background. + backgroundColor: + readOnly: true + $ref: '#/components/schemas/GoogleTypeColor' + description: Output only. Badge background that pairs with the foreground. + foregroundColor: + description: Output only. Badge foreground that pairs with the background. + $ref: '#/components/schemas/GoogleTypeColor' + readOnly: true + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice: + type: object + description: Selection field choice. + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice + properties: + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties + description: Basic properties of the choice. + id: + type: string + description: >- + The unique value of the choice. This ID is autogenerated. Matches + the regex: `([a-zA-Z0-9_])+`. + createTime: + type: string + format: google-datetime + description: Output only. The time this choice was created. + readOnly: true + displayHints: + description: Output only. UI display hints for rendering a choice. + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints + appliedCapabilities: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities + description: >- + Output only. The capabilities related to this choice on applied + metadata. + readOnly: true + disableTime: + description: >- + Output only. The time this choice was disabled. This value has no + meaning when the choice is not disabled. + readOnly: true + format: google-datetime + type: string + creator: + readOnly: true + description: Output only. The user who created this choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + updater: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who updated this choice last. + readOnly: true + updateTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time this choice was updated last. + schemaCapabilities: + readOnly: true + description: >- + Output only. The capabilities related to this option when editing + the option. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities + publishTime: + type: string + description: >- + Output only. The time this choice was published. This value has no + meaning when the choice is not published. + readOnly: true + format: google-datetime + publisher: + description: >- + Output only. The user who published this choice. This value has no + meaning when the choice is not published. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + lifecycle: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' + description: Output only. Lifecycle of the choice. + readOnly: true + lockStatus: + readOnly: true + description: Output only. The LockStatus of this choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' + disabler: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + description: >- + Output only. The user who disabled this choice. This value has no + meaning when the option is not disabled. + GoogleAppsDriveLabelsV2ListLimits: + type: object + properties: + maxEntries: + type: integer + format: int32 + description: Maximum number of values allowed for the Field type. + id: GoogleAppsDriveLabelsV2ListLimits + description: Limits for list-variant of a Field type. + GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest: + description: Updates one or more Label Permissions. + id: GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest + properties: + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + UpdateLabelPermissionRequest messages must either be empty or match + this field. + requests: + description: Required. The request message specifying the resources to update. + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest + type: array + type: object + GoogleAppsDriveLabelsV2LifecycleDisabledPolicy: + properties: + hideInSearch: + type: boolean + description: >- + Whether to hide this disabled object in the search menu for Drive + items. * When `false`, the object is generally shown in the UI as + disabled but it appears in the search results when searching for + Drive items. * When `true`, the object is generally hidden in the UI + when searching for Drive items. + showInApply: + type: boolean + description: >- + Whether to show this disabled object in the apply menu on Drive + items. * When `true`, the object is generally shown in the UI as + disabled and is unselectable. * When `false`, the object is + generally hidden in the UI. + id: GoogleAppsDriveLabelsV2LifecycleDisabledPolicy + description: >- + The policy that governs how to treat a disabled label, field, or + selection choice in different contexts. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties: + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties + properties: + badgeConfig: + description: >- + The badge configuration for this choice. When set, the label that + owns this choice is considered a "badged label". + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeConfig' + description: + description: The description of this label. + type: string + insertBeforeChoice: + description: >- + Input only. Insert or move this choice before the indicated choice. + If empty, the choice is placed at the end of the list. + type: string + displayName: + type: string + description: Required. The display text to show in the UI identifying this field. + type: object + description: Basic properties of the choice. + GoogleTypeColor: + properties: + red: + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + blue: + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + green: + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + alpha: + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + type: object + id: GoogleTypeColor + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse: + type: object + properties: + updatedLabel: + description: >- + The label after updates were applied. This is only set if + [BatchUpdateLabelResponse2.include_label_in_response] is `true` and + there were no errors. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + responses: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse + type: array + description: >- + The reply of the updates. This maps 1:1 with the updates, although + responses to some requests may be empty. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse + description: Response for Label update. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest + properties: + fieldId: + type: string + description: Required. The Selection Field from which a Choice will be deleted. + id: + description: Required. Choice to delete. + type: string + description: Request to delete a Choice. + GoogleAppsDriveLabelsV2FieldListOptions: + description: Options for a multi-valued variant of an associated field type. + id: GoogleAppsDriveLabelsV2FieldListOptions + type: object + properties: + maxEntries: + description: Maximum number of entries permitted. + format: int32 + type: integer + GoogleAppsDriveLabelsV2BadgeConfig: + id: GoogleAppsDriveLabelsV2BadgeConfig + description: Badge status of the label. + properties: + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: >- + The color of the badge. When not specified, no badge is rendered. + The background, foreground, and solo (light and dark mode) colors + set here are changed in the Drive UI into the closest recommended + supported color. + priorityOverride: + format: int64 + description: >- + Override the default global priority of this badge. When set to 0, + the default priority heuristic is used. + type: string + type: object + GoogleAppsDriveLabelsV2LongTextLimits: + id: GoogleAppsDriveLabelsV2LongTextLimits + type: object + properties: + maxLength: + description: Maximum length allowed for a long text Field type. + type: integer + format: int32 + minLength: + description: Minimum length allowed for a long text Field type. + format: int32 + type: integer + description: Limits for long text Field type. + GoogleAppsDriveLabelsV2LabelLimits: + type: object + description: >- + Label constraints governing the structure of a Label; such as, the + maximum number of Fields allowed and maximum length of the label title. + id: GoogleAppsDriveLabelsV2LabelLimits + properties: + fieldLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldLimits' + description: The limits for Fields. + maxDeletedFields: + format: int32 + description: The maximum number of published Fields that can be deleted. + type: integer + maxDraftRevisions: + type: integer + description: >- + The maximum number of draft revisions that will be kept before + deleting old drafts. + format: int32 + maxFields: + format: int32 + description: The maximum number of Fields allowed within the label. + type: integer + maxDescriptionLength: + type: integer + description: The maximum number of characters allowed for the description. + format: int32 + maxTitleLength: + format: int32 + description: The maximum number of characters allowed for the title. + type: integer + name: + type: string + description: Resource name. + GoogleTypeDate: + type: object + properties: + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + id: GoogleTypeDate + GoogleAppsDriveLabelsV2PublishLabelRequest: + type: object + properties: + writeControl: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + description: Request to publish a label. + id: GoogleAppsDriveLabelsV2PublishLabelRequest + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse + description: Response following Choice enable. + properties: {} + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest: + properties: + fieldId: + type: string + description: Required. The Selection Field to update. + id: + type: string + description: Required. The Choice to update. + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties + description: Required. The Choice properties to update. + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + description: Request to update a Choice properties. + GoogleAppsDriveLabelsV2Lifecycle: + description: >- + The lifecycle state of an object, such as label, field, or choice. The + lifecycle enforces the following transitions: * `UNPUBLISHED_DRAFT` + (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * + `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * + `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted) The published and + disabled states have some distinct characteristics: * Published—Some + kinds of changes might be made to an object in this state, in which case + `has_unpublished_changes` will be true. Also, some kinds of changes are + not permitted. Generally, any change that would invalidate or cause new + restrictions on existing metadata related to the label are rejected. * + Disabled—When disabled, the configured `DisabledPolicy` takes effect. + type: object + properties: + disabledPolicy: + description: >- + The policy that governs how to show a disabled label, field, or + selection choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + hasUnpublishedChanges: + description: >- + Output only. Whether the object associated with this lifecycle has + unpublished changes. + type: boolean + readOnly: true + state: + enum: + - STATE_UNSPECIFIED + - UNPUBLISHED_DRAFT + - PUBLISHED + - DISABLED + - DELETED + readOnly: true + description: Output only. The state of the object associated with this lifecycle. + type: string + enumDescriptions: + - Unknown State. + - >- + The initial state of an object. Once published, the object can + never return to this state. Once an object is published, certain + kinds of changes are no longer permitted. + - >- + The object has been published. The object might have unpublished + draft changes as indicated by `has_unpublished_changes`. + - >- + The object has been published and has since been disabled. The + object might have unpublished draft changes as indicated by + `has_unpublished_changes`. + - The object has been deleted. + id: GoogleAppsDriveLabelsV2Lifecycle + GoogleAppsDriveLabelsV2FieldLimits: + id: GoogleAppsDriveLabelsV2FieldLimits + description: >- + Field constants governing the structure of a Field; such as, the maximum + title length, minimum and maximum field values or length, etc. + type: object + properties: + userLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserLimits' + description: User Field limits. + longTextLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LongTextLimits' + description: Long text Field limits. + textLimits: + description: The relevant limits for the specified Field.Type. Text Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2TextLimits' + maxDescriptionLength: + type: integer + format: int32 + description: Limits for Field description, also called help text. + dateLimits: + description: Date Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DateLimits' + maxDisplayNameLength: + type: integer + format: int32 + description: Limits for Field title. + maxIdLength: + format: int32 + type: integer + description: Max length for the id. + selectionLimits: + description: Selection Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2SelectionLimits' + integerLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2IntegerLimits' + description: Integer Field limits. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest: + type: object + description: Request to enable the Field. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest + properties: + id: + type: string + description: Required. ID of the Field to enable. + GoogleAppsDriveLabelsV2FieldUserOptions: + description: Options for the user field type. + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldListOptions' + description: >- + When specified, indicates that this field supports a list of values. + Once the field is published, this cannot be changed. + id: GoogleAppsDriveLabelsV2FieldUserOptions + type: object + GoogleAppsDriveLabelsV2LabelLockCapabilities: + properties: + canViewPolicy: + type: boolean + description: True if the user is authorized to view the policy. + description: A description of a user's capabilities on a LabelLock. + type: object + id: GoogleAppsDriveLabelsV2LabelLockCapabilities + GoogleAppsDriveLabelsV2SelectionLimits: + description: Limits for selection Field type. + properties: + maxIdLength: + description: Maximum ID length for a selection options. + type: integer + format: int32 + maxChoices: + format: int32 + type: integer + description: The max number of choices. + maxDisplayNameLength: + description: Maximum length for display name. + format: int32 + type: integer + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLimits' + description: Limits for list-variant of a Field type. + maxDeletedChoices: + format: int32 + description: Maximum number of deleted choices. + type: integer + type: object + id: GoogleAppsDriveLabelsV2SelectionLimits + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse + properties: {} + description: Response following Field disable. + type: object + GoogleAppsDriveLabelsV2LabelProperties: + type: object + id: GoogleAppsDriveLabelsV2LabelProperties + properties: + description: + type: string + description: The description of the label. + title: + type: string + description: Required. Title of the label. + description: Basic properties of the label. + GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest: + type: object + id: GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest + properties: + requests: + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest + description: Required. The request message specifying the resources to update. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + DeleteLabelPermissionRequest messages must either be empty or match + this field. + type: boolean + description: Deletes one of more Label Permissions. + GoogleAppsDriveLabelsV2ListLabelsResponse: + id: GoogleAppsDriveLabelsV2ListLabelsResponse + properties: + nextPageToken: + type: string + description: The token of the next page in the response. + labels: + description: Labels. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + type: array + description: Response for listing Labels. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities: + type: object + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities + description: The capabilities related to this choice on applied metadata. + properties: + canSelect: + type: boolean + description: Whether the user can select this choice on an item. + canSearch: + type: boolean + description: Whether the user can use this choice in search queries. + canRead: + description: Whether the user can read related applied metadata on items. + type: boolean + GoogleAppsDriveLabelsV2FieldProperties: + properties: + required: + description: Whether the field should be marked as required. + type: boolean + displayName: + type: string + description: Required. The display text to show in the UI identifying this field. + insertBeforeField: + type: string + description: >- + Input only. Insert or move this field before the indicated field. If + empty, the field is placed at the end of the list. + type: object + id: GoogleAppsDriveLabelsV2FieldProperties + description: The basic properties of the field. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse: + type: object + description: Response following Field delete. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse + properties: {} + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse: + properties: {} + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse + description: Response following update to Field type. + GoogleAppsDriveLabelsV2FieldAppliedCapabilities: + id: GoogleAppsDriveLabelsV2FieldAppliedCapabilities + description: The capabilities related to this field on applied metadata. + type: object + properties: + canSearch: + type: boolean + description: Whether the user can search for Drive items referencing this field. + canWrite: + type: boolean + description: Whether the user can set this field on Drive items. + canRead: + type: boolean + description: Whether the user can read related applied metadata on items. + GoogleAppsDriveLabelsV2FieldSchemaCapabilities: + properties: + canUpdate: + type: boolean + description: Whether the user can change this field. + canDisable: + type: boolean + description: >- + Whether the user can disable this field. The user must have + permission and this field must not already be disabled. + canDelete: + type: boolean + description: >- + Whether the user can delete this field. The user must have + permission and the field must be deprecated. + canEnable: + description: >- + Whether the user can enable this field. The user must have + permission and this field must be disabled. + type: boolean + description: The capabilities related to this field when editing the field. + id: GoogleAppsDriveLabelsV2FieldSchemaCapabilities + type: object + GoogleAppsDriveLabelsV2UserLimits: + description: Limits for Field.Type.USER. + id: GoogleAppsDriveLabelsV2UserLimits + properties: + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLimits' + description: Limits for list-variant of a Field type. + type: object + GoogleAppsDriveLabelsV2ListLabelLocksResponse: + description: The response to a ListLabelLocksRequest. + id: GoogleAppsDriveLabelsV2ListLabelLocksResponse + properties: + nextPageToken: + type: string + description: The token of the next page in the response. + labelLocks: + description: LabelLocks. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLock' + type: array + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse: + properties: + priority: + format: int32 + description: >- + The priority of the updated field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + type: integer + description: Response following update to Field properties. + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse + type: object + GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest: + type: object + id: GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest + description: >- + Updates a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + properties: + parent: + description: Required. The parent Label resource name. + type: string + labelPermission: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + description: Required. The permission to create or update on the Label. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + GoogleAppsDriveLabelsV2EnableLabelRequest: + properties: + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + description: Request to enable a label. + id: GoogleAppsDriveLabelsV2EnableLabelRequest + type: object + GoogleAppsDriveLabelsV2LockStatus: + id: GoogleAppsDriveLabelsV2LockStatus + properties: + locked: + type: boolean + readOnly: true + description: >- + Output only. Indicates whether this label component is the (direct) + target of a LabelLock. A label component can be implicitly locked + even if it's not the direct target of a LabelLock, in which case + this field is set to false. + description: >- + Contains information about whether a label component should be + considered locked. + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest: + properties: + properties: + description: Required. Label properties to update. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelProperties' + updateMask: + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `label_properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest + description: Updates basic properties of a Label. + type: object + GoogleAppsDriveLabelsV2DateLimits: + type: object + properties: + maxValue: + description: Maximum value for the date Field type. + $ref: '#/components/schemas/GoogleTypeDate' + minValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: Minimum value for the date Field type. + id: GoogleAppsDriveLabelsV2DateLimits + description: Limits for date Field type. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse + type: object + description: Response following Choice delete. + properties: {} + GoogleProtobufEmpty: + type: object + properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: GoogleProtobufEmpty + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Request to update Field properties. + properties: + updateMask: + type: string + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldProperties' + description: Required. Basic Field properties. + id: + description: Required. The Field to update. + type: string + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest + type: object + description: Request to create a Field within a Label. + properties: + field: + description: Required. Field to create. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Field' + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints: + properties: + disabled: + description: Whether the option should be shown in the UI as disabled. + type: boolean + hiddenInSearch: + type: boolean + description: >- + This option should be hidden in the search menu when searching for + Drive items. + badgePriority: + description: >- + The priority of this badge. Used to compare and sort between + multiple badges. A lower number means the badge should be shown + first. When a badging configuration is not present, this will be 0. + Otherwise, this will be set to `BadgeConfig.priority_override` or + the default heuristic which prefers creation date of the label, and + field and option priority. + format: int64 + type: string + badgeColors: + description: >- + The colors to use for the badge. Changed to Google Material colors + based on the chosen `properties.badge_config.color`. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeColors' + darkBadgeColors: + description: >- + The dark-mode color to use for the badge. Changed to Google Material + colors based on the chosen `properties.badge_config.color`. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeColors' + shownInApply: + description: >- + This option should be shown in the apply menu when applying values + to a Drive item. + type: boolean + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints + description: UI display hints for rendering an option. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities: + properties: + canUpdate: + description: Whether the user can update this choice. + type: boolean + canDisable: + description: Whether the user can disable this choice. + type: boolean + canDelete: + type: boolean + description: Whether the user can delete this choice. + canEnable: + type: boolean + description: Whether the user can enable this choice. + type: object + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities + description: The capabilities related to this choice when editing the choice. + GoogleAppsDriveLabelsV2UserCapabilities: + type: object + id: GoogleAppsDriveLabelsV2UserCapabilities + description: The capabilities of a user. + properties: + canAdministrateLabels: + description: >- + Output only. Whether the user is an administrator for the shared + labels feature. + readOnly: true + type: boolean + canCreateSharedLabels: + readOnly: true + description: >- + Output only. Whether the user is allowed to create new shared + labels. + type: boolean + canCreateAdminLabels: + type: boolean + readOnly: true + description: Output only. Whether the user is allowed to create new admin labels. + canAccessLabelManager: + type: boolean + readOnly: true + description: >- + Output only. Whether the user is allowed access to the label + manager. + name: + description: Output only. Resource name for the user capabilities. + type: string + readOnly: true + GoogleAppsDriveLabelsV2FieldTextOptions: + type: object + id: GoogleAppsDriveLabelsV2FieldTextOptions + description: Options for the Text field type. + properties: + maxLength: + type: integer + format: int32 + description: Output only. The maximum valid length of values for the text field. + readOnly: true + minLength: + description: Output only. The minimum valid length of values for the text field. + format: int32 + readOnly: true + type: integer + GoogleAppsDriveLabelsV2Label: + description: >- + A label defines a taxonomy that can be applied to Drive items in order + to organize and search across items. Labels can be simple strings, or + can contain fields that describe additional metadata that can be further + used to organize and search Drive items. + id: GoogleAppsDriveLabelsV2Label + properties: + appliedCapabilities: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelAppliedCapabilities' + description: >- + Output only. The capabilities related to this label on applied + metadata. + readOnly: true + publishTime: + description: >- + Output only. The time this label was published. This value has no + meaning when the label is not published. + format: google-datetime + type: string + readOnly: true + revisionCreator: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who created this label revision. + disabler: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: >- + Output only. The user who disabled this label. This value has no + meaning when the label is not disabled. + readOnly: true + id: + type: string + description: >- + Output only. Globally unique identifier of this label. ID makes up + part of the label `name`, but unlike `name`, ID is consistent + between revisions. Matches the regex: `([a-zA-Z0-9])+` + readOnly: true + revisionId: + type: string + readOnly: true + description: >- + Output only. Revision ID of the label. Revision ID might be part of + the label `name` depending on the request issued. A new revision is + created whenever revisioned properties of a label are changed. + Matches the regex: `([a-zA-Z0-9])+` + creator: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who created this label. + lifecycle: + description: >- + Output only. The lifecycle state of the label including whether it's + published, deprecated, and has draft changes. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' + readOnly: true + appliedLabelPolicy: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy' + readOnly: true + description: >- + Output only. Behavior of this label when it's applied to Drive + items. + schemaCapabilities: + description: Output only. The capabilities the user has on this label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelSchemaCapabilities' + displayHints: + description: Output only. UI display hints for rendering the label. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelDisplayHints' + readOnly: true + labelType: + type: string + enumDescriptions: + - Unknown label type. + - Shared labels may be shared with users to apply to Drive items. + - >- + Admin-owned label. Only creatable and editable by admins. Supports + some additional admin-only features. + - >- + A label owned by an internal Google application rather than a + customer. These labels are read-only. + enum: + - LABEL_TYPE_UNSPECIFIED + - SHARED + - ADMIN + - GOOGLE_APP + description: Required. The type of label. + revisionCreateTime: + format: google-datetime + description: Output only. The time this label revision was created. + readOnly: true + type: string + customer: + type: string + readOnly: true + description: >- + Output only. The customer this label belongs to. For example: + "customers/123abc789." + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelProperties' + description: Required. The basic properties of the label. + name: + readOnly: true + description: >- + Output only. Resource name of the label. Will be in the form of + either: `labels/{id}` or `labels/{id}@{revision_id}` depending on + the request. See `id` and `revision_id` below. + type: string + disableTime: + format: google-datetime + readOnly: true + description: >- + Output only. The time this label was disabled. This value has no + meaning when the label is not disabled. + type: string + createTime: + format: google-datetime + readOnly: true + description: Output only. The time this label was created. + type: string + learnMoreUri: + type: string + description: >- + Custom URL to present to users to allow them to learn more about + this label and how it should be used. + fields: + type: array + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Field' + description: List of fields in descending priority order. + lockStatus: + description: Output only. The LockStatus of this label. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' + readOnly: true + publisher: + description: >- + Output only. The user who published this label. This value has no + meaning when the label is not published. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + type: object + GoogleAppsDriveLabelsV2IntegerLimits: + type: object + id: GoogleAppsDriveLabelsV2IntegerLimits + properties: + minValue: + type: string + description: Minimum value for an integer Field type. + format: int64 + maxValue: + format: int64 + description: Maximum value for an integer Field type. + type: string + description: Limits for integer Field type. + GoogleAppsDriveLabelsV2FieldDateOptions: + properties: + minValue: + description: Output only. Minimum valid value (year, month, day). + readOnly: true + $ref: '#/components/schemas/GoogleTypeDate' + dateFormat: + readOnly: true + description: Output only. ICU date format. + type: string + dateFormatType: + type: string + description: >- + Localized date formatting option. Field values are rendered in this + format according to their locale. + enumDescriptions: + - Date format unspecified. + - >- + Includes full month name. For example, January 12, 1999 (MMMM d, + y) + - Short, numeric, representation. For example, 12/13/99 (M/d/yy) + enum: + - DATE_FORMAT_UNSPECIFIED + - LONG_DATE + - SHORT_DATE + maxValue: + description: Output only. Maximum valid value (year, month, day). + readOnly: true + $ref: '#/components/schemas/GoogleTypeDate' + id: GoogleAppsDriveLabelsV2FieldDateOptions + description: Options for the date field type. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptions: + type: object + description: Options for the selection field type. + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldListOptions' + description: >- + When specified, indicates this field supports a list of values. Once + the field is published, this cannot be changed. + choices: + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice + description: >- + The options available for this selection field. The list order is + consistent, and modified with `insert_before_choice`. + id: GoogleAppsDriveLabelsV2FieldSelectionOptions + GoogleAppsDriveLabelsV2UserInfo: + type: object + properties: + person: + type: string + description: >- + The identifier for this user that can be used with the People API to + get more information. For example, people/12345678. + id: GoogleAppsDriveLabelsV2UserInfo + description: Information about a user. + GoogleAppsDriveLabelsV2LabelAppliedCapabilities: + id: GoogleAppsDriveLabelsV2LabelAppliedCapabilities + type: object + description: The capabilities a user has on this label's applied metadata. + properties: + canRemove: + type: boolean + description: Whether the user can remove this label from items. + canApply: + type: boolean + description: Whether the user can apply this label to items. + canRead: + type: boolean + description: Whether the user can read applied metadata related to this label. + GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse: + description: Response for updating one or more Label Permissions. + type: object + properties: + permissions: + description: Required. Permissions updated. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + type: array + id: GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse + GoogleAppsDriveLabelsV2WriteControl: + description: >- + Provides control over how write requests are executed. When not + specified, the last write wins. + properties: + requiredRevisionId: + type: string + description: >- + The revision_id of the label that the write request will be applied + to. If this is not the latest revision of the label, the request + will not be processed and will return a 400 Bad Request error. + id: GoogleAppsDriveLabelsV2WriteControl + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse: + properties: {} + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse + description: Response following Choice disable. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse: + properties: + priority: + format: int32 + type: integer + description: >- + The priority of the created field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + id: + type: string + description: >- + The field of the created field. When left blank in a create request, + a key will be autogenerated and can be identified here. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse + description: Response following Field create. + type: object + GoogleAppsDriveLabelsV2ListLabelPermissionsResponse: + type: object + description: Response for listing the permissions on a Label. + properties: + nextPageToken: + description: The token of the next page in the response. + type: string + labelPermissions: + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + type: array + description: Label permissions. + id: GoogleAppsDriveLabelsV2ListLabelPermissionsResponse + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse + description: Response following Selection Choice create. + properties: + fieldId: + description: The server-generated id of the field. + type: string + id: + description: The server-generated ID of the created choice within the Field + type: string + GoogleAppsDriveLabelsV2TextLimits: + id: GoogleAppsDriveLabelsV2TextLimits + properties: + maxLength: + description: Maximum length allowed for a text Field type. + format: int32 + type: integer + minLength: + type: integer + format: int32 + description: Minimum length allowed for a text Field type. + type: object + description: Limits for text Field type. + GoogleAppsDriveLabelsV2FieldIntegerOptions: + description: Options for the Integer field type. + id: GoogleAppsDriveLabelsV2FieldIntegerOptions + type: object + properties: + maxValue: + type: string + description: Output only. The maximum valid value for the integer field. + readOnly: true + format: int64 + minValue: + format: int64 + type: string + readOnly: true + description: Output only. The minimum valid value for the integer field. + GoogleAppsDriveLabelsV2LabelSchemaCapabilities: + properties: + canUpdate: + description: Whether the user can change this label. + type: boolean + canEnable: + type: boolean + description: >- + Whether the user can enable this label. The user must have + permission and this label must be disabled. + canDisable: + description: >- + Whether the user can disable this label. The user must have + permission and this label must not already be disabled. + type: boolean + canDelete: + type: boolean + description: >- + Whether the user can delete this label. The user must have + permission and the label must be disabled. + id: GoogleAppsDriveLabelsV2LabelSchemaCapabilities + type: object + description: The capabilities related to this label when editing the label. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + properties: + priority: + format: int32 + type: integer + description: >- + The priority of the updated choice. The priority may change from + what was specified to assure contiguous priorities between choices + (1-n). + type: object + description: Response following update to Selection Choice properties. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse: + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse + properties: + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse + description: Update Field type and/or type options. + enableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse + description: Enables a Choice within a Selection Field. + updateField: + description: Updates basic properties of a Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse + description: Deletes a Field from the label. + updateLabel: + description: Updated basic properties of a Label. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse + deleteSelectionChoice: + description: Deletes a Choice from a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse + description: Enables Field. + createSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse + description: Creates a new selection list option to add to a Selection Field. + disableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse + description: Disables Field. + updateSelectionChoiceProperties: + description: Updates a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + disableSelectionChoice: + description: Disables a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse + createField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse + description: Creates a new Field. + description: A single response from an update. + GoogleAppsDriveLabelsV2LabelDisplayHints: + description: UI display hints for rendering the label. + properties: + priority: + type: string + description: Order to display label in a list. + format: int64 + disabled: + type: boolean + description: Whether the label should be shown in the UI as disabled. + shownInApply: + description: >- + This label should be shown in the apply menu when applying values to + a Drive item. + type: boolean + hiddenInSearch: + description: >- + This label should be hidden in the search menu when searching for + Drive items. + type: boolean + type: object + id: GoogleAppsDriveLabelsV2LabelDisplayHints + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest: + properties: + id: + description: Required. Key of the Field to disable. + type: string + updateMask: + type: string + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + disabledPolicy: + description: Required. Field Disabled Policy. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest + description: Request to disable the Field. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest + description: Request to create a Selection Choice. + properties: + choice: + description: Required. The Choice to create. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice + fieldId: + description: Required. The Selection Field in which a Choice will be created. + type: string + GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy: + id: GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy + properties: + copyMode: + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + type: string + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + description: >- + Indicates how the applied label and field values should be copied + when a Drive item is copied. + type: object + description: Behavior of this label when it's applied to Drive items. + GoogleAppsDriveLabelsV2FieldDisplayHints: + description: UI display hints for rendering a field. + type: object + id: GoogleAppsDriveLabelsV2FieldDisplayHints + properties: + shownInApply: + description: >- + This field should be shown in the apply menu when applying values to + a Drive item. + type: boolean + required: + type: boolean + description: Whether the field should be shown as required in the UI. + hiddenInSearch: + type: boolean + description: >- + This field should be hidden in the search menu when searching for + Drive items. + disabled: + type: boolean + description: Whether the field should be shown in the UI as disabled. + GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest: + description: >- + Deletes a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + id: GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest + properties: + name: + description: Required. Label Permission resource name. + type: string + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse + description: Response following Field enable. + properties: {} + type: object + GoogleAppsDriveLabelsV2DisableLabelRequest: + type: object + properties: + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + type: string + writeControl: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + disabledPolicy: + description: Disabled policy to use. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + description: Request to deprecate a published Label. + id: GoogleAppsDriveLabelsV2DisableLabelRequest + GoogleAppsDriveLabelsV2LabelPermission: + id: GoogleAppsDriveLabelsV2LabelPermission + properties: + group: + type: string + description: Group resource name. + role: + description: The role the principal should have. + enum: + - LABEL_ROLE_UNSPECIFIED + - READER + - APPLIER + - ORGANIZER + - EDITOR + enumDescriptions: + - Unknown role. + - >- + A reader can read the label and associated metadata applied to + Drive items. + - >- + An applier can write associated metadata on Drive items in which + they also have write access to. Implies `READER`. + - >- + An organizer can pin this label in shared drives they manage and + add new appliers to the label. + - >- + Editors can make any update including deleting the label which + also deletes the associated Drive item metadata. Implies + `APPLIER`. + type: string + person: + type: string + description: Person resource name. + audience: + type: string + description: >- + Audience to grant a role to. The magic value of `audiences/default` + may be used to apply the role to the default audience in the context + of the organization that owns the Label. + email: + type: string + description: >- + Specifies the email address for a user or group pricinpal. Not + populated for audience principals. User and Group permissions may + only be inserted using email address. On update requests, if email + address is specified, no principal should be specified. + name: + description: Resource name of this permission. + type: string + type: object + description: >- + The permission that applies to a principal (user, group, audience) on a + label. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest + properties: + fieldId: + description: Required. The Selection Field in which a Choice will be enabled. + type: string + id: + type: string + description: Required. Choice to enable. + description: Request to enable a Choice. + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest: + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest + description: A single kind of update to apply to a Label. + properties: + deleteSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest + description: Delete a Choice within a Selection Field. + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest + description: Update Field type and/or type options. + enableSelectionChoice: + description: Enable a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest + description: Enables the Field. + disableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest + description: Disables the Field. + updateSelectionChoiceProperties: + description: Update a Choice properties within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest + description: Deletes a Field from the label. + updateField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Updates basic properties of a Field. + disableSelectionChoice: + description: Disable a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest + createField: + description: Creates a new Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest + updateLabel: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest + description: Updates the Label properties. + createSelectionChoice: + description: Creates Choice within a Selection field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest + GoogleAppsDriveLabelsV2LabelLock: + properties: + createTime: + readOnly: true + type: string + description: Output only. The time this LabelLock was created. + format: google-datetime + capabilities: + description: Output only. The user's capabilities on this LabelLock. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLockCapabilities' + fieldId: + type: string + description: >- + The ID of the Field that should be locked. Empty if the whole Label + should be locked. + name: + description: Output only. Resource name of this LabelLock. + readOnly: true + type: string + choiceId: + type: string + description: >- + The ID of the Selection Field Choice that should be locked. If + present, `field_id` must also be present. + state: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETING + enumDescriptions: + - Unknown state. + - The LabelLock is active and is being enforced by the server. + - >- + The LabelLock is being deleted. The LabelLock will continue to be + enforced by the server until it has been fully removed. + readOnly: true + type: string + description: Output only. This LabelLock's state. + creator: + description: >- + Output only. The user whose credentials were used to create the + LabelLock. This will not be present if no user was responsible for + creating the LabelLock. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + deleteTime: + readOnly: true + type: string + description: >- + Output only. A timestamp indicating when this LabelLock was + scheduled for deletion. This will be present only if this LabelLock + is in the DELETING state. + format: google-datetime + description: A Lock that can be applied to a Label, Field, or Choice. + id: GoogleAppsDriveLabelsV2LabelLock + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest + description: Request to delete the Field. + type: object + properties: + id: + description: Required. ID of the Field to delete. + type: string + GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest: + properties: + copyMode: + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + type: string + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + description: >- + Required. Indicates how the applied Label, and Field values should + be copied when a Drive item is copied. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + view: + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + type: string + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + description: >- + Request to update the `CopyMode` of the given Label. Changes to this + policy are not revisioned, do not require publishing, and take effect + immediately. \ + type: object + id: GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest + GoogleAppsDriveLabelsV2Field: + description: >- + Defines a field that has a display name, data type, and other + configuration options. This field defines the kind of metadata that may + be set on a Drive item. + type: object + properties: + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldUserOptions' + description: User field options. + creator: + description: Output only. The user who created this field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + selectionOptions: + description: Selection field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptions' + lifecycle: + description: Output only. The lifecycle of this field. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDateOptions' + description: Date field options. + integerOptions: + description: Integer field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldIntegerOptions' + disabler: + description: >- + Output only. The user who disabled this field. This value has no + meaning when the field is not disabled. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + publisher: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: >- + Output only. The user who published this field. This value has no + meaning when the field is not published. + lockStatus: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' + description: Output only. The LockStatus of this field. + readOnly: true + disableTime: + readOnly: true + format: google-datetime + description: >- + Output only. The time this field was disabled. This value has no + meaning when the field is not disabled. + type: string + appliedCapabilities: + readOnly: true + description: >- + Output only. The capabilities this user has on this field and its + value when the label is applied on Drive items. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldAppliedCapabilities' + schemaCapabilities: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSchemaCapabilities' + description: Output only. The capabilities this user has when editing this field. + readOnly: true + queryKey: + type: string + description: >- + Output only. The key to use when constructing Drive search queries + to find files based on values defined for this field on files. For + example, "`{query_key}` > 2001-01-01". + readOnly: true + id: + description: >- + Output only. The key of a field, unique within a label or library. + This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+` + readOnly: true + type: string + createTime: + type: string + readOnly: true + description: Output only. The time this field was created. + format: google-datetime + displayHints: + description: Output only. UI display hints for rendering a field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDisplayHints' + readOnly: true + textOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldTextOptions' + description: Text field options. + updater: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who modified this field. + readOnly: true + updateTime: + readOnly: true + description: Output only. The time this field was updated. + format: google-datetime + type: string + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldProperties' + description: The basic properties of the field. + id: GoogleAppsDriveLabelsV2Field + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest: + description: >- + The set of requests for updating aspects of a Label. If any request is + not valid, no requests will be applied. + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest + properties: + requests: + description: >- + A list of updates to apply to the Label. Requests will be applied in + the order they are specified. + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest + type: array + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + writeControl: + description: Provides control over how write requests are executed. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + view: + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + type: string + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized Field + labels when `include_label_in_response` is `true`. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse + description: Response following update to Label properties. + type: object + properties: {} + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest: + description: Request to disable a Choice. + properties: + fieldId: + type: string + description: Required. The Selection Field in which a Choice will be disabled. + disabledPolicy: + description: Required. The disabled policy to update. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + id: + description: Required. Choice to disable. + type: string + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest + parameters: + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + x-stackQL-resources: + limits_label: + id: googleworkspace.drivelabelsv2.limits_label + name: limits_label + title: Limits_label + methods: + get_label: + operation: + $ref: '#/paths/~1v2~1limits~1label/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits_label/methods/get_label' + insert: [] + update: [] + replace: [] + delete: [] + users_capabilities: + id: googleworkspace.drivelabelsv2.users_capabilities + name: users_capabilities + title: Users_capabilities + methods: + get_capabilities: + operation: + $ref: '#/paths/~1v2~1users~1{usersId}~1capabilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/users_capabilities/methods/get_capabilities + insert: [] + update: [] + replace: [] + delete: [] + labels_label_copy_mode: + id: googleworkspace.drivelabelsv2.labels_label_copy_mode + name: labels_label_copy_mode + title: Labels_label_copy_mode + methods: + update_label_copy_mode: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:updateLabelCopyMode/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_label_copy_mode/methods/update_label_copy_mode + replace: [] + delete: [] + labels: + id: googleworkspace.drivelabelsv2.labels + name: labels + title: Labels + methods: + enable: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1v2~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v2~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labels + publish: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:publish/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delta: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:delta/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/labels/methods/get' + - $ref: '#/components/x-stackQL-resources/labels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete' + labels_permissions: + id: googleworkspace.drivelabelsv2.labels_permissions + name: labels_permissions + title: Labels_permissions + methods: + update_permissions: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}~1permissions/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_permissions/methods/update_permissions + replace: [] + delete: [] + permissions: + id: googleworkspace.drivelabelsv2.permissions + name: permissions + title: Permissions + methods: + list: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelPermissions + create: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + batch_update: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions:batchUpdate/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions~1{permissionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + batch_delete: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions:batchDelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_delete' + revisions_permissions: + id: googleworkspace.drivelabelsv2.revisions_permissions + name: revisions_permissions + title: Revisions_permissions + methods: + update_permissions: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_permissions/methods/update_permissions + replace: [] + delete: [] + locks: + id: googleworkspace.drivelabelsv2.locks + name: locks + title: Locks + methods: + list: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}~1locks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelLocks + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locks/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2/limits/label: + parameters: &ref_1 + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + get: + description: >- + Get the constraints on the structure of a Label; such as, the maximum + number of Fields allowed and maximum length of the label title. + operationId: drivelabels.limits.getLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLimits' + parameters: + - in: query + name: name + schema: + type: string + /v2/users/{usersId}/capabilities: + parameters: *ref_1 + get: + description: Gets the user capabilities. + operationId: drivelabels.users.getCapabilities + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserCapabilities' + parameters: + - in: path + name: usersId + required: true + schema: + type: string + - in: query + name: customer + schema: + type: string + /v2/labels/{labelsId}:updateLabelCopyMode: + parameters: *ref_1 + post: + description: >- + Updates a Label's `CopyMode`. Changes to this policy are not revisioned, + do not require publishing, and take effect immediately. + operationId: drivelabels.labels.updateLabelCopyMode + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}:enable: + parameters: *ref_1 + post: + description: >- + Enable a disabled Label and restore it to its published state. This will + result in a new published revision based on the current disabled + published revision. If there is an existing disabled draft revision, a + new revision will be created based on that draft and will be enabled. + operationId: drivelabels.labels.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2EnableLabelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels: + parameters: *ref_1 + post: + description: Creates a new Label. + operationId: drivelabels.labels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: languageCode + schema: + type: string + get: + description: List labels. + operationId: drivelabels.labels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLabelsResponse' + parameters: + - in: query + name: customer + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: view + schema: + type: string + - in: query + name: minimumRole + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: publishedOnly + schema: + type: boolean + /v2/labels/{labelsId}:publish: + parameters: *ref_1 + post: + description: >- + Publish all draft changes to the Label. Once published, the Label may + not return to its draft state. See + `google.apps.drive.labels.v2.Lifecycle` for more information. Publishing + a Label will result in a new published revision. All previous draft + revisions will be deleted. Previous published revisions will be kept but + are subject to automated deletion as needed. Once published, some + changes are no longer permitted. Generally, any change that would + invalidate or cause new restrictions on existing metadata related to the + Label will be rejected. For example, the following changes to a Label + will be rejected after the Label is published: * The label cannot be + directly deleted. It must be disabled first, then deleted. * + Field.FieldType cannot be changed. * Changes to Field validation options + cannot reject something that was previously accepted. * Reducing the max + entries. + operationId: drivelabels.labels.publish + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2PublishLabelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}:delta: + parameters: *ref_1 + post: + description: >- + Updates a single Label by applying a set of update requests resulting in + a new draft revision. The batch update is all-or-nothing: If any of the + update requests are invalid, no changes are applied. The resulting draft + revision must be published before the changes may be used with Drive + Items. + operationId: drivelabels.labels.delta + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/permissions: + parameters: *ref_1 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a Label and related metadata on Drive Items. Once + deleted, the Label and related Drive item metadata will be deleted. Only + draft Labels, and disabled Labels may be deleted. + operationId: drivelabels.labels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: writeControl.requiredRevisionId + schema: + type: string + get: + description: >- + Get a label by its resource name. Resource name may be any of: * + `labels/{id}` - See `labels/{id}@latest` * `labels/{id}@latest` - Gets + the latest revision of the label. * `labels/{id}@published` - Gets the + current published revision of the label. * `labels/{id}@{revision_id}` - + Gets the label at the specified revision ID. + operationId: drivelabels.labels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: languageCode + schema: + type: string + - in: query + name: view + schema: + type: string + /v2/labels/{labelsId}:disable: + parameters: *ref_1 + post: + description: >- + Disable a published Label. Disabling a Label will result in a new + disabled published revision based on the current published revision. If + there is a draft revision, a new disabled draft revision will be created + based on the latest draft revision. Older draft revisions will be + deleted. Once disabled, a label may be deleted with `DeleteLabel`. + operationId: drivelabels.labels.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DisableLabelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions: + parameters: *ref_1 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.revisions.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: useAdminAccess + schema: + type: boolean + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}/revisions/{revisionsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.revisions.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2/labels/{labelsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml new file mode 100644 index 00000000..acd7f346 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml @@ -0,0 +1,3415 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Drive Labels API + description: An API for managing Drive Labels + version: v2beta + x-discovery-doc-revision: '20241204' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/labels +servers: + - url: https://drivelabels.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive.admin.labels.readonly: >- + See all Google Drive labels and label-related admin policies in + your organization + https://www.googleapis.com/auth/drive.labels: See, edit, create, and delete your Google Drive labels + https://www.googleapis.com/auth/drive.admin.labels: >- + See, edit, create, and delete all Google Drive labels in your + organization, and see your organization's label-related admin + policies + https://www.googleapis.com/auth/drive.labels.readonly: See your Google Drive labels + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse: + id: GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse + description: Response for updating one or more Label Permissions. + properties: + permissions: + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + type: array + description: Required. Permissions updated. + type: object + GoogleAppsDriveLabelsV2betaFieldSchemaCapabilities: + id: GoogleAppsDriveLabelsV2betaFieldSchemaCapabilities + description: The capabilities related to this field when editing the field. + type: object + properties: + canDelete: + type: boolean + description: >- + Whether the user can delete this field. The user must have + permission and the field must be deprecated. + canDisable: + description: >- + Whether the user can disable this field. The user must have + permission and this field must not already be disabled. + type: boolean + canUpdate: + type: boolean + description: Whether the user can change this field. + canEnable: + type: boolean + description: >- + Whether the user can enable this field. The user must have + permission and this field must be disabled. + GoogleAppsDriveLabelsV2betaDeleteLabelPermissionRequest: + description: >- + Deletes a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + properties: + name: + type: string + description: Required. Label Permission resource name. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + id: GoogleAppsDriveLabelsV2betaDeleteLabelPermissionRequest + type: object + GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy: + type: object + properties: + showInApply: + description: >- + Whether to show this disabled object in the apply menu on Drive + items. * When `true`, the object is generally shown in the UI as + disabled and is unselectable. * When `false`, the object is + generally hidden in the UI. + type: boolean + hideInSearch: + type: boolean + description: >- + Whether to hide this disabled object in the search menu for Drive + items. * When `false`, the object is generally shown in the UI as + disabled but it appears in the search results when searching for + Drive items. * When `true`, the object is generally hidden in the UI + when searching for Drive items. + id: GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: >- + The policy that governs how to treat a disabled label, field, or + selection choice in different contexts. + GoogleAppsDriveLabelsV2betaListLimits: + type: object + properties: + maxEntries: + description: Maximum number of values allowed for the Field type. + type: integer + format: int32 + id: GoogleAppsDriveLabelsV2betaListLimits + description: Limits for list-variant of a Field type. + GoogleAppsDriveLabelsV2betaUpdateLabelCopyModeRequest: + id: GoogleAppsDriveLabelsV2betaUpdateLabelCopyModeRequest + type: object + description: >- + Request to update the `CopyMode` of the given Label. Changes to this + policy are not revisioned, do not require publishing, and take effect + immediately. \ + properties: + view: + type: string + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + copyMode: + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + description: >- + Required. Indicates how the applied Label, and Field values should + be copied when a Drive item is copied. + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + type: string + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + GoogleAppsDriveLabelsV2betaDisableLabelRequest: + properties: + updateMask: + format: google-fieldmask + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: Disabled policy to use. + type: object + description: Request to deprecate a published Label. + id: GoogleAppsDriveLabelsV2betaDisableLabelRequest + GoogleAppsDriveLabelsV2betaLabelLock: + type: object + description: A Lock that can be applied to a Label, Field, or Choice. + id: GoogleAppsDriveLabelsV2betaLabelLock + properties: + name: + readOnly: true + description: Output only. Resource name of this LabelLock. + type: string + capabilities: + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelLockCapabilities + description: Output only. The user's capabilities on this LabelLock. + fieldId: + type: string + description: >- + The ID of the Field that should be locked. Empty if the whole Label + should be locked. + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time this LabelLock was created. + deleteTime: + format: google-datetime + readOnly: true + description: >- + Output only. A timestamp indicating when this LabelLock was + scheduled for deletion. This will be present only if this LabelLock + is in the DELETING state. + type: string + creator: + readOnly: true + description: >- + Output only. The user whose credentials were used to create the + LabelLock. This will not be present if no user was responsible for + creating the LabelLock. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + state: + enumDescriptions: + - Unknown state. + - The LabelLock is active and is being enforced by the server. + - >- + The LabelLock is being deleted. The LabelLock will continue to be + enforced by the server until it has been fully removed. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETING + description: Output only. This LabelLock's state. + readOnly: true + type: string + choiceId: + description: >- + The ID of the Selection Field Choice that should be locked. If + present, `field_id` must also be present. + type: string + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteSelectionChoiceRequest + properties: + fieldId: + description: Required. The Selection Field from which a Choice will be deleted. + type: string + id: + description: Required. Choice to delete. + type: string + description: Request to delete a Choice. + GoogleAppsDriveLabelsV2betaFieldDisplayHints: + properties: + disabled: + description: Whether the field should be shown in the UI as disabled. + type: boolean + required: + type: boolean + description: Whether the field should be shown as required in the UI. + hiddenInSearch: + description: >- + This field should be hidden in the search menu when searching for + Drive items. + type: boolean + shownInApply: + type: boolean + description: >- + This field should be shown in the apply menu when applying values to + a Drive item. + id: GoogleAppsDriveLabelsV2betaFieldDisplayHints + type: object + description: UI display hints for rendering a field. + GoogleAppsDriveLabelsV2betaListLabelsResponse: + type: object + properties: + labels: + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + type: array + description: Labels. + nextPageToken: + type: string + description: The token of the next page in the response. + description: Response for listing Labels. + id: GoogleAppsDriveLabelsV2betaListLabelsResponse + GoogleAppsDriveLabelsV2betaLockStatus: + properties: + locked: + readOnly: true + description: >- + Output only. Indicates whether this label component is the (direct) + target of a LabelLock. A label component can be implicitly locked + even if it's not the direct target of a LabelLock, in which case + this field is set to false. + type: boolean + type: object + id: GoogleAppsDriveLabelsV2betaLockStatus + description: >- + Contains information about whether a label component should be + considered locked. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableSelectionChoiceRequest: + description: Request to enable a Choice. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableSelectionChoiceRequest + type: object + properties: + id: + type: string + description: Required. Choice to enable. + fieldId: + description: Required. The Selection Field in which a Choice will be enabled. + type: string + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + description: Response following update to Selection Choice properties. + properties: + priority: + description: >- + The priority of the updated choice. The priority may change from + what was specified to assure contiguous priorities between choices + (1-n). + type: integer + format: int32 + GoogleAppsDriveLabelsV2betaUserLimits: + type: object + description: Limits for Field.Type.USER. + properties: + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaListLimits' + description: Limits for list-variant of a Field type. + id: GoogleAppsDriveLabelsV2betaUserLimits + GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse: + description: Response for listing the permissions on a Label. + id: GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse + type: object + properties: + nextPageToken: + type: string + description: The token of the next page in the response. + labelPermissions: + type: array + description: Label permissions. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestRequest: + description: A single kind of update to apply to a Label. + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestRequest + properties: + deleteSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteSelectionChoiceRequest + description: Delete a Choice within a Selection Field. + updateLabel: + description: Updates the Label properties. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateLabelPropertiesRequest + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldTypeRequest + description: Update Field type and/or type options. + createField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateFieldRequest + description: Creates a new Field. + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteFieldRequest + description: Deletes a Field from the label. + updateField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Updates basic properties of a Field. + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableFieldRequest + description: Enables the Field. + disableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableSelectionChoiceRequest + description: Disable a Choice within a Selection Field. + enableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableSelectionChoiceRequest + description: Enable a Choice within a Selection Field. + disableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableFieldRequest + description: Disables the Field. + updateSelectionChoiceProperties: + description: Update a Choice properties within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + createSelectionChoice: + description: Creates Choice within a Selection field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateSelectionChoiceRequest + GoogleAppsDriveLabelsV2betaLifecycle: + description: >- + The lifecycle state of an object, such as label, field, or choice. The + lifecycle enforces the following transitions: * `UNPUBLISHED_DRAFT` + (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * + `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * + `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted) The published and + disabled states have some distinct characteristics: * Published—Some + kinds of changes might be made to an object in this state, in which case + `has_unpublished_changes` will be true. Also, some kinds of changes are + not permitted. Generally, any change that would invalidate or cause new + restrictions on existing metadata related to the label are rejected. * + Disabled—When disabled, the configured `DisabledPolicy` takes effect. + id: GoogleAppsDriveLabelsV2betaLifecycle + type: object + properties: + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: >- + The policy that governs how to show a disabled label, field, or + selection choice. + state: + enumDescriptions: + - Unknown State. + - >- + The initial state of an object. Once published, the object can + never return to this state. Once an object is published, certain + kinds of changes are no longer permitted. + - >- + The object has been published. The object might have unpublished + draft changes as indicated by `has_unpublished_changes`. + - >- + The object has been published and has since been disabled. The + object might have unpublished draft changes as indicated by + `has_unpublished_changes`. + - The object has been deleted. + enum: + - STATE_UNSPECIFIED + - UNPUBLISHED_DRAFT + - PUBLISHED + - DISABLED + - DELETED + readOnly: true + description: Output only. The state of the object associated with this lifecycle. + type: string + hasUnpublishedChanges: + description: >- + Output only. Whether the object associated with this lifecycle has + unpublished changes. + readOnly: true + type: boolean + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequest: + properties: + view: + type: string + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + requests: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestRequest + description: >- + A list of updates to apply to the Label. Requests will be applied in + the order they are specified. + type: array + writeControl: + description: Provides control over how write requests are executed. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized Field + labels when `include_label_in_response` is `true`. + type: string + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequest + description: >- + The set of requests for updating aspects of a Label. If any request is + not valid, no requests will be applied. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseResponse: + properties: + updateLabel: + description: Updated basic properties of a Label. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateLabelPropertiesResponse + enableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableSelectionChoiceResponse + description: Enables a Choice within a Selection Field. + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldTypeResponse + description: Update Field type and/or type options. + updateField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldPropertiesResponse + description: Updates basic properties of a Field. + updateSelectionChoiceProperties: + description: Updates a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + disableField: + description: Disables Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableFieldResponse + disableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableSelectionChoiceResponse + description: Disables a Choice within a Selection Field. + createSelectionChoice: + description: Creates a new selection list option to add to a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateSelectionChoiceResponse + createField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateFieldResponse + description: Creates a new Field. + deleteSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteSelectionChoiceResponse + description: Deletes a Choice from a Selection Field. + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteFieldResponse + description: Deletes a Field from the label. + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableFieldResponse + description: Enables Field. + description: A single response from an update. + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseResponse + GoogleAppsDriveLabelsV2betaLabelLockCapabilities: + id: GoogleAppsDriveLabelsV2betaLabelLockCapabilities + description: A description of a user's capabilities on a LabelLock. + properties: + canViewPolicy: + type: boolean + description: True if the user is authorized to view the policy. + type: object + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice: + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice + description: Selection field choice. + properties: + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties + description: Basic properties of the choice. + publisher: + readOnly: true + description: >- + Output only. The user who published this choice. This value has no + meaning when the choice is not published. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + disableTime: + type: string + description: >- + Output only. The time this choice was disabled. This value has no + meaning when the choice is not disabled. + readOnly: true + format: google-datetime + updateTime: + format: google-datetime + description: Output only. The time this choice was updated last. + type: string + readOnly: true + updater: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: Output only. The user who updated this choice last. + publishTime: + readOnly: true + type: string + format: google-datetime + description: >- + Output only. The time this choice was published. This value has no + meaning when the choice is not published. + createTime: + type: string + readOnly: true + description: Output only. The time this choice was created. + format: google-datetime + id: + description: >- + The unique value of the choice. This ID is autogenerated. Matches + the regex: `([a-zA-Z0-9_])+`. + type: string + schemaCapabilities: + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceSchemaCapabilities + description: >- + Output only. The capabilities related to this option when editing + the option. + disabler: + readOnly: true + description: >- + Output only. The user who disabled this choice. This value has no + meaning when the option is not disabled. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + appliedCapabilities: + description: >- + Output only. The capabilities related to this choice on applied + metadata. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceAppliedCapabilities + readOnly: true + lifecycle: + description: Output only. Lifecycle of the choice. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLifecycle' + displayHints: + description: Output only. UI display hints for rendering a choice. + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceDisplayHints + creator: + description: Output only. The user who created this choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + readOnly: true + lockStatus: + description: Output only. The LockStatus of this choice. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLockStatus' + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldPropertiesResponse: + description: Response following update to Field properties. + properties: + priority: + description: >- + The priority of the updated field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + type: integer + format: int32 + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldPropertiesResponse + type: object + GoogleAppsDriveLabelsV2betaSelectionLimits: + properties: + maxChoices: + description: The max number of choices. + format: int32 + type: integer + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaListLimits' + description: Limits for list-variant of a Field type. + maxIdLength: + description: Maximum ID length for a selection options. + type: integer + format: int32 + maxDisplayNameLength: + type: integer + format: int32 + description: Maximum length for display name. + maxDeletedChoices: + description: Maximum number of deleted choices. + type: integer + format: int32 + type: object + description: Limits for selection Field type. + id: GoogleAppsDriveLabelsV2betaSelectionLimits + GoogleAppsDriveLabelsV2betaFieldListOptions: + id: GoogleAppsDriveLabelsV2betaFieldListOptions + properties: + maxEntries: + description: Maximum number of entries permitted. + format: int32 + type: integer + type: object + description: Options for a multi-valued variant of an associated field type. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest: + type: object + description: Request to update a Choice properties. + properties: + id: + description: Required. The Choice to update. + type: string + fieldId: + description: Required. The Selection Field to update. + type: string + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties + description: Required. The Choice properties to update. + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceAppliedCapabilities: + type: object + description: The capabilities related to this choice on applied metadata. + id: >- + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceAppliedCapabilities + properties: + canRead: + description: Whether the user can read related applied metadata on items. + type: boolean + canSearch: + type: boolean + description: Whether the user can use this choice in search queries. + canSelect: + description: Whether the user can select this choice on an item. + type: boolean + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceSchemaCapabilities: + type: object + properties: + canUpdate: + type: boolean + description: Whether the user can update this choice. + canEnable: + type: boolean + description: Whether the user can enable this choice. + canDelete: + description: Whether the user can delete this choice. + type: boolean + canDisable: + type: boolean + description: Whether the user can disable this choice. + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceSchemaCapabilities + description: The capabilities related to this choice when editing the choice. + GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest: + type: object + properties: + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + UpdateLabelPermissionRequest messages must either be empty or match + this field. + requests: + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaUpdateLabelPermissionRequest + description: Required. The request message specifying the resources to update. + id: GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest + description: Updates one or more Label Permissions. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldPropertiesRequest: + type: object + properties: + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldProperties' + description: Required. Basic Field properties. + updateMask: + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + id: + type: string + description: Required. The Field to update. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Request to update Field properties. + GoogleAppsDriveLabelsV2betaDateLimits: + id: GoogleAppsDriveLabelsV2betaDateLimits + properties: + minValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: Minimum value for the date Field type. + maxValue: + description: Maximum value for the date Field type. + $ref: '#/components/schemas/GoogleTypeDate' + description: Limits for date Field type. + type: object + GoogleAppsDriveLabelsV2betaEnableLabelRequest: + type: object + description: Request to enable a label. + id: GoogleAppsDriveLabelsV2betaEnableLabelRequest + properties: + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableSelectionChoiceResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableSelectionChoiceResponse + description: Response following Choice disable. + properties: {} + GoogleAppsDriveLabelsV2betaField: + type: object + properties: + selectionOptions: + description: Selection field options. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptions + updateTime: + description: Output only. The time this field was updated. + type: string + readOnly: true + format: google-datetime + id: + type: string + readOnly: true + description: >- + Output only. The key of a field, unique within a label or library. + This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+` + integerOptions: + description: Integer field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldIntegerOptions' + publisher: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: >- + Output only. The user who published this field. This value has no + meaning when the field is not published. + lifecycle: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLifecycle' + readOnly: true + description: Output only. The lifecycle of this field. + lockStatus: + description: Output only. The LockStatus of this field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLockStatus' + readOnly: true + creator: + description: Output only. The user who created this field. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + properties: + description: The basic properties of the field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldProperties' + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldUserOptions' + description: User field options. + disableTime: + type: string + readOnly: true + description: >- + Output only. The time this field was disabled. This value has no + meaning when the field is not disabled. + format: google-datetime + textOptions: + description: Text field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldTextOptions' + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldDateOptions' + description: Date field options. + updater: + readOnly: true + description: Output only. The user who modified this field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + displayHints: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldDisplayHints' + readOnly: true + description: Output only. UI display hints for rendering a field. + disabler: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: >- + Output only. The user who disabled this field. This value has no + meaning when the field is not disabled. + queryKey: + description: >- + Output only. The key to use when constructing Drive search queries + to find files based on values defined for this field on files. For + example, "`{query_key}` > 2001-01-01". + readOnly: true + type: string + schemaCapabilities: + description: Output only. The capabilities this user has when editing this field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSchemaCapabilities + readOnly: true + appliedCapabilities: + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldAppliedCapabilities + description: >- + Output only. The capabilities this user has on this field and its + value when the label is applied on Drive items. + createTime: + type: string + format: google-datetime + readOnly: true + description: Output only. The time this field was created. + id: GoogleAppsDriveLabelsV2betaField + description: >- + Defines a field that has a display name, data type, and other + configuration options. This field defines the kind of metadata that may + be set on a Drive item. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableSelectionChoiceRequest + description: Request to disable a Choice. + properties: + fieldId: + type: string + description: Required. The Selection Field in which a Choice will be disabled. + id: + description: Required. Choice to disable. + type: string + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + format: google-fieldmask + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: Required. The disabled policy to update. + GoogleAppsDriveLabelsV2betaFieldSelectionOptions: + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptions + description: Options for the selection field type. + type: object + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldListOptions' + description: >- + When specified, indicates this field supports a list of values. Once + the field is published, this cannot be changed. + choices: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice + type: array + description: >- + The options available for this selection field. The list order is + consistent, and modified with `insert_before_choice`. + GoogleAppsDriveLabelsV2betaLongTextLimits: + description: Limits for long text Field type. + properties: + maxLength: + type: integer + description: Maximum length allowed for a long text Field type. + format: int32 + minLength: + format: int32 + description: Minimum length allowed for a long text Field type. + type: integer + id: GoogleAppsDriveLabelsV2betaLongTextLimits + type: object + GoogleAppsDriveLabelsV2betaFieldProperties: + type: object + properties: + insertBeforeField: + type: string + description: >- + Input only. Insert or move this field before the indicated field. If + empty, the field is placed at the end of the list. + displayName: + type: string + description: Required. The display text to show in the UI identifying this field. + required: + description: Whether the field should be marked as required. + type: boolean + id: GoogleAppsDriveLabelsV2betaFieldProperties + description: The basic properties of the field. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateSelectionChoiceResponse: + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateSelectionChoiceResponse + type: object + properties: + fieldId: + description: The server-generated id of the field. + type: string + id: + description: The server-generated ID of the created choice within the Field + type: string + description: Response following Selection Choice create. + GoogleAppsDriveLabelsV2betaLabelLimits: + type: object + id: GoogleAppsDriveLabelsV2betaLabelLimits + properties: + maxDeletedFields: + type: integer + format: int32 + description: The maximum number of published Fields that can be deleted. + fieldLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldLimits' + description: The limits for Fields. + name: + type: string + description: Resource name. + maxDescriptionLength: + description: The maximum number of characters allowed for the description. + format: int32 + type: integer + maxFields: + type: integer + description: The maximum number of Fields allowed within the label. + format: int32 + maxDraftRevisions: + type: integer + description: >- + The maximum number of draft revisions that will be kept before + deleting old drafts. + format: int32 + maxTitleLength: + format: int32 + description: The maximum number of characters allowed for the title. + type: integer + description: >- + Label constraints governing the structure of a Label; such as, the + maximum number of Fields allowed and maximum length of the label title. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponse: + properties: + responses: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseResponse + description: >- + The reply of the updates. This maps 1:1 with the updates, although + responses to some requests may be empty. + type: array + updatedLabel: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + description: >- + The label after updates were applied. This is only set if + [BatchUpdateLabelResponse2.include_label_in_response] is `true` and + there were no errors. + description: Response for Label update. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponse + type: object + GoogleAppsDriveLabelsV2betaBadgeConfig: + type: object + properties: + priorityOverride: + type: string + format: int64 + description: >- + Override the default global priority of this badge. When set to 0, + the default priority heuristic is used. + color: + description: >- + The color of the badge. When not specified, no badge is rendered. + The background, foreground, and solo (light and dark mode) colors + set here are changed in the Drive UI into the closest recommended + supported color. + $ref: '#/components/schemas/GoogleTypeColor' + id: GoogleAppsDriveLabelsV2betaBadgeConfig + description: Badge status of the label. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableFieldResponse: + properties: {} + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableFieldResponse + description: Response following Field enable. + GoogleAppsDriveLabelsV2betaFieldLimits: + id: GoogleAppsDriveLabelsV2betaFieldLimits + description: >- + Field constants governing the structure of a Field; such as, the maximum + title length, minimum and maximum field values or length, etc. + properties: + longTextLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLongTextLimits' + description: Long text Field limits. + dateLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaDateLimits' + description: Date Field limits. + maxDescriptionLength: + description: Limits for Field description, also called help text. + type: integer + format: int32 + maxIdLength: + description: Max length for the id. + type: integer + format: int32 + maxDisplayNameLength: + type: integer + format: int32 + description: Limits for Field title. + selectionLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaSelectionLimits' + description: Selection Field limits. + integerLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaIntegerLimits' + description: Integer Field limits. + userLimits: + description: User Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserLimits' + textLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaTextLimits' + description: The relevant limits for the specified Field.Type. Text Field limits. + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldTypeResponse: + description: Response following update to Field type. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldTypeResponse + type: object + properties: {} + GoogleTypeDate: + properties: + month: + format: int32 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + id: GoogleTypeDate + GoogleAppsDriveLabelsV2betaFieldIntegerOptions: + properties: + minValue: + description: Output only. The minimum valid value for the integer field. + readOnly: true + format: int64 + type: string + maxValue: + format: int64 + readOnly: true + type: string + description: Output only. The maximum valid value for the integer field. + description: Options for the Integer field type. + type: object + id: GoogleAppsDriveLabelsV2betaFieldIntegerOptions + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableSelectionChoiceResponse: + description: Response following Choice enable. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableSelectionChoiceResponse + properties: {} + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteFieldResponse: + description: Response following Field delete. + properties: {} + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteFieldResponse + GoogleAppsDriveLabelsV2betaLabelAppliedCapabilities: + id: GoogleAppsDriveLabelsV2betaLabelAppliedCapabilities + type: object + description: The capabilities a user has on this label's applied metadata. + properties: + canApply: + description: Whether the user can apply this label to items. + type: boolean + canRemove: + description: Whether the user can remove this label from items. + type: boolean + canRead: + type: boolean + description: Whether the user can read applied metadata related to this label. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableFieldRequest: + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableFieldRequest + description: Request to disable the Field. + type: object + properties: + id: + description: Required. Key of the Field to disable. + type: string + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: Required. Field Disabled Policy. + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + type: string + GoogleAppsDriveLabelsV2betaFieldDateOptions: + properties: + minValue: + readOnly: true + description: Output only. Minimum valid value (year, month, day). + $ref: '#/components/schemas/GoogleTypeDate' + dateFormat: + type: string + readOnly: true + description: Output only. ICU date format. + maxValue: + readOnly: true + description: Output only. Maximum valid value (year, month, day). + $ref: '#/components/schemas/GoogleTypeDate' + dateFormatType: + type: string + description: >- + Localized date formatting option. Field values are rendered in this + format according to their locale. + enumDescriptions: + - Date format unspecified. + - >- + Includes full month name. For example, January 12, 1999 (MMMM d, + y) + - Short, numeric, representation. For example, 12/13/99 (M/d/yy) + enum: + - DATE_FORMAT_UNSPECIFIED + - LONG_DATE + - SHORT_DATE + type: object + description: Options for the date field type. + id: GoogleAppsDriveLabelsV2betaFieldDateOptions + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateFieldRequest: + description: Request to create a Field within a Label. + properties: + field: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaField' + description: Required. Field to create. + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateFieldRequest + GoogleAppsDriveLabelsV2betaFieldTextOptions: + type: object + id: GoogleAppsDriveLabelsV2betaFieldTextOptions + properties: + maxLength: + description: Output only. The maximum valid length of values for the text field. + type: integer + readOnly: true + format: int32 + minLength: + format: int32 + type: integer + description: Output only. The minimum valid length of values for the text field. + readOnly: true + description: Options for the Text field type. + GoogleAppsDriveLabelsV2betaUserCapabilities: + properties: + name: + type: string + readOnly: true + description: Output only. Resource name for the user capabilities. + canCreateSharedLabels: + description: >- + Output only. Whether the user is allowed to create new shared + labels. + type: boolean + readOnly: true + canCreateAdminLabels: + readOnly: true + type: boolean + description: Output only. Whether the user is allowed to create new admin labels. + canAdministrateLabels: + readOnly: true + description: >- + Output only. Whether the user is an administrator for the shared + labels feature. + type: boolean + canAccessLabelManager: + readOnly: true + type: boolean + description: >- + Output only. Whether the user is allowed access to the label + manager. + description: The capabilities of a user. + type: object + id: GoogleAppsDriveLabelsV2betaUserCapabilities + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceDisplayHints: + description: UI display hints for rendering an option. + type: object + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceDisplayHints + properties: + badgeColors: + description: >- + The colors to use for the badge. Changed to Google Material colors + based on the chosen `properties.badge_config.color`. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaBadgeColors' + badgePriority: + type: string + format: int64 + description: >- + The priority of this badge. Used to compare and sort between + multiple badges. A lower number means the badge should be shown + first. When a badging configuration is not present, this will be 0. + Otherwise, this will be set to `BadgeConfig.priority_override` or + the default heuristic which prefers creation date of the label, and + field and option priority. + shownInApply: + type: boolean + description: >- + This option should be shown in the apply menu when applying values + to a Drive item. + hiddenInSearch: + description: >- + This option should be hidden in the search menu when searching for + Drive items. + type: boolean + darkBadgeColors: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaBadgeColors' + description: >- + The dark-mode color to use for the badge. Changed to Google Material + colors based on the chosen `properties.badge_config.color`. + disabled: + type: boolean + description: Whether the option should be shown in the UI as disabled. + GoogleAppsDriveLabelsV2betaLabelSchemaCapabilities: + type: object + description: The capabilities related to this label when editing the label. + id: GoogleAppsDriveLabelsV2betaLabelSchemaCapabilities + properties: + canDelete: + description: >- + Whether the user can delete this label. The user must have + permission and the label must be disabled. + type: boolean + canDisable: + description: >- + Whether the user can disable this label. The user must have + permission and this label must not already be disabled. + type: boolean + canEnable: + type: boolean + description: >- + Whether the user can enable this label. The user must have + permission and this label must be disabled. + canUpdate: + description: Whether the user can change this label. + type: boolean + GoogleAppsDriveLabelsV2betaUpdateLabelPermissionRequest: + type: object + properties: + labelPermission: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + description: Required. The permission to create or update on the Label. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + parent: + type: string + description: Required. The parent Label resource name. + description: >- + Updates a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + id: GoogleAppsDriveLabelsV2betaUpdateLabelPermissionRequest + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteSelectionChoiceResponse: + description: Response following Choice delete. + type: object + properties: {} + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteSelectionChoiceResponse + GoogleAppsDriveLabelsV2betaListLabelLocksResponse: + type: object + properties: + labelLocks: + description: LabelLocks. + type: array + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelLock' + nextPageToken: + description: The token of the next page in the response. + type: string + id: GoogleAppsDriveLabelsV2betaListLabelLocksResponse + description: The response to a ListLabelLocksRequest. + GoogleAppsDriveLabelsV2betaBadgeColors: + type: object + id: GoogleAppsDriveLabelsV2betaBadgeColors + description: >- + The color derived from BadgeConfig and changed to the closest + recommended supported color. + properties: + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Output only. Badge background that pairs with the foreground. + readOnly: true + soloColor: + description: Output only. Color that can be used for text without a background. + readOnly: true + $ref: '#/components/schemas/GoogleTypeColor' + foregroundColor: + readOnly: true + description: Output only. Badge foreground that pairs with the background. + $ref: '#/components/schemas/GoogleTypeColor' + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateFieldResponse: + description: Response following Field create. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateFieldResponse + type: object + properties: + id: + type: string + description: >- + The field of the created field. When left blank in a create request, + a key will be autogenerated and can be identified here. + priority: + format: int32 + type: integer + description: >- + The priority of the created field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + GoogleAppsDriveLabelsV2betaLabelProperties: + type: object + id: GoogleAppsDriveLabelsV2betaLabelProperties + description: Basic properties of the label. + properties: + title: + type: string + description: Required. Title of the label. + description: + description: The description of the label. + type: string + GoogleTypeColor: + id: GoogleTypeColor + properties: + red: + type: number + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + alpha: + type: number + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + format: float + green: + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + blue: + type: number + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + type: object + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateLabelPropertiesRequest: + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateLabelPropertiesRequest + description: Updates basic properties of a Label. + type: object + properties: + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `label_properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + format: google-fieldmask + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelProperties' + description: Required. Label properties to update. + GoogleAppsDriveLabelsV2betaLabelPermission: + description: >- + The permission that applies to a principal (user, group, audience) on a + label. + type: object + properties: + person: + description: Person resource name. + type: string + audience: + description: >- + Audience to grant a role to. The magic value of `audiences/default` + may be used to apply the role to the default audience in the context + of the organization that owns the Label. + type: string + group: + description: Group resource name. + type: string + email: + description: >- + Specifies the email address for a user or group pricinpal. Not + populated for audience principals. User and Group permissions may + only be inserted using email address. On update requests, if email + address is specified, no principal should be specified. + type: string + name: + description: Resource name of this permission. + type: string + role: + enumDescriptions: + - Unknown role. + - >- + A reader can read the label and associated metadata applied to + Drive items. + - >- + An applier can write associated metadata on Drive items in which + they also have write access to. Implies `READER`. + - >- + An organizer can pin this label in shared drives they manage and + add new appliers to the label. + - >- + Editors can make any update including deleting the label which + also deletes the associated Drive item metadata. Implies + `APPLIER`. + enum: + - LABEL_ROLE_UNSPECIFIED + - READER + - APPLIER + - ORGANIZER + - EDITOR + type: string + description: The role the principal should have. + id: GoogleAppsDriveLabelsV2betaLabelPermission + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties: + type: object + properties: + badgeConfig: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaBadgeConfig' + description: >- + The badge configuration for this choice. When set, the label that + owns this choice is considered a "badged label". + displayName: + description: Required. The display text to show in the UI identifying this field. + type: string + insertBeforeChoice: + type: string + description: >- + Input only. Insert or move this choice before the indicated choice. + If empty, the choice is placed at the end of the list. + description: + description: The description of this label. + type: string + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties + description: Basic properties of the choice. + GoogleAppsDriveLabelsV2betaIntegerLimits: + description: Limits for integer Field type. + type: object + id: GoogleAppsDriveLabelsV2betaIntegerLimits + properties: + minValue: + type: string + format: int64 + description: Minimum value for an integer Field type. + maxValue: + type: string + description: Maximum value for an integer Field type. + format: int64 + GoogleAppsDriveLabelsV2betaLabelAppliedLabelPolicy: + type: object + description: Behavior of this label when it's applied to Drive items. + properties: + copyMode: + type: string + description: >- + Indicates how the applied label and field values should be copied + when a Drive item is copied. + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + id: GoogleAppsDriveLabelsV2betaLabelAppliedLabelPolicy + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableFieldResponse: + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableFieldResponse + type: object + description: Response following Field disable. + properties: {} + GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest: + id: GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest + description: Deletes one of more Label Permissions. + properties: + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + DeleteLabelPermissionRequest messages must either be empty or match + this field. + type: boolean + requests: + description: Required. The request message specifying the resources to update. + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeleteLabelPermissionRequest + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateLabelPropertiesResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateLabelPropertiesResponse + properties: {} + description: Response following update to Label properties. + GoogleAppsDriveLabelsV2betaFieldUserOptions: + type: object + id: GoogleAppsDriveLabelsV2betaFieldUserOptions + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldListOptions' + description: >- + When specified, indicates that this field supports a list of values. + Once the field is published, this cannot be changed. + description: Options for the user field type. + GoogleAppsDriveLabelsV2betaLabelDisplayHints: + type: object + id: GoogleAppsDriveLabelsV2betaLabelDisplayHints + properties: + priority: + format: int64 + type: string + description: Order to display label in a list. + disabled: + type: boolean + description: Whether the label should be shown in the UI as disabled. + hiddenInSearch: + type: boolean + description: >- + This label should be hidden in the search menu when searching for + Drive items. + shownInApply: + description: >- + This label should be shown in the apply menu when applying values to + a Drive item. + type: boolean + description: UI display hints for rendering the label. + GoogleAppsDriveLabelsV2betaUserInfo: + properties: + person: + description: >- + The identifier for this user that can be used with the People API to + get more information. For example, people/12345678. + type: string + id: GoogleAppsDriveLabelsV2betaUserInfo + type: object + description: Information about a user. + GoogleProtobufEmpty: + type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + properties: {} + id: GoogleProtobufEmpty + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateSelectionChoiceRequest: + description: Request to create a Selection Choice. + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateSelectionChoiceRequest + properties: + choice: + description: Required. The Choice to create. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice + fieldId: + description: Required. The Selection Field in which a Choice will be created. + type: string + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldTypeRequest: + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldTypeRequest + type: object + properties: + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldDateOptions' + description: Update field to Date. + textOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldTextOptions' + description: Update field to Text. + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldUserOptions' + description: Update field to User. + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root of `type_options` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + integerOptions: + description: Update field to Integer. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldIntegerOptions' + selectionOptions: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptions + description: Update field to Selection. + id: + description: Required. The Field to update. + type: string + description: Request to change the type of a Field. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteFieldRequest: + type: object + description: Request to delete the Field. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteFieldRequest + properties: + id: + description: Required. ID of the Field to delete. + type: string + GoogleAppsDriveLabelsV2betaFieldAppliedCapabilities: + type: object + description: The capabilities related to this field on applied metadata. + id: GoogleAppsDriveLabelsV2betaFieldAppliedCapabilities + properties: + canWrite: + description: Whether the user can set this field on Drive items. + type: boolean + canRead: + description: Whether the user can read related applied metadata on items. + type: boolean + canSearch: + description: Whether the user can search for Drive items referencing this field. + type: boolean + GoogleAppsDriveLabelsV2betaWriteControl: + id: GoogleAppsDriveLabelsV2betaWriteControl + properties: + requiredRevisionId: + type: string + description: >- + The revision_id of the label that the write request will be applied + to. If this is not the latest revision of the label, the request + will not be processed and will return a 400 Bad Request error. + description: >- + Provides control over how write requests are executed. When not + specified, the last write wins. + type: object + GoogleAppsDriveLabelsV2betaPublishLabelRequest: + description: Request to publish a label. + type: object + id: GoogleAppsDriveLabelsV2betaPublishLabelRequest + properties: + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + GoogleAppsDriveLabelsV2betaTextLimits: + description: Limits for text Field type. + id: GoogleAppsDriveLabelsV2betaTextLimits + properties: + maxLength: + format: int32 + description: Maximum length allowed for a text Field type. + type: integer + minLength: + format: int32 + type: integer + description: Minimum length allowed for a text Field type. + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableFieldRequest: + description: Request to enable the Field. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableFieldRequest + type: object + properties: + id: + description: Required. ID of the Field to enable. + type: string + GoogleAppsDriveLabelsV2betaLabel: + description: >- + A label defines a taxonomy that can be applied to Drive items in order + to organize and search across items. Labels can be simple strings, or + can contain fields that describe additional metadata that can be further + used to organize and search Drive items. + id: GoogleAppsDriveLabelsV2betaLabel + type: object + properties: + lockStatus: + description: Output only. The LockStatus of this label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLockStatus' + disabler: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: >- + Output only. The user who disabled this label. This value has no + meaning when the label is not disabled. + readOnly: true + displayHints: + description: Output only. UI display hints for rendering the label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelDisplayHints' + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelProperties' + description: Required. The basic properties of the label. + lifecycle: + description: >- + Output only. The lifecycle state of the label including whether it's + published, deprecated, and has draft changes. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLifecycle' + readOnly: true + publishTime: + type: string + description: >- + Output only. The time this label was published. This value has no + meaning when the label is not published. + format: google-datetime + readOnly: true + appliedCapabilities: + description: >- + Output only. The capabilities related to this label on applied + metadata. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelAppliedCapabilities + readOnly: true + id: + description: >- + Output only. Globally unique identifier of this label. ID makes up + part of the label `name`, but unlike `name`, ID is consistent + between revisions. Matches the regex: `([a-zA-Z0-9])+` + type: string + readOnly: true + publisher: + readOnly: true + description: >- + Output only. The user who published this label. This value has no + meaning when the label is not published. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + revisionId: + description: >- + Output only. Revision ID of the label. Revision ID might be part of + the label `name` depending on the request issued. A new revision is + created whenever revisioned properties of a label are changed. + Matches the regex: `([a-zA-Z0-9])+` + type: string + readOnly: true + labelType: + enumDescriptions: + - Unknown label type. + - Shared labels may be shared with users to apply to Drive items. + - >- + Admin-owned label. Only creatable and editable by admins. Supports + some additional admin-only features. + - >- + A label owned by an internal Google application rather than a + customer. These labels are read-only. + enum: + - LABEL_TYPE_UNSPECIFIED + - SHARED + - ADMIN + - GOOGLE_APP + description: Required. The type of label. + type: string + customer: + readOnly: true + type: string + description: >- + Output only. The customer this label belongs to. For example: + "customers/123abc789." + fields: + description: List of fields in descending priority order. + type: array + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaField' + schemaCapabilities: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelSchemaCapabilities + description: Output only. The capabilities the user has on this label. + readOnly: true + appliedLabelPolicy: + description: >- + Output only. Behavior of this label when it's applied to Drive + items. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelAppliedLabelPolicy + readOnly: true + name: + description: >- + Output only. Resource name of the label. Will be in the form of + either: `labels/{id}` or `labels/{id}@{revision_id}` depending on + the request. See `id` and `revision_id` below. + readOnly: true + type: string + creator: + description: Output only. The user who created this label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + disableTime: + format: google-datetime + description: >- + Output only. The time this label was disabled. This value has no + meaning when the label is not disabled. + readOnly: true + type: string + revisionCreateTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time this label revision was created. + learnMoreUri: + type: string + description: >- + Custom URL to present to users to allow them to learn more about + this label and how it should be used. + createTime: + type: string + description: Output only. The time this label was created. + readOnly: true + format: google-datetime + revisionCreator: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: Output only. The user who created this label revision. + parameters: + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + x-stackQL-resources: + users_capabilities: + id: googleworkspace.drivelabelsv2beta.users_capabilities + name: users_capabilities + title: Users_capabilities + methods: + get_capabilities: + operation: + $ref: '#/paths/~1v2beta~1users~1{usersId}~1capabilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/users_capabilities/methods/get_capabilities + insert: [] + update: [] + replace: [] + delete: [] + labels: + id: googleworkspace.drivelabelsv2beta.labels + name: labels + title: Labels + methods: + create: + operation: + $ref: '#/paths/~1v2beta~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v2beta~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labels + delta: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:delta/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + publish: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:publish/post' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/labels/methods/get' + - $ref: '#/components/x-stackQL-resources/labels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete' + labels_permissions: + id: googleworkspace.drivelabelsv2beta.labels_permissions + name: labels_permissions + title: Labels_permissions + methods: + update_permissions: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1permissions/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_permissions/methods/update_permissions + replace: [] + delete: [] + permissions: + id: googleworkspace.drivelabelsv2beta.permissions + name: permissions + title: Permissions + methods: + create: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelPermissions + delete: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1permissions~1{permissionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + batch_update: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1permissions:batchUpdate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + batch_delete: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1permissions:batchDelete/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_delete' + labels_label_copy_mode: + id: googleworkspace.drivelabelsv2beta.labels_label_copy_mode + name: labels_label_copy_mode + title: Labels_label_copy_mode + methods: + update_label_copy_mode: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:updateLabelCopyMode/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_label_copy_mode/methods/update_label_copy_mode + replace: [] + delete: [] + locks: + id: googleworkspace.drivelabelsv2beta.locks + name: locks + title: Locks + methods: + list: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1locks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelLocks + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locks/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + revisions_permissions: + id: googleworkspace.drivelabelsv2beta.revisions_permissions + name: revisions_permissions + title: Revisions_permissions + methods: + update_permissions: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_permissions/methods/update_permissions + replace: [] + delete: [] + limits_label: + id: googleworkspace.drivelabelsv2beta.limits_label + name: limits_label + title: Limits_label + methods: + get_label: + operation: + $ref: '#/paths/~1v2beta~1limits~1label/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits_label/methods/get_label' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2beta/users/{usersId}/capabilities: + parameters: &ref_1 + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + get: + description: Gets the user capabilities. + operationId: drivelabels.users.getCapabilities + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaUserCapabilities + parameters: + - in: path + name: usersId + required: true + schema: + type: string + - in: query + name: customer + schema: + type: string + /v2beta/labels: + parameters: *ref_1 + post: + description: Creates a new Label. + operationId: drivelabels.labels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: query + name: languageCode + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: List labels. + operationId: drivelabels.labels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelsResponse + parameters: + - in: query + name: customer + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: publishedOnly + schema: + type: boolean + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: minimumRole + schema: + type: string + /v2beta/labels/{labelsId}/permissions: + parameters: *ref_1 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageToken + schema: + type: string + /v2beta/labels/{labelsId}:delta: + parameters: *ref_1 + post: + description: >- + Updates a single Label by applying a set of update requests resulting in + a new draft revision. The batch update is all-or-nothing: If any of the + update requests are invalid, no changes are applied. The resulting draft + revision must be published before the changes may be used with Drive + Items. + operationId: drivelabels.labels.delta + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}:updateLabelCopyMode: + parameters: *ref_1 + post: + description: >- + Updates a Label's `CopyMode`. Changes to this policy are not revisioned, + do not require publishing, and take effect immediately. + operationId: drivelabels.labels.updateLabelCopyMode + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaUpdateLabelCopyModeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a Label and related metadata on Drive Items. Once + deleted, the Label and related Drive item metadata will be deleted. Only + draft Labels, and disabled Labels may be deleted. + operationId: drivelabels.labels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: writeControl.requiredRevisionId + schema: + type: string + get: + description: >- + Get a label by its resource name. Resource name may be any of: * + `labels/{id}` - See `labels/{id}@latest` * `labels/{id}@latest` - Gets + the latest revision of the label. * `labels/{id}@published` - Gets the + current published revision of the label. * `labels/{id}@{revision_id}` - + Gets the label at the specified revision ID. + operationId: drivelabels.labels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}:enable: + parameters: *ref_1 + post: + description: >- + Enable a disabled Label and restore it to its published state. This will + result in a new published revision based on the current disabled + published revision. If there is an existing disabled draft revision, a + new revision will be created based on that draft and will be enabled. + operationId: drivelabels.labels.enable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaEnableLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}:publish: + parameters: *ref_1 + post: + description: >- + Publish all draft changes to the Label. Once published, the Label may + not return to its draft state. See + `google.apps.drive.labels.v2.Lifecycle` for more information. Publishing + a Label will result in a new published revision. All previous draft + revisions will be deleted. Previous published revisions will be kept but + are subject to automated deletion as needed. Once published, some + changes are no longer permitted. Generally, any change that would + invalidate or cause new restrictions on existing metadata related to the + Label will be rejected. For example, the following changes to a Label + will be rejected after the Label is published: * The label cannot be + directly deleted. It must be disabled first, then deleted. * + Field.FieldType cannot be changed. * Changes to Field validation options + cannot reject something that was previously accepted. * Reducing the max + entries. + operationId: drivelabels.labels.publish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaPublishLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}:disable: + parameters: *ref_1 + post: + description: >- + Disable a published Label. Disabling a Label will result in a new + disabled published revision based on the current published revision. If + there is a draft revision, a new disabled draft revision will be created + based on the latest draft revision. Older draft revisions will be + deleted. Once disabled, a label may be deleted with `DeleteLabel`. + operationId: drivelabels.labels.disable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDisableLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/revisions/{revisionsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.revisions.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions: + parameters: *ref_1 + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.revisions.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2beta/labels/{labelsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/limits/label: + parameters: *ref_1 + get: + description: >- + Get the constraints on the structure of a Label; such as, the maximum + number of Fields allowed and maximum length of the label title. + operationId: drivelabels.limits.getLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelLimits' + parameters: + - in: query + name: name + schema: + type: string diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivev2.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivev2.yaml new file mode 100644 index 00000000..1b207b12 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivev2.yaml @@ -0,0 +1,7544 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Google Drive API + description: The Google Drive API allows clients to access resources from Google Drive. + version: v2 + x-discovery-doc-revision: '20241202' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/ +servers: + - url: https://www.googleapis.com/drive/v2 +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive: See, edit, create, and delete all of your Google Drive files + https://www.googleapis.com/auth/drive.appdata: >- + See, create, and delete its own configuration data in your Google + Drive + https://www.googleapis.com/auth/drive.apps.readonly: View your Google Drive apps + https://www.googleapis.com/auth/drive.file: >- + See, edit, create, and delete only the specific Google Drive files + you use with this app + https://www.googleapis.com/auth/drive.meet.readonly: >- + See and download your Google Drive files that were created or + edited by Google Meet. + https://www.googleapis.com/auth/drive.metadata: View and manage metadata of files in your Google Drive + https://www.googleapis.com/auth/drive.metadata.readonly: See information about your Google Drive files + https://www.googleapis.com/auth/drive.photos.readonly: View the photos, videos and albums in your Google Photos + https://www.googleapis.com/auth/drive.readonly: See and download all your Google Drive files + https://www.googleapis.com/auth/drive.scripts: Modify your Google Apps Script scripts' behavior + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + About: + id: About + description: An item with user information and settings. + type: object + properties: + name: + description: The name of the current user. + type: string + quotaBytesTotal: + description: >- + The total number of quota bytes. This is only relevant when + quotaType is LIMITED. + type: string + format: int64 + quotaBytesUsed: + description: The number of quota bytes used by Google Drive. + type: string + format: int64 + quotaBytesUsedInTrash: + description: The number of quota bytes used by trashed items. + type: string + format: int64 + largestChangeId: + description: The largest change id. + type: string + format: int64 + remainingChangeIds: + description: The number of remaining change ids, limited to no more than 2500. + type: string + format: int64 + rootFolderId: + description: The id of the root folder. + type: string + importFormats: + description: The allowable import formats. + type: array + items: + type: object + properties: + source: + description: The imported file's content type to convert from. + type: string + targets: + description: The possible content types to convert to. + type: array + items: + type: string + exportFormats: + description: The allowable export formats. + type: array + items: + type: object + properties: + source: + description: The content type to convert from. + type: string + targets: + description: The possible content types to convert to. + type: array + items: + type: string + additionalRoleInfo: + description: >- + Information about supported additional roles per file type. The most + specific type takes precedence. + type: array + items: + type: object + properties: + type: + description: The content type that this additional role info applies to. + type: string + roleSets: + description: The supported additional roles per primary role. + type: array + items: + type: object + properties: + primaryRole: + description: A primary permission role. + type: string + additionalRoles: + description: The supported additional roles with the primary role. + type: array + items: + type: string + features: + description: List of additional features enabled on this account. + type: array + items: + type: object + properties: + featureName: + description: The name of the feature. + type: string + featureRate: + description: >- + The request limit rate for this feature, in queries per + second. + type: number + format: double + maxUploadSizes: + description: >- + List of max upload sizes for each file type. The most specific type + takes precedence. + type: array + items: + type: object + properties: + type: + description: The file type. + type: string + size: + description: The max upload size for this type. + type: string + format: int64 + domainSharingPolicy: + description: >- + The domain sharing policy for the current user. Possible values are: + * `allowed` * `allowedWithWarning` * `incomingOnly` * `disallowed` + type: string + kind: + description: This is always `drive#about`. + default: drive#about + type: string + permissionId: + description: The current user's ID as visible in the permissions collection. + type: string + isCurrentAppInstalled: + description: >- + A boolean indicating whether the authenticated app is installed by + the authenticated user. + type: boolean + quotaBytesUsedAggregate: + description: >- + The number of quota bytes used by all Google apps (Drive, Picasa, + etc.). + type: string + format: int64 + user: + description: The authenticated user. + $ref: '#/components/schemas/User' + etag: + description: The ETag of the item. + type: string + languageCode: + description: >- + The user's language or locale code, as defined by BCP 47, with some + extensions from Unicode's LDML format + (http://www.unicode.org/reports/tr35/). + type: string + selfLink: + description: A link back to this item. + type: string + quotaType: + description: >- + The type of the user's storage quota. Possible values are: * + `LIMITED` * `UNLIMITED` + type: string + folderColorPalette: + description: The palette of allowable folder colors as RGB hex strings. + type: array + items: + type: string + driveThemes: + description: A list of themes that are supported for shared drives. + type: array + items: + type: object + properties: + id: + description: The ID of the theme. + type: string + backgroundImageLink: + description: A link to this theme's background image. + type: string + colorRgb: + description: The color of this theme as an RGB hex string. + type: string + canCreateDrives: + description: Whether the user can create shared drives. + type: boolean + quotaBytesByService: + description: The amount of storage quota used by different Google services. + type: array + items: + type: object + properties: + serviceName: + description: The service's name, e.g. DRIVE, GMAIL, or PHOTOS. + type: string + bytesUsed: + description: The storage quota bytes used by the service. + type: string + format: int64 + teamDriveThemes: + description: 'Deprecated: Use `driveThemes` instead.' + deprecated: true + type: array + items: + type: object + properties: + id: + description: 'Deprecated: Use `driveThemes/id` instead.' + deprecated: true + type: string + backgroundImageLink: + description: 'Deprecated: Use `driveThemes/backgroundImageLink` instead.' + deprecated: true + type: string + colorRgb: + description: 'Deprecated: Use `driveThemes/colorRgb` instead.' + deprecated: true + type: string + canCreateTeamDrives: + description: 'Deprecated: Use `canCreateDrives` instead.' + deprecated: true + type: boolean + User: + id: User + description: Information about a Drive user. + type: object + properties: + displayName: + description: Output only. A plain text displayable name for this user. + type: string + kind: + description: Output only. This is always `drive#user`. + default: drive#user + type: string + isAuthenticatedUser: + description: >- + Output only. Whether this user is the same as the authenticated user + for whom the request was made. + type: boolean + permissionId: + description: Output only. The user's ID as visible in the permissions collection. + type: string + emailAddress: + description: Output only. The email address of the user. + type: string + picture: + description: Output only. The user's profile picture. + type: object + properties: + url: + description: >- + Output Only. A URL that points to a profile picture of this + user. + type: string + App: + id: App + description: >- + The apps resource provides a list of the apps that a user has installed, + with information about each app's supported MIME types, file extensions, + and other details. Some resource methods (such as `apps.get`) require an + `appId`. Use the `apps.list` method to retrieve the ID for an installed + application. + type: object + properties: + name: + description: The name of the app. + type: string + objectType: + description: >- + The type of object this app creates (e.g. Chart). If empty, the app + name should be used instead. + type: string + supportsCreate: + description: Whether this app supports creating new objects. + type: boolean + productUrl: + description: A link to the product listing for this app. + type: string + primaryMimeTypes: + description: The list of primary mime types. + type: array + items: + type: string + secondaryMimeTypes: + description: The list of secondary mime types. + type: array + items: + type: string + primaryFileExtensions: + description: The list of primary file extensions. + type: array + items: + type: string + secondaryFileExtensions: + description: The list of secondary file extensions. + type: array + items: + type: string + id: + description: The ID of the app. + type: string + supportsImport: + description: Whether this app supports importing from Docs Editors. + type: boolean + installed: + description: Whether the app is installed. + type: boolean + authorized: + description: Whether the app is authorized to access data on the user's Drive. + type: boolean + icons: + description: The various icons for the app. + type: array + items: + type: object + properties: + size: + description: >- + Size of the icon. Represented as the maximum of the width and + height. + type: integer + format: int32 + category: + description: >- + Category of the icon. Allowed values are: * `application` - + icon for the application * `document` - icon for a file + associated with the app * `documentShared` - icon for a shared + file associated with the app + type: string + iconUrl: + description: URL for the icon. + type: string + useByDefault: + description: >- + Whether the app is selected as the default handler for the types it + supports. + type: boolean + kind: + description: This is always `drive#app`. + default: drive#app + type: string + shortDescription: + description: A short description of the app. + type: string + longDescription: + description: A long description of the app. + type: string + supportsMultiOpen: + description: Whether this app supports opening more than one file. + type: boolean + productId: + description: The ID of the product listing for this app. + type: string + openUrlTemplate: + description: >- + The template url for opening files with this app. The template will + contain `{ids}` and/or `{exportIds}` to be replaced by the actual + file ids. See Open Files for the full documentation. + type: string + createUrl: + description: The url to create a new file with this app. + type: string + createInFolderTemplate: + description: >- + The template url to create a new file with this app in a given + folder. The template will contain {folderId} to be replaced by the + folder to create the new file in. + type: string + supportsOfflineCreate: + description: Whether this app supports creating new files when offline. + type: boolean + hasDriveWideScope: + description: >- + Whether the app has drive-wide scope. An app with drive-wide scope + can access all files in the user's drive. + type: boolean + AppList: + id: AppList + description: >- + A list of third-party applications which the user has installed or given + access to Google Drive. + type: object + properties: + etag: + description: The ETag of the list. + type: string + defaultAppIds: + description: >- + List of app IDs that the user has specified to use by default. The + list is in reverse-priority order (lowest to highest). + type: array + items: + type: string + kind: + description: This is always `drive#appList`. + default: drive#appList + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of apps. + type: array + items: + $ref: '#/components/schemas/App' + Change: + id: Change + description: Representation of a change to a file or shared drive. + type: object + properties: + id: + description: The ID of the change. + type: string + format: int64 + deleted: + description: >- + Whether the file or shared drive has been removed from this list of + changes, for example by deletion or loss of access. + type: boolean + file: + description: >- + The updated state of the file. Present if the type is file and the + file has not been removed from this list of changes. + $ref: '#/components/schemas/File' + fileId: + description: The ID of the file associated with this change. + type: string + modificationDate: + description: The time of this modification. + type: string + format: date-time + kind: + description: This is always `drive#change`. + default: drive#change + type: string + type: + description: 'Deprecated: Use `changeType` instead.' + deprecated: true + type: string + teamDriveId: + description: 'Deprecated: Use `driveId` instead.' + deprecated: true + type: string + teamDrive: + description: 'Deprecated: Use `drive` instead.' + deprecated: true + $ref: '#/components/schemas/TeamDrive' + changeType: + description: The type of the change. Possible values are `file` and `drive`. + type: string + selfLink: + description: A link back to this change. + type: string + driveId: + description: The ID of the shared drive associated with this change. + type: string + drive: + description: >- + The updated state of the shared drive. Present if the changeType is + drive, the user is still a member of the shared drive, and the + shared drive has not been deleted. + $ref: '#/components/schemas/Drive' + File: + id: File + description: >- + The metadata for a file. Some resource methods (such as `files.update`) + require a `fileId`. Use the `files.list` method to retrieve the ID for a + file. + type: object + properties: + kind: + description: Output only. The type of file. This is always `drive#file`. + default: drive#file + type: string + userPermission: + description: >- + Output only. The permissions for the authenticated user on this + file. + $ref: '#/components/schemas/Permission' + fileExtension: + description: >- + Output only. The final component of `fullFileExtension` with + trailing text that does not appear to be part of the extension + removed. This field is only populated for files with content stored + in Google Drive; it is not populated for Docs Editors or shortcut + files. + type: string + md5Checksum: + description: >- + Output only. An MD5 checksum for the content of this file. This + field is only populated for files with content stored in Google + Drive; it is not populated for Docs Editors or shortcut files. + type: string + selfLink: + description: Output only. A link back to this file. + type: string + ownerNames: + description: >- + Output only. Name(s) of the owner(s) of this file. Not populated for + items in shared drives. + type: array + items: + type: string + lastModifyingUserName: + description: Output only. Name of the last user to modify this file. + type: string + editable: + description: 'Output only. Deprecated: Use `capabilities/canEdit` instead.' + deprecated: true + type: boolean + writersCanShare: + description: >- + Whether writers can share the document with other users. Not + populated for items in shared drives. + type: boolean + downloadUrl: + description: >- + Output only. Short lived download URL for the file. This field is + only populated for files with content stored in Google Drive; it is + not populated for Google Docs or shortcut files. + type: string + mimeType: + description: >- + The MIME type of the file. This is only mutable on update when + uploading new content. This field can be left blank, and the + mimetype will be determined from the uploaded content's MIME type. + type: string + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + readOnly: true + type: object + additionalProperties: + type: string + driveId: + description: >- + Output only. ID of the shared drive the file resides in. Only + populated for items in shared drives. + type: string + parents: + description: >- + The ID of the parent folder containing the file. A file can only + have one parent folder; specifying multiple parents isn't supported. + If not specified as part of an insert request, the file is placed + directly in the user's My Drive folder. If not specified as part of + a copy request, the file inherits any discoverable parent of the + source file. Update requests must use the `addParents` and + `removeParents` parameters to modify the parents list. + type: array + items: + $ref: '#/components/schemas/ParentReference' + thumbnailLink: + description: >- + Output only. A short-lived link to the file's thumbnail, if + available. Typically lasts on the order of hours. Not intended for + direct usage on web applications due to [Cross-Origin Resource + Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), + consider using a proxy server. Only populated when the requesting + app can access the file's content. If the file isn't shared + publicly, the URL returned in `Files.thumbnailLink` must be fetched + using a credentialed request. + type: string + appDataContents: + description: Output only. Whether this file is in the Application Data folder. + type: boolean + webViewLink: + description: >- + Output only. A link only available on public folders for viewing + their static web assets (HTML, CSS, JS, etc) via Google Drive's + Website Hosting. + type: string + iconLink: + description: Output only. A link to the file's icon. + type: string + shared: + description: >- + Output only. Whether the file has been shared. Not populated for + items in shared drives. + type: boolean + lastModifyingUser: + description: >- + Output only. The last user to modify this file. This field is only + populated when the last modification was performed by a signed-in + user. + $ref: '#/components/schemas/User' + owners: + description: >- + Output only. The owner of this file. Only certain legacy files may + have more than one owner. This field isn't populated for items in + shared drives. + type: array + items: + $ref: '#/components/schemas/User' + openWithLinks: + description: >- + Output only. A map of the id of each of the user's apps to a link to + open this file with that app. Only populated when the + drive.apps.readonly scope is used. + type: object + additionalProperties: + type: string + defaultOpenWithLink: + description: >- + Output only. A link to open this file with the user's default app + for this file. Only populated when the drive.apps.readonly scope is + used. + type: string + headRevisionId: + description: >- + Output only. The ID of the file's head revision. This field is only + populated for files with content stored in Google Drive; it is not + populated for Docs Editors or shortcut files. + type: string + properties: + description: The list of properties. + type: array + items: + $ref: '#/components/schemas/Property' + copyable: + description: 'Output only. Deprecated: Use `capabilities/canCopy` instead.' + deprecated: true + type: boolean + etag: + description: Output only. ETag of the file. + type: string + sharingUser: + description: >- + Output only. User that shared the item with the current user, if + available. + $ref: '#/components/schemas/User' + alternateLink: + description: >- + Output only. A link for opening the file in a relevant Google editor + or viewer. + type: string + embedLink: + description: Output only. A link for embedding the file. + type: string + webContentLink: + description: >- + Output only. A link for downloading the content of the file in a + browser using cookie based authentication. In cases where the + content is shared publicly, the content can be downloaded without + any credentials. + type: string + fileSize: + description: >- + Output only. Size in bytes of blobs and first party editor files. + Won't be populated for files that have no size, like shortcuts and + folders. + type: string + format: int64 + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download this file, should be + disabled for readers and commenters. + type: boolean + permissions: + description: >- + Output only. The list of permissions for users with access to this + file. Not populated for items in shared drives. + type: array + items: + $ref: '#/components/schemas/Permission' + hasThumbnail: + description: >- + Output only. Whether this file has a thumbnail. This does not + indicate whether the requesting app has access to the thumbnail. To + check access, look for the presence of the thumbnailLink field. + type: boolean + spaces: + description: >- + Output only. The list of spaces which contain the file. Supported + values are `drive`, `appDataFolder` and `photos`. + type: array + items: + type: string + folderColorRgb: + description: >- + Folder color as an RGB hex string if the file is a folder or a + shortcut to a folder. The list of supported colors is available in + the folderColorPalette field of the About resource. If an + unsupported color is specified, it will be changed to the closest + color in the palette. + type: string + id: + description: The ID of the file. + type: string + title: + description: >- + The title of this file. Note that for immutable items such as the + top level folders of shared drives, My Drive root folder, and + Application Data folder the title is constant. + type: string + description: + description: A short description of the file. + type: string + labels: + description: A group of labels for the file. + type: object + properties: + viewed: + description: Whether this file has been viewed by this user. + type: boolean + restricted: + description: >- + Output only. Deprecated: Use `copyRequiresWriterPermission` + instead. + deprecated: true + type: boolean + starred: + description: Whether this file is starred by the user. + type: boolean + hidden: + description: Output only. Deprecated. + deprecated: true + type: boolean + trashed: + description: >- + Whether this file has been trashed. This label applies to all + users accessing the file; however, only owners are allowed to + see and untrash files. + type: boolean + modified: + description: Output only. Whether the file has been modified by this user. + type: boolean + explicitlyTrashed: + description: >- + Output only. Whether this file has been explicitly trashed, as + opposed to recursively trashed. + type: boolean + createdDate: + description: Create time for this file (formatted RFC 3339 timestamp). + type: string + format: date-time + modifiedDate: + description: >- + Last time this file was modified by anyone (formatted RFC 3339 + timestamp). This is only mutable on update when the setModifiedDate + parameter is set. + type: string + format: date-time + modifiedByMeDate: + description: >- + Last time this file was modified by the user (formatted RFC 3339 + timestamp). Note that setting modifiedDate will also update the + modifiedByMe date for the user which set the date. + type: string + format: date-time + lastViewedByMeDate: + description: >- + Last time this file was viewed by the user (formatted RFC 3339 + timestamp). + type: string + format: date-time + markedViewedByMeDate: + description: Deprecated. + type: string + format: date-time + sharedWithMeDate: + description: >- + Time at which this file was shared with the user (formatted RFC 3339 + timestamp). + type: string + format: date-time + quotaBytesUsed: + description: Output only. The number of quota bytes used by this file. + type: string + format: int64 + version: + description: >- + Output only. A monotonically increasing version number for the file. + This reflects every change made to the file on the server, even + those not visible to the requesting user. + type: string + format: int64 + indexableText: + description: Indexable text attributes for the file (can only be written) + type: object + properties: + text: + description: The text to be indexed for this file. + type: string + originalFilename: + description: >- + The original filename of the uploaded content if available, or else + the original value of the `title` field. This is only available for + files with binary content in Google Drive. + type: string + ownedByMe: + description: >- + Output only. Whether the file is owned by the current user. Not + populated for items in shared drives. + type: boolean + canComment: + description: 'Output only. Deprecated: Use `capabilities/canComment` instead.' + deprecated: true + type: boolean + shareable: + description: 'Output only. Deprecated: Use `capabilities/canShare` instead.' + deprecated: true + type: boolean + fullFileExtension: + description: >- + Output only. The full file extension; extracted from the title. May + contain multiple concatenated extensions, such as "tar.gz". Removing + an extension from the title does not clear this field; however, + changing the extension on the title does update this field. This + field is only populated for files with content stored in Google + Drive; it is not populated for Docs Editors or shortcut files. + type: string + isAppAuthorized: + description: >- + Output only. Whether the file was created or opened by the + requesting app. + type: boolean + teamDriveId: + description: 'Output only. Deprecated: Use `driveId` instead.' + deprecated: true + type: string + capabilities: + description: >- + Output only. Capabilities the current user has on this file. Each + capability corresponds to a fine-grained action that a user may + take. + type: object + properties: + canChangeRestrictedDownload: + description: Output only. Deprecated. + deprecated: true + type: boolean + canMoveChildrenOutOfDrive: + description: >- + Output only. Whether the current user can move children of this + folder outside of the shared drive. This is false when the item + is not a folder. Only populated for items in shared drives. + type: boolean + canReadDrive: + description: >- + Output only. Whether the current user can read the shared drive + to which this file belongs. Only populated for items in shared + drives. + type: boolean + canEdit: + description: >- + Output only. Whether the current user can edit this file. Other + factors may limit the type of changes a user can make to a file. + For example, see `canChangeCopyRequiresWriterPermission` or + `canModifyContent`. + type: boolean + canCopy: + description: >- + Output only. Whether the current user can copy this file. For an + item in a shared drive, whether the current user can copy + non-folder descendants of this item, or this item itself if it + is not a folder. + type: boolean + canComment: + description: Output only. Whether the current user can comment on this file. + type: boolean + canAddChildren: + description: >- + Output only. Whether the current user can add children to this + folder. This is always false when the item is not a folder. + type: boolean + canDelete: + description: Output only. Whether the current user can delete this file. + type: boolean + canDownload: + description: Output only. Whether the current user can download this file. + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + this folder. This is always false when the item is not a folder. + type: boolean + canRemoveChildren: + description: >- + Output only. Whether the current user can remove children from + this folder. This is always false when the item is not a folder. + For a folder in a shared drive, use `canDeleteChildren` or + `canTrashChildren` instead. + type: boolean + canRename: + description: Output only. Whether the current user can rename this file. + type: boolean + canTrash: + description: >- + Output only. Whether the current user can move this file to + trash. + type: boolean + canReadRevisions: + description: >- + Output only. Whether the current user can read the revisions + resource of this file. For a shared drive item, whether + revisions of non-folder descendants of this item, or this item + itself if it is not a folder, can be read. + type: boolean + canReadTeamDrive: + description: 'Output only. Deprecated: Use `canReadDrive` instead.' + deprecated: true + type: boolean + canMoveTeamDriveItem: + description: >- + Output only. Deprecated: Use `canMoveItemWithinDrive` or + `canMoveItemOutOfDrive` instead. + deprecated: true + type: boolean + canChangeCopyRequiresWriterPermission: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this file. + type: boolean + canMoveItemIntoTeamDrive: + description: 'Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canUntrash: + description: >- + Output only. Whether the current user can restore this file from + trash. + type: boolean + canModifyContent: + description: >- + Output only. Whether the current user can modify the content of + this file. + type: boolean + canMoveItemWithinTeamDrive: + description: 'Output only. Deprecated: Use `canMoveItemWithinDrive` instead.' + deprecated: true + type: boolean + canMoveItemOutOfTeamDrive: + description: 'Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children of + this folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveChildrenOutOfTeamDrive: + description: >- + Output only. Deprecated: Use `canMoveChildrenOutOfDrive` + instead. + deprecated: true + type: boolean + canMoveChildrenWithinTeamDrive: + description: >- + Output only. Deprecated: Use `canMoveChildrenWithinDrive` + instead. + deprecated: true + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children of this + folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveItemOutOfDrive: + description: >- + Output only. Whether the current user can move this item outside + of this drive by changing its parent. Note that a request to + change the parent of the item may still fail depending on the + new parent that is being added. + type: boolean + canAddMyDriveParent: + description: >- + Output only. Whether the current user can add a parent for the + item without removing an existing parent in the same request. + Not populated for shared drive files. + type: boolean + canRemoveMyDriveParent: + description: >- + Output only. Whether the current user can remove a parent from + the item without adding another parent in the same request. Not + populated for shared drive files. + type: boolean + canMoveItemWithinDrive: + description: >- + Output only. Whether the current user can move this item within + this drive. Note that a request to change the parent of the item + may still fail depending on the new parent that is being added + and the parent that is being removed. + type: boolean + canShare: + description: >- + Output only. Whether the current user can modify the sharing + settings for this file. + type: boolean + canMoveChildrenWithinDrive: + description: >- + Output only. Whether the current user can move children of this + folder within this drive. This is false when the item is not a + folder. Note that a request to move the child may still fail + depending on the current user's access to the child and to the + destination folder. + type: boolean + canModifyContentRestriction: + description: >- + Deprecated: Output only. Use one of + `canModifyEditorContentRestriction`, + `canModifyOwnerContentRestriction` or + `canRemoveContentRestriction`. + deprecated: true + type: boolean + canAddFolderFromAnotherDrive: + description: >- + Output only. Whether the current user can add a folder from + another drive (different shared drive or My Drive) to this + folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canChangeSecurityUpdateEnabled: + description: >- + Output only. Whether the current user can change the + securityUpdateEnabled field on link share metadata. + type: boolean + canAcceptOwnership: + description: >- + Output only. Whether the current user is the pending owner of + the file. Not populated for shared drive files. + type: boolean + canReadLabels: + description: >- + Output only. Whether the current user can read the labels on the + file. + type: boolean + canModifyLabels: + description: >- + Output only. Whether the current user can modify the labels on + the file. + type: boolean + canModifyEditorContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions on the file which are editor restricted. + type: boolean + canModifyOwnerContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions which are owner restricted. + type: boolean + canRemoveContentRestriction: + description: >- + Output only. Whether there is a content restriction on the file + that can be removed by the current user. + type: boolean + hasAugmentedPermissions: + description: >- + Output only. Whether there are permissions directly on this file. + This field is only populated for items in shared drives. + type: boolean + trashingUser: + description: >- + Output only. If the file has been explicitly trashed, the user who + trashed it. Only populated for items in shared drives. + $ref: '#/components/schemas/User' + canReadRevisions: + description: >- + Output only. Deprecated: Use `capabilities/canReadRevisions` + instead. + deprecated: true + type: boolean + thumbnailVersion: + description: >- + Output only. The thumbnail version for use in thumbnail cache + invalidation. + type: string + format: int64 + trashedDate: + description: >- + The time that the item was trashed (formatted RFC 3339 timestamp). + Only populated for items in shared drives. + type: string + format: date-time + permissionIds: + description: >- + Output only. List of permission IDs for users with access to this + file. + type: array + items: + type: string + thumbnail: + description: >- + A thumbnail for the file. This will only be used if a standard + thumbnail cannot be generated. + type: object + properties: + image: + description: >- + The URL-safe Base64 encoded bytes of the thumbnail image. It + should conform to RFC 4648 section 5. + type: string + format: byte + mimeType: + description: The MIME type of the thumbnail. + type: string + imageMediaMetadata: + description: >- + Output only. Metadata about image media. This will only be present + for image types, and its contents will depend on what can be parsed + from the image content. + type: object + properties: + flashUsed: + description: Output only. Whether a flash was used to create the photo. + type: boolean + meteringMode: + description: Output only. The metering mode used to create the photo. + type: string + sensor: + description: Output only. The type of sensor used to create the photo. + type: string + exposureMode: + description: Output only. The exposure mode used to create the photo. + type: string + colorSpace: + description: Output only. The color space of the photo. + type: string + whiteBalance: + description: Output only. The white balance mode used to create the photo. + type: string + width: + description: Output only. The width of the image in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the image in pixels. + type: integer + format: int32 + location: + description: >- + Output only. Geographic location information stored in the + image. + type: object + properties: + latitude: + description: Output only. The latitude stored in the image. + type: number + format: double + longitude: + description: Output only. The longitude stored in the image. + type: number + format: double + altitude: + description: Output only. The altitude stored in the image. + type: number + format: double + rotation: + description: >- + Output only. The number of clockwise 90 degree rotations applied + from the image's original orientation. + type: integer + format: int32 + date: + description: >- + Output only. The date and time the photo was taken (EXIF format + timestamp). + type: string + cameraMake: + description: Output only. The make of the camera used to create the photo. + type: string + cameraModel: + description: Output only. The model of the camera used to create the photo. + type: string + exposureTime: + description: Output only. The length of the exposure, in seconds. + type: number + format: float + aperture: + description: Output only. The aperture used to create the photo (f-number). + type: number + format: float + focalLength: + description: >- + Output only. The focal length used to create the photo, in + millimeters. + type: number + format: float + isoSpeed: + description: Output only. The ISO speed used to create the photo. + type: integer + format: int32 + exposureBias: + description: Output only. The exposure bias of the photo (APEX value). + type: number + format: float + maxApertureValue: + description: >- + Output only. The smallest f-number of the lens at the focal + length used to create the photo (APEX value). + type: number + format: float + subjectDistance: + description: >- + Output only. The distance to the subject of the photo, in + meters. + type: integer + format: int32 + lens: + description: Output only. The lens used to create the photo. + type: string + videoMediaMetadata: + description: >- + Output only. Metadata about video media. This will only be present + for video types. + type: object + properties: + width: + description: Output only. The width of the video in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the video in pixels. + type: integer + format: int32 + durationMillis: + description: Output only. The duration of the video in milliseconds. + type: string + format: int64 + shortcutDetails: + description: >- + Shortcut file details. Only populated for shortcut files, which have + the mimeType field set to `application/vnd.google-apps.shortcut`. + Can only be set on `files.insert` requests. + type: object + properties: + targetId: + description: >- + The ID of the file that this shortcut points to. Can only be set + on `files.insert` requests. + type: string + targetMimeType: + description: >- + Output only. The MIME type of the file that this shortcut points + to. The value of this field is a snapshot of the target's MIME + type, captured when the shortcut is created. + type: string + targetResourceKey: + description: Output only. The ResourceKey for the target file. + type: string + contentRestrictions: + description: >- + Restrictions for accessing the content of the file. Only populated + if such a restriction exists. + type: array + items: + $ref: '#/components/schemas/ContentRestriction' + resourceKey: + description: Output only. A key needed to access the item via a shared link. + type: string + linkShareMetadata: + description: >- + Contains details about the link URLs that clients are using to refer + to this item. + type: object + properties: + securityUpdateEligible: + description: Output only. Whether the file is eligible for security update. + type: boolean + securityUpdateEnabled: + description: >- + Output only. Whether the security update is enabled for this + file. + type: boolean + labelInfo: + description: Output only. An overview of the labels on the file. + type: object + properties: + labels: + description: >- + Output only. The set of labels on the file as requested by the + label IDs in the `includeLabels` parameter. By default, no + labels are returned. + type: array + items: + $ref: '#/components/schemas/Label' + sha1Checksum: + description: >- + Output only. The SHA1 checksum associated with this file, if + available. This field is only populated for files with content + stored in Google Drive; it is not populated for Docs Editors or + shortcut files. + type: string + sha256Checksum: + description: >- + Output only. The SHA256 checksum associated with this file, if + available. This field is only populated for files with content + stored in Google Drive; it is not populated for Docs Editors or + shortcut files. + type: string + Permission: + id: Permission + description: >- + A permission for a file. A permission grants a user, group, domain, or + the world access to a file or a folder hierarchy. Some resource methods + (such as `permissions.update`) require a `permissionId`. Use the + `permissions.list` method to retrieve the ID for a file, folder, or + shared drive. + type: object + properties: + id: + description: >- + The ID of the user this permission refers to, and identical to the + `permissionId` in the About and Files resources. When making a + `drive.permissions.insert` request, exactly one of the `id` or + `value` fields must be specified unless the permission type is + `anyone`, in which case both `id` and `value` are ignored. + type: string + name: + description: Output only. The name for this permission. + type: string + type: + description: >- + The account type. Allowed values are: * `user` * `group` * `domain` + * `anyone` + annotations: + required: + - drive.permissions.insert + type: string + role: + description: >- + The primary role for this user. While new values may be supported in + the future, the following are currently allowed: * `owner` * + `organizer` * `fileOrganizer` * `writer` * `reader` + annotations: + required: + - drive.permissions.insert + type: string + additionalRoles: + description: >- + Additional roles for this user. Only `commenter` is currently + allowed, though more may be supported in the future. + type: array + items: + type: string + authKey: + description: Output only. Deprecated. + deprecated: true + type: string + value: + description: >- + The email address or domain name for the entity. This is used during + inserts and is not populated in responses. When making a + `drive.permissions.insert` request, exactly one of the `id` or + `value` fields must be specified unless the permission type is + `anyone`, in which case both `id` and `value` are ignored. + type: string + kind: + description: Output only. This is always `drive#permission`. + default: drive#permission + type: string + withLink: + description: Whether the link is required for this permission. + type: boolean + photoLink: + description: Output only. A link to the profile photo, if available. + type: string + selfLink: + description: Output only. A link back to this permission. + type: string + emailAddress: + description: >- + Output only. The email address of the user or group this permission + refers to. This is an output-only field which is present when the + permission type is `user` or `group`. + type: string + domain: + description: >- + Output only. The domain name of the entity this permission refers + to. This is an output-only field which is present when the + permission type is `user`, `group` or `domain`. + type: string + etag: + description: Output only. The ETag of the permission. + type: string + permissionDetails: + description: >- + Output only. Details of whether the permissions on this shared drive + item are inherited or directly on this item. This is an output-only + field which is present only for shared drive items. + readOnly: true + type: array + items: + type: object + properties: + permissionType: + description: >- + Output only. The permission type for this user. While new + values may be added in future, the following are currently + possible: * `file` * `member` + type: string + role: + description: >- + Output only. The primary role for this user. While new values + may be added in the future, the following are currently + possible: * `organizer` * `fileOrganizer` * `writer` * + `reader` + type: string + additionalRoles: + description: >- + Output only. Additional roles for this user. Only `commenter` + is currently possible, though more may be supported in the + future. + type: array + items: + type: string + inheritedFrom: + description: >- + Output only. The ID of the item from which this permission is + inherited. This is an output-only field. + type: string + inherited: + description: >- + Output only. Whether this permission is inherited. This field + is always populated. This is an output-only field. + type: boolean + expirationDate: + description: >- + The time at which this permission will expire (RFC 3339 date-time). + Expiration dates have the following restrictions: - They can only be + set on user and group permissions - The date must be in the future - + The date cannot be more than a year in the future - The date can + only be set on drive.permissions.update or drive.permissions.patch + requests + type: string + format: date-time + teamDrivePermissionDetails: + description: 'Output only. Deprecated: Use `permissionDetails` instead.' + readOnly: true + deprecated: true + type: array + items: + type: object + properties: + teamDrivePermissionType: + description: >- + Output only. Deprecated: Use + `permissionDetails/permissionType` instead. + deprecated: true + type: string + role: + description: 'Output only. Deprecated: Use `permissionDetails/role` instead.' + deprecated: true + type: string + additionalRoles: + description: >- + Output only. Deprecated: Use + `permissionDetails/additionalRoles` instead. + deprecated: true + type: array + items: + type: string + inheritedFrom: + description: >- + Output only. Deprecated: Use `permissionDetails/inheritedFrom` + instead. + deprecated: true + type: string + inherited: + description: >- + Output only. Deprecated: Use `permissionDetails/inherited` + instead. + deprecated: true + type: boolean + deleted: + description: >- + Output only. Whether the account associated with this permission has + been deleted. This field only pertains to user and group + permissions. + type: boolean + view: + description: >- + Indicates the view for this permission. Only populated for + permissions that belong to a view. `published` is the only supported + value. + type: string + pendingOwner: + description: >- + Whether the account associated with this permission is a pending + owner. Only populated for `user` type permissions for files that are + not in a shared drive. + type: boolean + ParentReference: + id: ParentReference + description: >- + A reference to a file's parent. A file can only have one parent folder; + specifying multiple parents isn't supported. Some resource methods (such + as `parents.get`) require a `parentId`. Use the `parents.list` method to + retrieve the ID for a parent. + type: object + properties: + selfLink: + description: Output only. A link back to this reference. + type: string + id: + description: The ID of the parent. + annotations: + required: + - drive.parents.insert + type: string + isRoot: + description: Output only. Whether or not the parent is the root folder. + type: boolean + kind: + description: Output only. This is always `drive#parentReference`. + default: drive#parentReference + type: string + parentLink: + description: Output only. A link to the parent. + type: string + Property: + id: Property + description: >- + A key-value pair attached to a file that is either public or private to + an application. The following limits apply to file properties: * Maximum + of 100 properties total per file * Maximum of 30 private properties per + app * Maximum of 30 public properties * Maximum of 124 bytes size limit + on (key + value) string in UTF-8 encoding for a single property Some + resource methods (such as `properties.update`) require a `propertyKey`. + Use the `properties.list` method to retrieve the key for a property. + type: object + properties: + selfLink: + description: Output only. The link back to this property. + type: string + value: + description: The value of this property. + type: string + visibility: + description: >- + The visibility of this property. Allowed values are PRIVATE + (default) and PUBLIC. Private properties can only be retrieved using + an authenticated request. An authenticated request uses an access + token obtained with a OAuth 2 client ID. You cannot use an API key + to retrieve private properties. + type: string + kind: + description: Output only. This is always `drive#property`. + default: drive#property + type: string + etag: + description: Output only. ETag of the property. + type: string + key: + description: The key of this property. + annotations: + required: + - drive.properties.insert + type: string + ContentRestriction: + id: ContentRestriction + description: A restriction for accessing the content of the file. + type: object + properties: + readOnly: + description: >- + Whether the content of the file is read-only. If a file is + read-only, a new revision of the file may not be added, comments may + not be added or modified, and the title of the file may not be + modified. + type: boolean + reason: + description: >- + Reason for why the content of the file is restricted. This is only + mutable on requests that also set `readOnly=true`. + type: string + type: + description: >- + Output only. The type of the content restriction. Currently the only + possible value is `globalContentRestriction`. + type: string + restrictingUser: + description: >- + Output only. The user who set the content restriction. Only + populated if `readOnly` is true. + $ref: '#/components/schemas/User' + restrictionDate: + description: >- + The time at which the content restriction was set (formatted RFC + 3339 timestamp). Only populated if readOnly is true. + type: string + format: date-time + ownerRestricted: + description: >- + Whether the content restriction can only be modified or removed by a + user who owns the file. For files in shared drives, any user with + `organizer` capabilities can modify or remove this content + restriction. + type: boolean + systemRestricted: + description: >- + Output only. Whether the content restriction was applied by the + system, for example due to an esignature. Users cannot modify or + remove system restricted content restrictions. + type: boolean + Label: + id: Label + description: Representation of a label and label fields. + type: object + properties: + id: + description: The ID of the label. + type: string + revisionId: + description: The revision ID of the label. + type: string + kind: + description: This is always `drive#label` + default: drive#label + type: string + fields: + description: A map of the fields on the label, keyed by the field's ID. + type: object + additionalProperties: + $ref: '#/components/schemas/LabelField' + LabelField: + id: LabelField + description: Representation of field, which is a typed key-value pair. + type: object + properties: + kind: + description: This is always `drive#labelField`. + default: drive#labelField + type: string + id: + description: The identifier of this label field. + type: string + valueType: + description: >- + The field type. While new values may be supported in the future, the + following are currently allowed: * `dateString` * `integer` * + `selection` * `text` * `user` + type: string + dateString: + description: >- + Only present if valueType is dateString. RFC 3339 formatted date: + YYYY-MM-DD. + type: array + items: + type: string + format: date + integer: + description: Only present if `valueType` is `integer`. + type: array + items: + type: string + format: int64 + selection: + description: Only present if `valueType` is `selection` + type: array + items: + type: string + text: + description: Only present if `valueType` is `text`. + type: array + items: + type: string + user: + description: Only present if `valueType` is `user`. + type: array + items: + $ref: '#/components/schemas/User' + TeamDrive: + id: TeamDrive + description: 'Deprecated: Use the `drive` collection instead.' + type: object + properties: + id: + description: >- + The ID of this Team Drive which is also the ID of the top level + folder of this Team Drive. + type: string + name: + description: The name of this Team Drive. + annotations: + required: + - drive.teamdrives.insert + type: string + colorRgb: + description: >- + The color of this Team Drive as an RGB hex string. It can only be + set on a `drive.teamdrives.update` request that does not set + `themeId`. + type: string + kind: + description: This is always `drive#teamDrive` + default: drive#teamDrive + type: string + backgroundImageLink: + description: A short-lived link to this Team Drive's background image. + type: string + capabilities: + description: Capabilities the current user has on this Team Drive. + type: object + properties: + canAddChildren: + description: >- + Whether the current user can add children to folders in this + Team Drive. + type: boolean + canComment: + description: >- + Whether the current user can comment on files in this Team + Drive. + type: boolean + canCopy: + description: Whether the current user can copy files in this Team Drive. + type: boolean + canDeleteTeamDrive: + description: >- + Whether the current user can delete this Team Drive. Attempting + to delete the Team Drive may still fail if there are untrashed + items inside the Team Drive. + type: boolean + canDownload: + description: Whether the current user can download files in this Team Drive. + type: boolean + canEdit: + description: Whether the current user can edit files in this Team Drive + type: boolean + canListChildren: + description: >- + Whether the current user can list the children of folders in + this Team Drive. + type: boolean + canManageMembers: + description: >- + Whether the current user can add members to this Team Drive or + remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Whether the current user can read the revisions resource of + files in this Team Drive. + type: boolean + canRemoveChildren: + description: >- + Deprecated: Use `canDeleteChildren` or `canTrashChildren` + instead. + deprecated: true + type: boolean + canRename: + description: >- + Whether the current user can rename files or folders in this + Team Drive. + type: boolean + canRenameTeamDrive: + description: Whether the current user can rename this Team Drive. + type: boolean + canChangeTeamDriveBackground: + description: >- + Whether the current user can change the background of this Team + Drive. + type: boolean + canShare: + description: >- + Whether the current user can share files or folders in this Team + Drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Whether the current user can change the + `copyRequiresWriterPermission` restriction of this Team Drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Whether the current user can change the `domainUsersOnly` + restriction of this Team Drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + Team Drive. + type: boolean + canChangeTeamMembersOnlyRestriction: + description: >- + Whether the current user can change the `teamMembersOnly` + restriction of this Team Drive. + type: boolean + canDeleteChildren: + description: >- + Whether the current user can delete children from folders in + this Team Drive. + type: boolean + canTrashChildren: + description: >- + Whether the current user can trash children from folders in this + Team Drive. + type: boolean + canResetTeamDriveRestrictions: + description: >- + Whether the current user can reset the Team Drive restrictions + to defaults. + type: boolean + themeId: + description: >- + The ID of the theme from which the background image and color will + be set. The set of possible `teamDriveThemes` can be retrieved from + a `drive.about.get` response. When not specified on a + `drive.teamdrives.insert` request, a random theme is chosen from + which the background image and color are set. This is a write-only + field; it can only be set on requests that don't set `colorRgb` or + `backgroundImageFile`. + type: string + backgroundImageFile: + description: >- + An image file and cropping parameters from which a background image + for this Team Drive is set. This is a write only field; it can only + be set on `drive.teamdrives.update` requests that don't set + `themeId`. When specified, all fields of the `backgroundImageFile` + must be set. + type: object + properties: + id: + description: >- + The ID of an image file in Drive to use for the background + image. + type: string + xCoordinate: + description: >- + The X coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the horizontal distance from the + left side of the entire image to the left side of the cropping + area divided by the width of the entire image. + type: number + format: float + yCoordinate: + description: >- + The Y coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the vertical distance from the top + side of the entire image to the top side of the cropping area + divided by the height of the entire image. + type: number + format: float + width: + description: >- + The width of the cropped image in the closed range of 0 to 1. + This value represents the width of the cropped image divided by + the width of the entire image. The height is computed by + applying a width to height aspect ratio of 80 to 9. The + resulting image must be at least 1280 pixels wide and 144 pixels + high. + type: number + format: float + createdDate: + description: The time at which the Team Drive was created (RFC 3339 date-time). + type: string + format: date-time + restrictions: + description: >- + A set of restrictions that apply to this Team Drive or items inside + this Team Drive. + type: object + properties: + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download files inside + this Team Drive, should be disabled for readers and commenters. + When this restriction is set to `true`, it will override the + similarly named field to `true` for any file inside this Team + Drive. + type: boolean + domainUsersOnly: + description: >- + Whether access to this Team Drive and items inside this Team + Drive is restricted to users of the domain to which this Team + Drive belongs. This restriction may be overridden by other + sharing policies controlled outside of this Team Drive. + type: boolean + teamMembersOnly: + description: >- + Whether access to items inside this Team Drive is restricted to + members of this Team Drive. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this Team Drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + If true, only users with the organizer role can share folders. + If false, users with either the organizer role or the file + organizer role can share folders. + type: boolean + orgUnitId: + description: >- + The organizational unit of this shared drive. This field is only + populated on `drives.list` responses when the `useDomainAdminAccess` + parameter is set to `true`. + type: string + Drive: + id: Drive + description: >- + Representation of a shared drive. Some resource methods (such as + `drives.update`) require a `driveId`. Use the `drives.list` method to + retrieve the ID for a shared drive. + type: object + properties: + id: + description: >- + Output only. The ID of this shared drive which is also the ID of the + top level folder of this shared drive. + type: string + name: + description: The name of this shared drive. + annotations: + required: + - drive.drives.insert + type: string + colorRgb: + description: >- + The color of this shared drive as an RGB hex string. It can only be + set on a `drive.drives.update` request that does not set `themeId`. + type: string + kind: + description: Output only. This is always `drive#drive` + default: drive#drive + type: string + backgroundImageLink: + description: >- + Output only. A short-lived link to this shared drive's background + image. + type: string + capabilities: + description: Output only. Capabilities the current user has on this shared drive. + type: object + properties: + canAddChildren: + description: >- + Output only. Whether the current user can add children to + folders in this shared drive. + type: boolean + canComment: + description: >- + Output only. Whether the current user can comment on files in + this shared drive. + type: boolean + canCopy: + description: >- + Output only. Whether the current user can copy files in this + shared drive. + type: boolean + canDeleteDrive: + description: >- + Output only. Whether the current user can delete this shared + drive. Attempting to delete the shared drive may still fail if + there are untrashed items inside the shared drive. + type: boolean + canDownload: + description: >- + Output only. Whether the current user can download files in this + shared drive. + type: boolean + canEdit: + description: >- + Output only. Whether the current user can edit files in this + shared drive + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + folders in this shared drive. + type: boolean + canManageMembers: + description: >- + Output only. Whether the current user can add members to this + shared drive or remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Output only. Whether the current user can read the revisions + resource of files in this shared drive. + type: boolean + canRename: + description: >- + Output only. Whether the current user can rename files or + folders in this shared drive. + type: boolean + canRenameDrive: + description: >- + Output only. Whether the current user can rename this shared + drive. + type: boolean + canChangeDriveBackground: + description: >- + Output only. Whether the current user can change the background + of this shared drive. + type: boolean + canShare: + description: >- + Output only. Whether the current user can share files or folders + in this shared drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this shared drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `domainUsersOnly` restriction of this shared drive. + type: boolean + canChangeDriveMembersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `driveMembersOnly` restriction of this shared drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + shared drive. + type: boolean + canResetDriveRestrictions: + description: >- + Output only. Whether the current user can reset the shared drive + restrictions to defaults. + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children from + folders in this shared drive. + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children from + folders in this shared drive. + type: boolean + themeId: + description: >- + The ID of the theme from which the background image and color will + be set. The set of possible `driveThemes` can be retrieved from a + `drive.about.get` response. When not specified on a + `drive.drives.insert` request, a random theme is chosen from which + the background image and color are set. This is a write-only field; + it can only be set on requests that don't set `colorRgb` or + `backgroundImageFile`. + type: string + backgroundImageFile: + description: >- + An image file and cropping parameters from which a background image + for this shared drive is set. This is a write only field; it can + only be set on `drive.drives.update` requests that don't set + `themeId`. When specified, all fields of the `backgroundImageFile` + must be set. + type: object + properties: + id: + description: >- + The ID of an image file in Google Drive to use for the + background image. + type: string + xCoordinate: + description: >- + The X coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the horizontal distance from the + left side of the entire image to the left side of the cropping + area divided by the width of the entire image. + type: number + format: float + yCoordinate: + description: >- + The Y coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the vertical distance from the top + side of the entire image to the top side of the cropping area + divided by the height of the entire image. + type: number + format: float + width: + description: >- + The width of the cropped image in the closed range of 0 to 1. + This value represents the width of the cropped image divided by + the width of the entire image. The height is computed by + applying a width to height aspect ratio of 80 to 9. The + resulting image must be at least 1280 pixels wide and 144 pixels + high. + type: number + format: float + createdDate: + description: The time at which the shared drive was created (RFC 3339 date-time). + type: string + format: date-time + hidden: + description: Whether the shared drive is hidden from default view. + type: boolean + restrictions: + description: >- + A set of restrictions that apply to this shared drive or items + inside this shared drive. + type: object + properties: + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download files inside + this shared drive, should be disabled for readers and + commenters. When this restriction is set to `true`, it will + override the similarly named field to `true` for any file inside + this shared drive. + type: boolean + domainUsersOnly: + description: >- + Whether access to this shared drive and items inside this shared + drive is restricted to users of the domain to which this shared + drive belongs. This restriction may be overridden by other + sharing policies controlled outside of this shared drive. + type: boolean + driveMembersOnly: + description: >- + Whether access to items inside this shared drive is restricted + to its members. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this shared drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + If true, only users with the organizer role can share folders. + If false, users with either the organizer role or the file + organizer role can share folders. + type: boolean + orgUnitId: + description: >- + Output only. The organizational unit of this shared drive. This + field is only populated on `drives.list` responses when the + `useDomainAdminAccess` parameter is set to `true`. + type: string + StartPageToken: + id: StartPageToken + type: object + properties: + startPageToken: + description: The starting page token for listing changes. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#startPageToken"`. + default: drive#startPageToken + type: string + ChangeList: + id: ChangeList + description: A list of changes for a user. + type: object + properties: + largestChangeId: + description: The current largest change ID. + type: string + format: int64 + nextPageToken: + description: >- + The page token for the next page of changes. This will be absent if + the end of the changes list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + kind: + description: This is always `drive#changeList`. + default: drive#changeList + type: string + etag: + description: The ETag of the list. + type: string + newStartPageToken: + description: >- + The starting page token for future changes. This will be present + only if the end of the current changes list has been reached. + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of changes. + type: string + items: + description: >- + The list of changes. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Change' + Channel: + id: Channel + description: A notification channel used to watch for resource changes. + type: object + properties: + payload: + description: A Boolean value to indicate whether payload is wanted. Optional. + type: boolean + id: + description: A UUID or similar unique string that identifies this channel. + type: string + resourceId: + description: >- + An opaque ID that identifies the resource being watched on this + channel. Stable across different API versions. + type: string + resourceUri: + description: A version-specific identifier for the watched resource. + type: string + token: + description: >- + An arbitrary string delivered to the target address with each + notification delivered over this channel. Optional. + type: string + expiration: + description: >- + Date and time of notification channel expiration, expressed as a + Unix timestamp, in milliseconds. Optional. + type: string + format: int64 + type: + description: >- + The type of delivery mechanism used for this channel. Valid values + are "web_hook" or "webhook". + type: string + address: + description: The address where notifications are delivered for this channel. + type: string + params: + description: >- + Additional parameters controlling delivery channel behavior. + Optional. + type: object + additionalProperties: + type: string + kind: + description: >- + Identifies this as a notification channel used to watch for changes + to a resource, which is `api#channel`. + default: api#channel + type: string + ChildReference: + id: ChildReference + description: >- + A reference to a folder's child. Some resource methods (such as + `children.get`) require a `childId`. Use the `children.list` method to + retrieve the ID of the child. + type: object + properties: + id: + description: The ID of the child. + annotations: + required: + - drive.children.insert + type: string + selfLink: + description: Output only. A link back to this reference. + type: string + kind: + description: Output only. This is always `drive#childReference`. + default: drive#childReference + type: string + childLink: + description: Output only. A link to the child. + type: string + ChildList: + id: ChildList + description: A list of children of a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of children. This will be absent if + the end of the children list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + kind: + description: This is always `drive#childList`. + default: drive#childList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of children. + type: string + items: + description: >- + The list of children. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/ChildReference' + Comment: + id: Comment + description: >- + A comment on a file in Google Drive. Some resource methods (such as + `comments.update`) require a `commentId`. Use the `comments.list` method + to retrieve the ID for a comment in a file. + type: object + properties: + commentId: + description: Output only. The ID of the comment. + type: string + kind: + description: Output only. This is always `drive#comment`. + default: drive#comment + type: string + createdDate: + description: The date when this comment was first created. + type: string + format: date-time + modifiedDate: + description: The date when this comment or any of its replies were last modified. + type: string + format: date-time + fileId: + description: Output only. The file which this comment is addressing. + type: string + status: + description: >- + Output only. The status of this comment. Status can be changed by + posting a reply to a comment with the desired status. * `open` - The + comment is still open. * `resolved` - The comment has been resolved + by one of its replies. + type: string + anchor: + description: >- + A region of the document represented as a JSON string. For details + on defining anchor properties, refer to [Add comments and + replies](https://developers.google.com/drive/api/v2/manage-comments). + type: string + replies: + description: Output only. Replies to this post. + type: array + items: + $ref: '#/components/schemas/CommentReply' + author: + description: >- + Output only. The author of the comment. The author's email address + and permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether this comment has been deleted. If a comment has + been deleted the content will be cleared and this will only + represent a comment that once existed. + type: boolean + selfLink: + description: Output only. A link back to this comment. + type: string + htmlContent: + description: Output only. HTML formatted content for this comment. + type: string + content: + description: >- + The plain text content used to create this comment. This is not HTML + safe and should only be used as a starting point to make edits to a + comment's content. + annotations: + required: + - drive.comments.insert + - drive.comments.patch + - drive.comments.update + type: string + context: + description: The context of the file which is being commented on. + type: object + properties: + type: + description: The MIME type of the context snippet. + type: string + value: + description: >- + Data representation of the segment of the file being commented + on. In the case of a text file for example, this would be the + actual text that the comment is about. + type: string + fileTitle: + description: Output only. The title of the file which this comment is addressing. + type: string + CommentReply: + id: CommentReply + description: >- + A comment on a file in Google Drive. Some resource methods (such as + `replies.update`) require a `replyId`. Use the `replies.list` method to + retrieve the ID for a reply. + type: object + properties: + replyId: + description: Output only. The ID of the reply. + type: string + kind: + description: Output only. This is always `drive#commentReply`. + default: drive#commentReply + type: string + createdDate: + description: The date when this reply was first created. + type: string + format: date-time + modifiedDate: + description: The date when this reply was last modified. + type: string + format: date-time + verb: + description: >- + The action this reply performed to the parent comment. When creating + a new reply this is the action to be perform to the parent comment. + Possible values are: * `resolve` - To resolve a comment. * `reopen` + - To reopen (un-resolve) a comment. + type: string + author: + description: >- + Output only. The author of the reply. The author's email address and + permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether this reply has been deleted. If a reply has + been deleted the content will be cleared and this will only + represent a reply that once existed. + type: boolean + htmlContent: + description: Output only. HTML formatted content for this reply. + type: string + content: + description: >- + The plain text content used to create this reply. This is not HTML + safe and should only be used as a starting point to make edits to a + reply's content. This field is required on inserts if no verb is + specified (resolve/reopen). + annotations: + required: + - drive.replies.patch + - drive.replies.update + type: string + CommentList: + id: CommentList + description: A list of comments on a file in Google Drive. + type: object + properties: + kind: + description: This is always `drive#commentList`. + default: drive#commentList + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of comments. + type: string + items: + description: >- + The list of comments. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Comment' + nextPageToken: + description: >- + The page token for the next page of comments. This will be absent if + the end of the comments list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + DriveList: + id: DriveList + description: A list of shared drives. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of shared drives. This will be + absent if the end of the list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + kind: + description: This is always `drive#driveList` + default: drive#driveList + type: string + items: + description: >- + The list of shared drives. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Drive' + GeneratedIds: + id: GeneratedIds + description: A list of generated IDs which can be provided in insert requests + type: object + properties: + ids: + description: The IDs generated for the requesting user in the specified space. + type: array + items: + type: string + space: + description: The type of file that can be created with these IDs. + type: string + kind: + description: This is always `drive#generatedIds` + default: drive#generatedIds + type: string + FileList: + id: FileList + description: A list of files. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of files. This will be absent if + the end of the files list has been reached. If the token is rejected + for any reason, it should be discarded, and pagination should be + restarted from the first page of results. + type: string + kind: + description: This is always `drive#fileList`. + default: drive#fileList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + incompleteSearch: + description: >- + Whether the search process was incomplete. If true, then some search + results may be missing, since all documents were not searched. This + may occur when searching multiple drives with the "allDrives" + corpora, but all corpora could not be searched. When this happens, + it is suggested that clients narrow their query by choosing a + different corpus such as "default" or "drive". + type: boolean + nextLink: + description: A link to the next page of files. + type: string + items: + description: >- + The list of files. If nextPageToken is populated, then this list may + be incomplete and an additional page of results should be fetched. + type: array + items: + $ref: '#/components/schemas/File' + LabelList: + id: LabelList + description: A list of labels applied to a file. + type: object + properties: + items: + description: The list of labels. + type: array + items: + $ref: '#/components/schemas/Label' + nextPageToken: + description: >- + The page token for the next page of labels. This field will be + absent if the end of the list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + kind: + description: This is always `drive#labelList` + default: drive#labelList + type: string + ModifyLabelsRequest: + id: ModifyLabelsRequest + description: >- + A request to modify the set of labels on a file. This request may + contain many modifications that will either all succeed or all fail + atomically. + type: object + properties: + labelModifications: + description: The list of modifications to apply to the labels on the file. + type: array + items: + $ref: '#/components/schemas/LabelModification' + kind: + description: This is always `drive#modifyLabelsRequest`. + default: drive#modifyLabelsRequest + type: string + LabelModification: + id: LabelModification + description: >- + A modification to a label on a file. A LabelModification can be used to + apply a label to a file, update an existing label on a file, or remove a + label from a file. + type: object + properties: + labelId: + description: The ID of the label to modify. + annotations: + required: + - drive.files.modifyLabels + type: string + fieldModifications: + description: The list of modifications to this label's fields. + type: array + items: + $ref: '#/components/schemas/LabelFieldModification' + removeLabel: + description: If true, the label will be removed from the file. + type: boolean + kind: + description: This is always `drive#labelModification`. + default: drive#labelModification + type: string + LabelFieldModification: + id: LabelFieldModification + description: A modification to a label's field. + type: object + properties: + fieldId: + description: The ID of the field to be modified. + type: string + kind: + description: This is always `drive#labelFieldModification`. + default: drive#labelFieldModification + type: string + setDateValues: + description: >- + Replaces the value of a dateString Field with these new values. The + string must be in the RFC 3339 full-date format: YYYY-MM-DD. + type: array + items: + type: string + format: date + setTextValues: + description: Sets the value of a `text` field. + type: array + items: + type: string + setSelectionValues: + description: Replaces a `selection` field with these new values. + type: array + items: + type: string + setIntegerValues: + description: Replaces the value of an `integer` field with these new values. + type: array + items: + type: string + format: int64 + setUserValues: + description: >- + Replaces a `user` field with these new values. The values must be + valid email addresses. + type: array + items: + type: string + unsetValues: + description: Unsets the values for this field. + type: boolean + ModifyLabelsResponse: + id: ModifyLabelsResponse + description: >- + Response to a ModifyLabels request. This contains only those labels + which were added or updated by the request. + type: object + properties: + modifiedLabels: + description: The list of labels which were added or updated by the request. + type: array + items: + $ref: '#/components/schemas/Label' + kind: + description: This is always `drive#modifyLabelsResponse` + default: drive#modifyLabelsResponse + type: string + ParentList: + id: ParentList + description: A list of a file's parents. + type: object + properties: + kind: + description: This is always `drive#parentList`. + default: drive#parentList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of parents. + type: array + items: + $ref: '#/components/schemas/ParentReference' + PermissionId: + id: PermissionId + description: An ID for a user or group as seen in Permission items. + type: object + properties: + kind: + description: This is always `drive#permissionId`. + default: drive#permissionId + type: string + id: + description: The permission ID. + type: string + PermissionList: + id: PermissionList + description: A list of permissions associated with a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of permissions. This field will be + absent if the end of the permissions list has been reached. If the + token is rejected for any reason, it should be discarded, and + pagination should be restarted from the first page of results. + type: string + kind: + description: This is always `drive#permissionList`. + default: drive#permissionList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of permissions. + type: array + items: + $ref: '#/components/schemas/Permission' + PropertyList: + id: PropertyList + description: >- + A collection of properties, key-value pairs that are either public or + private to an application. + type: object + properties: + kind: + description: This is always `drive#propertyList`. + default: drive#propertyList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: The link back to this list. + type: string + items: + description: The list of properties. + type: array + items: + $ref: '#/components/schemas/Property' + CommentReplyList: + id: CommentReplyList + description: A list of replies to a comment on a file in Google Drive. + type: object + properties: + kind: + description: This is always `drive#commentReplyList`. + default: drive#commentReplyList + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of replies. + type: string + items: + description: >- + The list of replies. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/CommentReply' + nextPageToken: + description: >- + The page token for the next page of replies. This will be absent if + the end of the replies list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + Revision: + id: Revision + description: >- + A revision of a file. Some resource methods (such as `revisions.update`) + require a `revisionId`. Use the `revisions.list` method to retrieve the + ID for a revision. + type: object + properties: + id: + description: Output only. The ID of the revision. + type: string + mimeType: + description: Output only. The MIME type of the revision. + type: string + kind: + description: Output only. This is always `drive#revision`. + default: drive#revision + type: string + published: + description: >- + Whether this revision is published. This is only populated and can + only be modified for Docs Editors files. + type: boolean + etag: + description: Output only. The ETag of the revision. + type: string + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + type: object + additionalProperties: + type: string + pinned: + description: >- + Whether this revision is pinned to prevent automatic purging. If not + set, the revision is automatically purged 30 days after newer + content is uploaded. This field can only be modified on files with + content stored in Drive, excluding Docs Editors files. Revisions can + also be pinned when they are created through the + drive.files.insert/update/copy by using the pinned query parameter. + Pinned revisions are stored indefinitely using additional storage + quota, up to a maximum of 200 revisions. + type: boolean + md5Checksum: + description: >- + Output only. An MD5 checksum for the content of this revision. This + will only be populated on files with content stored in Drive. + type: string + modifiedDate: + description: Last time this revision was modified (formatted RFC 3339 timestamp). + type: string + format: date-time + lastModifyingUserName: + description: Output only. Name of the last user to modify this revision. + type: string + downloadUrl: + description: >- + Output only. Short term download URL for the file. This will only be + populated on files with content stored in Drive. + type: string + publishAuto: + description: >- + Whether subsequent revisions will be automatically republished. This + is only populated and can only be modified for Docs Editors files. + type: boolean + publishedOutsideDomain: + description: >- + Whether this revision is published outside the domain. This is only + populated and can only be modified for Docs Editors files. + type: boolean + publishedLink: + description: >- + Output only. A link to the published revision. This is only + populated for Google Sites files. + type: string + fileSize: + description: >- + Output only. The size of the revision in bytes. This will only be + populated on files with content stored in Drive. + type: string + format: int64 + originalFilename: + description: >- + Output only. The original filename when this revision was created. + This will only be populated on files with content stored in Drive. + type: string + lastModifyingUser: + description: >- + Output only. The last user to modify this revision. This field is + only populated when the last modification was performed by a + signed-in user. + $ref: '#/components/schemas/User' + selfLink: + description: Output only. A link back to this revision. + type: string + RevisionList: + id: RevisionList + description: A list of revisions of a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of revisions. This field will be + absent if the end of the revisions list has been reached. If the + token is rejected for any reason, it should be discarded and + pagination should be restarted from the first page of results. + type: string + kind: + description: This is always `drive#revisionList`. + default: drive#revisionList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: >- + The list of revisions. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Revision' + TeamDriveList: + id: TeamDriveList + description: A list of Team Drives. + type: object + properties: + nextPageToken: + description: The page token for the next page of Team Drives. + type: string + kind: + description: This is always `drive#teamDriveList` + default: drive#teamDriveList + type: string + items: + description: The list of Team Drives. + type: array + items: + $ref: '#/components/schemas/TeamDrive' + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + about: + id: googleworkspace.drivev2.about + name: about + title: About + methods: + get: + operation: + $ref: '#/paths/~1about/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/about/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + apps: + id: googleworkspace.drivev2.apps + name: apps + title: Apps + methods: + get: + operation: + $ref: '#/paths/~1apps~1{appId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + changes: + id: googleworkspace.drivev2.changes + name: changes + title: Changes + methods: + get: + operation: + $ref: '#/paths/~1changes~1{changeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1changes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + watch: + operation: + $ref: '#/paths/~1changes~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/changes/methods/get' + - $ref: '#/components/x-stackQL-resources/changes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + changes_start_page_token: + id: googleworkspace.drivev2.changes_start_page_token + name: changes_start_page_token + title: Changes_start_page_token + methods: + get_start_page_token: + operation: + $ref: '#/paths/~1changes~1startPageToken/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/changes_start_page_token/methods/get_start_page_token + insert: [] + update: [] + replace: [] + delete: [] + channels: + id: googleworkspace.drivev2.channels + name: channels + title: Channels + methods: + stop: + operation: + $ref: '#/paths/~1channels~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + children: + id: googleworkspace.drivev2.children + name: children + title: Children + methods: + delete: + operation: + $ref: '#/paths/~1files~1{folderId}~1children~1{childId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{folderId}~1children~1{childId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{folderId}~1children/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{folderId}~1children/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/children/methods/get' + - $ref: '#/components/x-stackQL-resources/children/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/children/methods/insert' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/children/methods/delete' + comments: + id: googleworkspace.drivev2.comments + name: comments + title: Comments + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/get' + - $ref: '#/components/x-stackQL-resources/comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/comments/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/comments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/comments/methods/delete' + drives: + id: googleworkspace.drivev2.drives + name: drives + title: Drives + methods: + delete: + operation: + $ref: '#/paths/~1drives~1{driveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1drives~1{driveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1drives~1{driveId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + hide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1hide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1drives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1drives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + unhide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1unhide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drives/methods/get' + - $ref: '#/components/x-stackQL-resources/drives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drives/methods/insert' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/drives/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/drives/methods/delete' + files: + id: googleworkspace.drivev2.files + name: files + title: Files + methods: + copy: + operation: + $ref: '#/paths/~1files~1{fileId}~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1files~1{fileId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + empty_trash: + operation: + $ref: '#/paths/~1files~1trash/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: '#/paths/~1files~1{fileId}~1export/get' + response: + mediaType: application/json + openAPIDocKey: '200' + generate_ids: + operation: + $ref: '#/paths/~1files~1generateIds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + modify_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1modifyLabels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + touch: + operation: + $ref: '#/paths/~1files~1{fileId}~1touch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + trash: + operation: + $ref: '#/paths/~1files~1{fileId}~1trash/post' + response: + mediaType: application/json + openAPIDocKey: '200' + untrash: + operation: + $ref: '#/paths/~1files~1{fileId}~1untrash/post' + response: + mediaType: application/json + openAPIDocKey: '200' + watch: + operation: + $ref: '#/paths/~1files~1{fileId}~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/get' + - $ref: '#/components/x-stackQL-resources/files/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/files/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/files/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/files/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/files/methods/delete' + files_labels: + id: googleworkspace.drivev2.files_labels + name: files_labels + title: Files_labels + methods: + list_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1listLabels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files_labels/methods/list_labels' + insert: [] + update: [] + replace: [] + delete: [] + parents: + id: googleworkspace.drivev2.parents + name: parents + title: Parents + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents~1{parentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents~1{parentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/parents/methods/get' + - $ref: '#/components/x-stackQL-resources/parents/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/parents/methods/insert' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/parents/methods/delete' + permissions: + id: googleworkspace.drivev2.permissions + name: permissions + title: Permissions + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + permissions_id_for_email: + id: googleworkspace.drivev2.permissions_id_for_email + name: permissions_id_for_email + title: Permissions_id_for_email + methods: + get_id_for_email: + operation: + $ref: '#/paths/~1permissionIds~1{email}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/permissions_id_for_email/methods/get_id_for_email + insert: [] + update: [] + replace: [] + delete: [] + properties: + id: googleworkspace.drivev2.properties + name: properties + title: Properties + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/properties/methods/get' + - $ref: '#/components/x-stackQL-resources/properties/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/properties/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/properties/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/properties/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/properties/methods/delete' + replies: + id: googleworkspace.drivev2.replies + name: replies + title: Replies + methods: + delete: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/replies/methods/get' + - $ref: '#/components/x-stackQL-resources/replies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/replies/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/replies/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/replies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/replies/methods/delete' + revisions: + id: googleworkspace.drivev2.revisions + name: revisions + title: Revisions + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/revisions/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/revisions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' + teamdrives: + id: googleworkspace.drivev2.teamdrives + name: teamdrives + title: Teamdrives + methods: + delete: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1teamdrives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1teamdrives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/get' + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/insert' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/delete' +paths: + /about: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Gets the information about the current user along with Drive API + settings + operationId: drive.about.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/About' + parameters: + - in: query + name: includeSubscribed + schema: + type: boolean + - in: query + name: maxChangeIdCount + schema: + type: string + format: int64 + - in: query + name: startChangeId + schema: + type: string + format: int64 + /apps/{appId}: + parameters: *ref_1 + get: + description: Gets a specific app. + operationId: drive.apps.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/App' + parameters: + - in: path + name: appId + required: true + schema: + type: string + /apps: + parameters: *ref_1 + get: + description: Lists a user's installed apps. + operationId: drive.apps.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AppList' + parameters: + - in: query + name: appFilterExtensions + schema: + type: string + - in: query + name: appFilterMimeTypes + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /changes/{changeId}: + parameters: *ref_1 + get: + description: >- + Deprecated: Use `changes.getStartPageToken` and `changes.list` to + retrieve recent changes. + operationId: drive.changes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Change' + parameters: + - in: path + name: changeId + required: true + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + /changes/startPageToken: + parameters: *ref_1 + get: + description: Gets the starting pageToken for listing future changes. + operationId: drive.changes.getStartPageToken + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StartPageToken' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + /changes: + parameters: *ref_1 + get: + description: Lists the changes for a user or shared drive. + operationId: drive.changes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeList' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeSubscribed + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: startChangeId + schema: + type: string + format: int64 + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /changes/watch: + parameters: *ref_1 + post: + description: Subscribe to changes for a user. + operationId: drive.changes.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeSubscribed + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: startChangeId + schema: + type: string + format: int64 + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /channels/stop: + parameters: *ref_1 + post: + description: Stops watching resources through this channel. + operationId: drive.channels.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: [] + /files/{folderId}/children/{childId}: + parameters: *ref_1 + delete: + description: Removes a child from a folder. + operationId: drive.children.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: path + name: childId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: Gets a specific child reference. + operationId: drive.children.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChildReference' + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: path + name: childId + required: true + schema: + type: string + /files/{folderId}/children: + parameters: *ref_1 + post: + description: Inserts a file into a folder. + operationId: drive.children.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChildReference' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChildReference' + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + get: + description: Lists a folder's children. + operationId: drive.children.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChildList' + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + /files/{fileId}/comments/{commentId}: + parameters: *ref_1 + delete: + description: Deletes a comment. + operationId: drive.comments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Gets a comment by ID. + operationId: drive.comments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates an existing comment. + operationId: drive.comments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + put: + description: Updates an existing comment. + operationId: drive.comments.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + /files/{fileId}/comments: + parameters: *ref_1 + post: + description: Creates a new comment on the given file. + operationId: drive.comments.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + get: + description: Lists a file's comments. + operationId: drive.comments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: updatedMin + schema: + type: string + /drives/{driveId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a shared drive for which the user is an `organizer`. + The shared drive cannot contain any untrashed items. + operationId: drive.drives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: allowItemDeletion + schema: + type: boolean + get: + description: Gets a shared drive's metadata by ID. + operationId: drive.drives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + put: + description: Updates the metadata for a shared drive. + operationId: drive.drives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}/hide: + parameters: *ref_1 + post: + description: Hides a shared drive from the default view. + operationId: drive.drives.hide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /drives: + parameters: *ref_1 + post: + description: Creates a new shared drive. + operationId: drive.drives.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: ' Lists the user''s shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.' + operationId: drive.drives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DriveList' + parameters: + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}/unhide: + parameters: *ref_1 + post: + description: Restores a shared drive to the default view. + operationId: drive.drives.unhide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /files/{fileId}/copy: + parameters: *ref_1 + post: + description: Creates a copy of the specified file. + operationId: drive.files.copy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: visibility + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file owned by the user without moving it to the + trash. If the file belongs to a shared drive, the user must be an + `organizer` on the parent folder. If the target is a folder, all + descendants owned by the user are also deleted. + operationId: drive.files.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: ' Gets a file''s metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).' + operationId: drive.files.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: projection + schema: + type: string + - in: query + name: revisionId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + patch: + description: >- + Updates a file's metadata and/or content. When calling this method, only + populate fields in the request that you want to modify. When updating + fields, some fields might change automatically, such as modifiedDate. + This method supports patch semantics. + operationId: drive.files.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.scripts + Oauth2c: + - https://www.googleapis.com/auth/drive.scripts + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: addParents + schema: + type: string + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: modifiedDateBehavior + schema: + type: string + - in: query + name: newRevision + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: removeParents + schema: + type: string + - in: query + name: setModifiedDate + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + put: + description: ' Updates a file''s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).' + operationId: drive.files.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.scripts + Oauth2c: + - https://www.googleapis.com/auth/drive.scripts + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: addParents + schema: + type: string + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: modifiedDateBehavior + schema: + type: string + - in: query + name: newRevision + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: removeParents + schema: + type: string + - in: query + name: setModifiedDate + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/trash: + parameters: *ref_1 + delete: + description: Permanently deletes all of the user's trashed files. + operationId: drive.files.emptyTrash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: driveId + schema: + type: string + /files/{fileId}/export: + parameters: *ref_1 + get: + description: >- + Exports a Google Workspace document to the requested MIME type and + returns exported byte content. Note that the exported content is limited + to 10MB. + operationId: drive.files.export + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: mimeType + required: true + schema: + type: string + /files/generateIds: + parameters: *ref_1 + get: + description: >- + Generates a set of file IDs which can be provided in insert or copy + requests. + operationId: drive.files.generateIds + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GeneratedIds' + parameters: + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: space + schema: + type: string + - in: query + name: type + schema: + type: string + /files: + parameters: *ref_1 + post: + description: ' Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file''s MIME type.' + operationId: drive.files.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: visibility + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + get: + description: ' Lists the user''s files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don''t want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.' + operationId: drive.files.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FileList' + parameters: + - in: query + name: corpora + schema: + type: string + - in: query + name: corpus + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: projection + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/listLabels: + parameters: *ref_1 + get: + description: Lists the labels on a file. + operationId: drive.files.listLabels + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LabelList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/modifyLabels: + parameters: *ref_1 + post: + description: >- + Modifies the set of labels applied to a file. Returns a list of the + labels that were added or modified. + operationId: drive.files.modifyLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsResponse' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/touch: + parameters: *ref_1 + post: + description: Set the file's updated time to the current server time. + operationId: drive.files.touch + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/trash: + parameters: *ref_1 + post: + description: >- + Moves a file to the trash. The currently authenticated user must own the + file or be at least a `fileOrganizer` on the parent for shared drive + files. + operationId: drive.files.trash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/untrash: + parameters: *ref_1 + post: + description: >- + Restores a file from the trash. The currently authenticated user must + own the file or be at least a `fileOrganizer` on the parent for shared + drive files. + operationId: drive.files.untrash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/watch: + parameters: *ref_1 + post: + description: Subscribes to changes to a file. + operationId: drive.files.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: revisionId + schema: + type: string + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: projection + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/parents/{parentId}: + parameters: *ref_1 + delete: + description: Removes a parent from a file. + operationId: drive.parents.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: parentId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: Gets a specific parent reference. + operationId: drive.parents.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParentReference' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: parentId + required: true + schema: + type: string + /files/{fileId}/parents: + parameters: *ref_1 + post: + description: Adds a parent folder for a file. + operationId: drive.parents.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ParentReference' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParentReference' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + get: + description: Lists a file's parents. + operationId: drive.parents.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParentList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/permissions/{permissionId}: + parameters: *ref_1 + delete: + description: >- + Deletes a permission from a file or shared drive. **Warning:** + Concurrent permissions operations on the same file are not supported; + only the last update is applied. + operationId: drive.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Gets a permission by ID. + operationId: drive.permissions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: >- + Updates a permission using patch semantics. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: removeExpiration + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + put: + description: >- + Updates a permission. **Warning:** Concurrent permissions operations on + the same file are not supported; only the last update is applied. + operationId: drive.permissions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: removeExpiration + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /permissionIds/{email}: + parameters: *ref_1 + get: + description: Returns the permission ID for an email address. + operationId: drive.permissions.getIdForEmail + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionId' + parameters: + - in: path + name: email + required: true + schema: + type: string + /files/{fileId}/permissions: + parameters: *ref_1 + post: + description: >- + Inserts a permission for a file or shared drive. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: emailMessage + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: moveToNewOwnersRoot + schema: + type: boolean + - in: query + name: sendNotificationEmails + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Lists a file's or shared drive's permissions. + operationId: drive.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + /files/{fileId}/properties/{propertyKey}: + parameters: *ref_1 + delete: + description: Deletes a property. + operationId: drive.properties.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + get: + description: Gets a property by its key. + operationId: drive.properties.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + patch: + description: Updates a property. + operationId: drive.properties.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + put: + description: Updates a property. + operationId: drive.properties.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + /files/{fileId}/properties: + parameters: *ref_1 + post: + description: Adds a property to a file, or updates it if it already exists. + operationId: drive.properties.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + get: + description: Lists a file's properties. + operationId: drive.properties.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PropertyList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/comments/{commentId}/replies/{replyId}: + parameters: *ref_1 + delete: + description: Deletes a reply. + operationId: drive.replies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + get: + description: Gets a reply. + operationId: drive.replies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates an existing reply. + operationId: drive.replies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + put: + description: Updates an existing reply. + operationId: drive.replies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + /files/{fileId}/comments/{commentId}/replies: + parameters: *ref_1 + post: + description: Creates a new reply to the given comment. + operationId: drive.replies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Lists all of the replies to a comment. + operationId: drive.replies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReplyList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/revisions/{revisionId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file version. You can only delete revisions for + files with binary content, like images or videos. Revisions for other + files, like Google Docs or Sheets, and the last remaining file version + can't be deleted. + operationId: drive.revisions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + get: + description: Gets a specific revision. + operationId: drive.revisions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + patch: + description: Updates a revision. + operationId: drive.revisions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + put: + description: Updates a revision. + operationId: drive.revisions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + /files/{fileId}/revisions: + parameters: *ref_1 + get: + description: Lists a file's revisions. + operationId: drive.revisions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RevisionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /teamdrives/{teamDriveId}: + parameters: *ref_1 + delete: + description: 'Deprecated: Use `drives.delete` instead.' + operationId: drive.teamdrives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.get` instead.' + operationId: drive.teamdrives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + put: + description: 'Deprecated: Use `drives.update` instead.' + operationId: drive.teamdrives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /teamdrives: + parameters: *ref_1 + post: + description: 'Deprecated: Use `drives.insert` instead.' + operationId: drive.teamdrives.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.list` instead.' + operationId: drive.teamdrives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDriveList' + parameters: + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivev3.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivev3.yaml new file mode 100644 index 00000000..3c2a93f7 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivev3.yaml @@ -0,0 +1,6115 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Google Drive API + description: The Google Drive API allows clients to access resources from Google Drive. + version: v3 + x-discovery-doc-revision: '20241202' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/ +servers: + - url: https://www.googleapis.com/drive/v3 +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive: See, edit, create, and delete all of your Google Drive files + https://www.googleapis.com/auth/drive.appdata: >- + See, create, and delete its own configuration data in your Google + Drive + https://www.googleapis.com/auth/drive.apps.readonly: View your Google Drive apps + https://www.googleapis.com/auth/drive.file: >- + See, edit, create, and delete only the specific Google Drive files + you use with this app + https://www.googleapis.com/auth/drive.meet.readonly: >- + See and download your Google Drive files that were created or + edited by Google Meet. + https://www.googleapis.com/auth/drive.metadata: View and manage metadata of files in your Google Drive + https://www.googleapis.com/auth/drive.metadata.readonly: See information about your Google Drive files + https://www.googleapis.com/auth/drive.photos.readonly: View the photos, videos and albums in your Google Photos + https://www.googleapis.com/auth/drive.readonly: See and download all your Google Drive files + https://www.googleapis.com/auth/drive.scripts: Modify your Google Apps Script scripts' behavior + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + About: + id: About + description: Information about the user, the user's Drive, and system capabilities. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#about"`. + default: drive#about + type: string + storageQuota: + description: >- + The user's storage quota limits and usage. For users that are part + of an organization with pooled storage, information about the limit + and usage across all services is for the organization, rather than + the individual user. All fields are measured in bytes. + type: object + properties: + limit: + description: >- + The usage limit, if applicable. This will not be present if the + user has unlimited storage. For users that are part of an + organization with pooled storage, this is the limit for the + organization, rather than the individual user. + type: string + format: int64 + usageInDrive: + description: The usage by all files in Google Drive. + type: string + format: int64 + usageInDriveTrash: + description: The usage by trashed files in Google Drive. + type: string + format: int64 + usage: + description: >- + The total usage across all services. For users that are part of + an organization with pooled storage, this is the usage across + all services for the organization, rather than the individual + user. + type: string + format: int64 + driveThemes: + description: A list of themes that are supported for shared drives. + type: array + items: + type: object + properties: + id: + description: The ID of the theme. + type: string + backgroundImageLink: + description: A link to this theme's background image. + type: string + colorRgb: + description: The color of this theme as an RGB hex string. + type: string + canCreateDrives: + description: Whether the user can create shared drives. + type: boolean + importFormats: + description: >- + A map of source MIME type to possible targets for all supported + imports. + type: object + additionalProperties: + type: array + items: + type: string + exportFormats: + description: >- + A map of source MIME type to possible targets for all supported + exports. + type: object + additionalProperties: + type: array + items: + type: string + appInstalled: + description: Whether the user has installed the requesting app. + type: boolean + user: + description: The authenticated user. + $ref: '#/components/schemas/User' + folderColorPalette: + description: The currently supported folder colors as RGB hex strings. + type: array + items: + type: string + maxImportSizes: + description: A map of maximum import sizes by MIME type, in bytes. + type: object + additionalProperties: + type: string + format: int64 + maxUploadSize: + description: The maximum upload size in bytes. + type: string + format: int64 + teamDriveThemes: + description: 'Deprecated: Use `driveThemes` instead.' + deprecated: true + type: array + items: + type: object + properties: + id: + description: 'Deprecated: Use `driveThemes/id` instead.' + deprecated: true + type: string + backgroundImageLink: + description: 'Deprecated: Use `driveThemes/backgroundImageLink` instead.' + deprecated: true + type: string + colorRgb: + description: 'Deprecated: Use `driveThemes/colorRgb` instead.' + deprecated: true + type: string + canCreateTeamDrives: + description: 'Deprecated: Use `canCreateDrives` instead.' + deprecated: true + type: boolean + User: + id: User + description: Information about a Drive user. + type: object + properties: + displayName: + description: Output only. A plain text displayable name for this user. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#user"`. + default: drive#user + type: string + me: + description: Output only. Whether this user is the requesting user. + type: boolean + permissionId: + description: Output only. The user's ID as visible in Permission resources. + type: string + emailAddress: + description: >- + Output only. The email address of the user. This may not be present + in certain contexts if the user has not made their email address + visible to the requester. + type: string + photoLink: + description: Output only. A link to the user's profile photo, if available. + type: string + App: + id: App + description: >- + The `apps` resource provides a list of apps that a user has installed, + with information about each app's supported MIME types, file extensions, + and other details. Some resource methods (such as `apps.get`) require an + `appId`. Use the `apps.list` method to retrieve the ID for an installed + application. + type: object + properties: + name: + description: The name of the app. + type: string + objectType: + description: >- + The type of object this app creates such as a Chart. If empty, the + app name should be used instead. + type: string + supportsCreate: + description: Whether this app supports creating objects. + type: boolean + productUrl: + description: A link to the product listing for this app. + type: string + primaryMimeTypes: + description: The list of primary MIME types. + type: array + items: + type: string + secondaryMimeTypes: + description: The list of secondary MIME types. + type: array + items: + type: string + primaryFileExtensions: + description: The list of primary file extensions. + type: array + items: + type: string + secondaryFileExtensions: + description: The list of secondary file extensions. + type: array + items: + type: string + id: + description: The ID of the app. + type: string + supportsImport: + description: Whether this app supports importing from Google Docs. + type: boolean + installed: + description: Whether the app is installed. + type: boolean + authorized: + description: Whether the app is authorized to access data on the user's Drive. + type: boolean + icons: + description: The various icons for the app. + type: array + items: + $ref: '#/components/schemas/AppIcons' + useByDefault: + description: >- + Whether the app is selected as the default handler for the types it + supports. + type: boolean + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string "drive#app". + default: drive#app + type: string + shortDescription: + description: A short description of the app. + type: string + longDescription: + description: A long description of the app. + type: string + supportsMultiOpen: + description: Whether this app supports opening more than one file. + type: boolean + productId: + description: The ID of the product listing for this app. + type: string + openUrlTemplate: + description: >- + The template URL for opening files with this app. The template + contains {ids} or {exportIds} to be replaced by the actual file IDs. + For more information, see Open Files for the full documentation. + type: string + createUrl: + description: The URL to create a file with this app. + type: string + createInFolderTemplate: + description: >- + The template URL to create a file with this app in a given folder. + The template contains the {folderId} to be replaced by the folder ID + house the new file. + type: string + supportsOfflineCreate: + description: Whether this app supports creating files when offline. + type: boolean + hasDriveWideScope: + description: >- + Whether the app has Drive-wide scope. An app with Drive-wide scope + can access all files in the user's Drive. + type: boolean + AppIcons: + id: AppIcons + type: object + properties: + size: + description: >- + Size of the icon. Represented as the maximum of the width and + height. + type: integer + format: int32 + category: + description: >- + Category of the icon. Allowed values are: * `application` - The icon + for the application. * `document` - The icon for a file associated + with the app. * `documentShared` - The icon for a shared file + associated with the app. + type: string + iconUrl: + description: URL for the icon. + type: string + AppList: + id: AppList + description: >- + A list of third-party applications which the user has installed or given + access to Google Drive. + type: object + properties: + defaultAppIds: + description: >- + The list of app IDs that the user has specified to use by default. + The list is in reverse-priority order (lowest to highest). + type: array + items: + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string "drive#appList". + default: drive#appList + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of apps. + type: array + items: + $ref: '#/components/schemas/App' + StartPageToken: + id: StartPageToken + type: object + properties: + startPageToken: + description: >- + The starting page token for listing future changes. The page token + doesn't expire. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#startPageToken"`. + default: drive#startPageToken + type: string + ChangeList: + id: ChangeList + description: A list of changes for a user. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#changeList"`. + default: drive#changeList + type: string + nextPageToken: + description: >- + The page token for the next page of changes. This will be absent if + the end of the changes list has been reached. The page token doesn't + expire. + type: string + newStartPageToken: + description: >- + The starting page token for future changes. This will be present + only if the end of the current changes list has been reached. The + page token doesn't expire. + type: string + changes: + description: >- + The list of changes. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Change' + Change: + id: Change + description: A change to a file or shared drive. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#change"`. + default: drive#change + type: string + removed: + description: >- + Whether the file or shared drive has been removed from this list of + changes, for example by deletion or loss of access. + type: boolean + file: + description: >- + The updated state of the file. Present if the type is file and the + file has not been removed from this list of changes. + $ref: '#/components/schemas/File' + fileId: + description: The ID of the file which has changed. + type: string + time: + description: The time of this change (RFC 3339 date-time). + type: string + format: date-time + driveId: + description: The ID of the shared drive associated with this change. + type: string + type: + description: 'Deprecated: Use `changeType` instead.' + deprecated: true + type: string + teamDriveId: + description: 'Deprecated: Use `driveId` instead.' + deprecated: true + type: string + teamDrive: + description: 'Deprecated: Use `drive` instead.' + deprecated: true + $ref: '#/components/schemas/TeamDrive' + changeType: + description: The type of the change. Possible values are `file` and `drive`. + type: string + drive: + description: >- + The updated state of the shared drive. Present if the changeType is + drive, the user is still a member of the shared drive, and the + shared drive has not been deleted. + $ref: '#/components/schemas/Drive' + File: + id: File + description: >- + The metadata for a file. Some resource methods (such as `files.update`) + require a `fileId`. Use the `files.list` method to retrieve the ID for a + file. + type: object + properties: + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#file"`. + default: drive#file + type: string + driveId: + description: >- + Output only. ID of the shared drive the file resides in. Only + populated for items in shared drives. + type: string + fileExtension: + description: >- + Output only. The final component of `fullFileExtension`. This is + only available for files with binary content in Google Drive. + type: string + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download this file, should be + disabled for readers and commenters. + type: boolean + md5Checksum: + description: >- + Output only. The MD5 checksum for the content of the file. This is + only applicable to files with binary content in Google Drive. + type: string + contentHints: + description: >- + Additional information about the content of the file. These fields + are never populated in responses. + type: object + properties: + indexableText: + description: >- + Text to be indexed for the file to improve fullText queries. + This is limited to 128KB in length and may contain HTML + elements. + type: string + thumbnail: + description: >- + A thumbnail for the file. This will only be used if Google Drive + cannot generate a standard thumbnail. + type: object + properties: + image: + description: >- + The thumbnail data encoded with URL-safe Base64 (RFC 4648 + section 5). + type: string + format: byte + mimeType: + description: The MIME type of the thumbnail. + type: string + writersCanShare: + description: >- + Whether users with only `writer` permission can modify the file's + permissions. Not populated for items in shared drives. + type: boolean + viewedByMe: + description: Output only. Whether the file has been viewed by this user. + type: boolean + mimeType: + description: >- + The MIME type of the file. Google Drive attempts to automatically + detect an appropriate value from uploaded content, if no value is + provided. The value cannot be changed unless a new revision is + uploaded. If a file is created with a Google Doc MIME type, the + uploaded content is imported, if possible. The supported import + formats are published in the About resource. + type: string + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + readOnly: true + type: object + additionalProperties: + type: string + parents: + description: >- + The ID of the parent folder containing the file. A file can only + have one parent folder; specifying multiple parents isn't supported. + If not specified as part of a create request, the file is placed + directly in the user's My Drive folder. If not specified as part of + a copy request, the file inherits any discoverable parent of the + source file. Update requests must use the `addParents` and + `removeParents` parameters to modify the parents list. + type: array + items: + type: string + thumbnailLink: + description: >- + Output only. A short-lived link to the file's thumbnail, if + available. Typically lasts on the order of hours. Not intended for + direct usage on web applications due to [Cross-Origin Resource + Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + policies, consider using a proxy server. Only populated when the + requesting app can access the file's content. If the file isn't + shared publicly, the URL returned in `Files.thumbnailLink` must be + fetched using a credentialed request. + type: string + iconLink: + description: Output only. A static, unauthenticated link to the file's icon. + type: string + shared: + description: >- + Output only. Whether the file has been shared. Not populated for + items in shared drives. + type: boolean + lastModifyingUser: + description: >- + Output only. The last user to modify the file. This field is only + populated when the last modification was performed by a signed-in + user. + $ref: '#/components/schemas/User' + owners: + description: >- + Output only. The owner of this file. Only certain legacy files may + have more than one owner. This field isn't populated for items in + shared drives. + type: array + items: + $ref: '#/components/schemas/User' + headRevisionId: + description: >- + Output only. The ID of the file's head revision. This is currently + only available for files with binary content in Google Drive. + type: string + sharingUser: + description: >- + Output only. The user who shared the file with the requesting user, + if applicable. + $ref: '#/components/schemas/User' + webViewLink: + description: >- + Output only. A link for opening the file in a relevant Google editor + or viewer in a browser. + type: string + webContentLink: + description: >- + Output only. A link for downloading the content of the file in a + browser. This is only available for files with binary content in + Google Drive. + type: string + size: + description: >- + Output only. Size in bytes of blobs and first party editor files. + Won't be populated for files that have no size, like shortcuts and + folders. + type: string + format: int64 + viewersCanCopyContent: + description: 'Deprecated: Use `copyRequiresWriterPermission` instead.' + deprecated: true + type: boolean + permissions: + description: >- + Output only. The full list of permissions for the file. This is only + available if the requesting user can share the file. Not populated + for items in shared drives. + type: array + items: + $ref: '#/components/schemas/Permission' + hasThumbnail: + description: >- + Output only. Whether this file has a thumbnail. This does not + indicate whether the requesting app has access to the thumbnail. To + check access, look for the presence of the thumbnailLink field. + type: boolean + spaces: + description: >- + Output only. The list of spaces which contain the file. The + currently supported values are 'drive', 'appDataFolder' and + 'photos'. + type: array + items: + type: string + folderColorRgb: + description: >- + The color for a folder or a shortcut to a folder as an RGB hex + string. The supported colors are published in the + `folderColorPalette` field of the About resource. If an unsupported + color is specified, the closest color in the palette is used + instead. + type: string + id: + description: The ID of the file. + type: string + name: + description: >- + The name of the file. This is not necessarily unique within a + folder. Note that for immutable items such as the top level folders + of shared drives, My Drive root folder, and Application Data folder + the name is constant. + type: string + description: + description: A short description of the file. + type: string + starred: + description: Whether the user has starred the file. + type: boolean + trashed: + description: >- + Whether the file has been trashed, either explicitly or from a + trashed parent folder. Only the owner may trash a file, and other + users cannot see files in the owner's trash. + type: boolean + explicitlyTrashed: + description: >- + Output only. Whether the file has been explicitly trashed, as + opposed to recursively trashed from a parent folder. + type: boolean + createdTime: + description: The time at which the file was created (RFC 3339 date-time). + type: string + format: date-time + modifiedTime: + description: >- + he last time the file was modified by anyone (RFC 3339 date-time). + Note that setting modifiedTime will also update modifiedByMeTime for + the user. + type: string + format: date-time + modifiedByMeTime: + description: >- + The last time the file was modified by the user (RFC 3339 + date-time). + type: string + format: date-time + viewedByMeTime: + description: The last time the file was viewed by the user (RFC 3339 date-time). + type: string + format: date-time + sharedWithMeTime: + description: >- + The time at which the file was shared with the user, if applicable + (RFC 3339 date-time). + type: string + format: date-time + quotaBytesUsed: + description: >- + Output only. The number of storage quota bytes used by the file. + This includes the head revision as well as previous revisions with + `keepForever` enabled. + type: string + format: int64 + version: + description: >- + Output only. A monotonically increasing version number for the file. + This reflects every change made to the file on the server, even + those not visible to the user. + type: string + format: int64 + originalFilename: + description: >- + The original filename of the uploaded content if available, or else + the original value of the `name` field. This is only available for + files with binary content in Google Drive. + type: string + ownedByMe: + description: >- + Output only. Whether the user owns the file. Not populated for items + in shared drives. + type: boolean + fullFileExtension: + description: >- + Output only. The full file extension extracted from the `name` + field. May contain multiple concatenated extensions, such as + "tar.gz". This is only available for files with binary content in + Google Drive. This is automatically updated when the `name` field + changes, however it is not cleared if the new name does not contain + a valid extension. + type: string + properties: + description: >- + A collection of arbitrary key-value pairs which are visible to all + apps. + + Entries with null values are cleared in update and copy requests. + type: object + additionalProperties: + type: string + appProperties: + description: >- + A collection of arbitrary key-value pairs which are private to the + requesting app. + + Entries with null values are cleared in update and copy requests. + These properties can only be retrieved using an authenticated + request. An authenticated request uses an access token obtained with + a OAuth 2 client ID. You cannot use an API key to retrieve private + properties. + type: object + additionalProperties: + type: string + isAppAuthorized: + description: >- + Output only. Whether the file was created or opened by the + requesting app. + type: boolean + teamDriveId: + description: 'Deprecated: Output only. Use `driveId` instead.' + deprecated: true + type: string + capabilities: + description: >- + Output only. Capabilities the current user has on this file. Each + capability corresponds to a fine-grained action that a user may + take. + type: object + properties: + canChangeViewersCanCopyContent: + description: 'Deprecated: Output only.' + deprecated: true + type: boolean + canMoveChildrenOutOfDrive: + description: >- + Output only. Whether the current user can move children of this + folder outside of the shared drive. This is false when the item + is not a folder. Only populated for items in shared drives. + type: boolean + canReadDrive: + description: >- + Output only. Whether the current user can read the shared drive + to which this file belongs. Only populated for items in shared + drives. + type: boolean + canEdit: + description: >- + Output only. Whether the current user can edit this file. Other + factors may limit the type of changes a user can make to a file. + For example, see `canChangeCopyRequiresWriterPermission` or + `canModifyContent`. + type: boolean + canCopy: + description: >- + Output only. Whether the current user can copy this file. For an + item in a shared drive, whether the current user can copy + non-folder descendants of this item, or this item itself if it + is not a folder. + type: boolean + canComment: + description: Output only. Whether the current user can comment on this file. + type: boolean + canAddChildren: + description: >- + Output only. Whether the current user can add children to this + folder. This is always false when the item is not a folder. + type: boolean + canDelete: + description: Output only. Whether the current user can delete this file. + type: boolean + canDownload: + description: Output only. Whether the current user can download this file. + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + this folder. This is always false when the item is not a folder. + type: boolean + canRemoveChildren: + description: >- + Output only. Whether the current user can remove children from + this folder. This is always false when the item is not a folder. + For a folder in a shared drive, use `canDeleteChildren` or + `canTrashChildren` instead. + type: boolean + canRename: + description: Output only. Whether the current user can rename this file. + type: boolean + canTrash: + description: >- + Output only. Whether the current user can move this file to + trash. + type: boolean + canReadRevisions: + description: >- + Output only. Whether the current user can read the revisions + resource of this file. For a shared drive item, whether + revisions of non-folder descendants of this item, or this item + itself if it is not a folder, can be read. + type: boolean + canReadTeamDrive: + description: 'Deprecated: Output only. Use `canReadDrive` instead.' + deprecated: true + type: boolean + canMoveTeamDriveItem: + description: >- + Deprecated: Output only. Use `canMoveItemWithinDrive` or + `canMoveItemOutOfDrive` instead. + deprecated: true + type: boolean + canChangeCopyRequiresWriterPermission: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this file. + type: boolean + canMoveItemIntoTeamDrive: + description: 'Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canUntrash: + description: >- + Output only. Whether the current user can restore this file from + trash. + type: boolean + canModifyContent: + description: >- + Output only. Whether the current user can modify the content of + this file. + type: boolean + canMoveItemWithinTeamDrive: + description: 'Deprecated: Output only. Use `canMoveItemWithinDrive` instead.' + deprecated: true + type: boolean + canMoveItemOutOfTeamDrive: + description: 'Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children of + this folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveChildrenOutOfTeamDrive: + description: >- + Deprecated: Output only. Use `canMoveChildrenOutOfDrive` + instead. + deprecated: true + type: boolean + canMoveChildrenWithinTeamDrive: + description: >- + Deprecated: Output only. Use `canMoveChildrenWithinDrive` + instead. + deprecated: true + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children of this + folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveItemOutOfDrive: + description: >- + Output only. Whether the current user can move this item outside + of this drive by changing its parent. Note that a request to + change the parent of the item may still fail depending on the + new parent that is being added. + type: boolean + canAddMyDriveParent: + description: >- + Output only. Whether the current user can add a parent for the + item without removing an existing parent in the same request. + Not populated for shared drive files. + type: boolean + canRemoveMyDriveParent: + description: >- + Output only. Whether the current user can remove a parent from + the item without adding another parent in the same request. Not + populated for shared drive files. + type: boolean + canMoveItemWithinDrive: + description: >- + Output only. Whether the current user can move this item within + this drive. Note that a request to change the parent of the item + may still fail depending on the new parent that is being added + and the parent that is being removed. + type: boolean + canShare: + description: >- + Output only. Whether the current user can modify the sharing + settings for this file. + type: boolean + canMoveChildrenWithinDrive: + description: >- + Output only. Whether the current user can move children of this + folder within this drive. This is false when the item is not a + folder. Note that a request to move the child may still fail + depending on the current user's access to the child and to the + destination folder. + type: boolean + canModifyContentRestriction: + description: >- + Deprecated: Output only. Use one of + `canModifyEditorContentRestriction`, + `canModifyOwnerContentRestriction` or + `canRemoveContentRestriction`. + deprecated: true + type: boolean + canAddFolderFromAnotherDrive: + description: >- + Output only. Whether the current user can add a folder from + another drive (different shared drive or My Drive) to this + folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canChangeSecurityUpdateEnabled: + description: >- + Output only. Whether the current user can change the + securityUpdateEnabled field on link share metadata. + type: boolean + canAcceptOwnership: + description: >- + Output only. Whether the current user is the pending owner of + the file. Not populated for shared drive files. + type: boolean + canReadLabels: + description: >- + Output only. Whether the current user can read the labels on the + file. + type: boolean + canModifyLabels: + description: >- + Output only. Whether the current user can modify the labels on + the file. + type: boolean + canModifyEditorContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions on the file which are editor restricted. + type: boolean + canModifyOwnerContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions which are owner restricted. + type: boolean + canRemoveContentRestriction: + description: >- + Output only. Whether there is a content restriction on the file + that can be removed by the current user. + type: boolean + hasAugmentedPermissions: + description: >- + Output only. Whether there are permissions directly on this file. + This field is only populated for items in shared drives. + type: boolean + trashingUser: + description: >- + Output only. If the file has been explicitly trashed, the user who + trashed it. Only populated for items in shared drives. + $ref: '#/components/schemas/User' + thumbnailVersion: + description: >- + Output only. The thumbnail version for use in thumbnail cache + invalidation. + type: string + format: int64 + trashedTime: + description: >- + The time that the item was trashed (RFC 3339 date-time). Only + populated for items in shared drives. + type: string + format: date-time + modifiedByMe: + description: Output only. Whether the file has been modified by this user. + type: boolean + permissionIds: + description: >- + Output only. List of permission IDs for users with access to this + file. + type: array + items: + type: string + imageMediaMetadata: + description: Output only. Additional metadata about image media, if available. + type: object + properties: + flashUsed: + description: Output only. Whether a flash was used to create the photo. + type: boolean + meteringMode: + description: Output only. The metering mode used to create the photo. + type: string + sensor: + description: Output only. The type of sensor used to create the photo. + type: string + exposureMode: + description: Output only. The exposure mode used to create the photo. + type: string + colorSpace: + description: Output only. The color space of the photo. + type: string + whiteBalance: + description: Output only. The white balance mode used to create the photo. + type: string + width: + description: Output only. The width of the image in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the image in pixels. + type: integer + format: int32 + location: + description: >- + Output only. Geographic location information stored in the + image. + type: object + properties: + latitude: + description: Output only. The latitude stored in the image. + type: number + format: double + longitude: + description: Output only. The longitude stored in the image. + type: number + format: double + altitude: + description: Output only. The altitude stored in the image. + type: number + format: double + rotation: + description: >- + Output only. The number of clockwise 90 degree rotations applied + from the image's original orientation. + type: integer + format: int32 + time: + description: >- + Output only. The date and time the photo was taken (EXIF + DateTime). + type: string + cameraMake: + description: Output only. The make of the camera used to create the photo. + type: string + cameraModel: + description: Output only. The model of the camera used to create the photo. + type: string + exposureTime: + description: Output only. The length of the exposure, in seconds. + type: number + format: float + aperture: + description: Output only. The aperture used to create the photo (f-number). + type: number + format: float + focalLength: + description: >- + Output only. The focal length used to create the photo, in + millimeters. + type: number + format: float + isoSpeed: + description: Output only. The ISO speed used to create the photo. + type: integer + format: int32 + exposureBias: + description: Output only. The exposure bias of the photo (APEX value). + type: number + format: float + maxApertureValue: + description: >- + Output only. The smallest f-number of the lens at the focal + length used to create the photo (APEX value). + type: number + format: float + subjectDistance: + description: >- + Output only. The distance to the subject of the photo, in + meters. + type: integer + format: int32 + lens: + description: Output only. The lens used to create the photo. + type: string + videoMediaMetadata: + description: >- + Output only. Additional metadata about video media. This may not be + available immediately upon upload. + type: object + properties: + width: + description: Output only. The width of the video in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the video in pixels. + type: integer + format: int32 + durationMillis: + description: Output only. The duration of the video in milliseconds. + type: string + format: int64 + shortcutDetails: + description: >- + Shortcut file details. Only populated for shortcut files, which have + the mimeType field set to `application/vnd.google-apps.shortcut`. + Can only be set on `files.create` requests. + type: object + properties: + targetId: + description: >- + The ID of the file that this shortcut points to. Can only be set + on `files.create` requests. + type: string + targetMimeType: + description: >- + Output only. The MIME type of the file that this shortcut points + to. The value of this field is a snapshot of the target's MIME + type, captured when the shortcut is created. + type: string + targetResourceKey: + description: Output only. The ResourceKey for the target file. + type: string + contentRestrictions: + description: >- + Restrictions for accessing the content of the file. Only populated + if such a restriction exists. + type: array + items: + $ref: '#/components/schemas/ContentRestriction' + resourceKey: + description: Output only. A key needed to access the item via a shared link. + type: string + linkShareMetadata: + description: >- + Contains details about the link URLs that clients are using to refer + to this item. + type: object + properties: + securityUpdateEligible: + description: Output only. Whether the file is eligible for security update. + type: boolean + securityUpdateEnabled: + description: >- + Output only. Whether the security update is enabled for this + file. + type: boolean + labelInfo: + description: Output only. An overview of the labels on the file. + type: object + properties: + labels: + description: >- + Output only. The set of labels on the file as requested by the + label IDs in the `includeLabels` parameter. By default, no + labels are returned. + type: array + items: + $ref: '#/components/schemas/Label' + sha1Checksum: + description: >- + Output only. The SHA1 checksum associated with this file, if + available. This field is only populated for files with content + stored in Google Drive; it is not populated for Docs Editors or + shortcut files. + type: string + sha256Checksum: + description: >- + Output only. The SHA256 checksum associated with this file, if + available. This field is only populated for files with content + stored in Google Drive; it is not populated for Docs Editors or + shortcut files. + type: string + Permission: + id: Permission + description: >- + A permission for a file. A permission grants a user, group, domain, or + the world access to a file or a folder hierarchy. Some resource methods + (such as `permissions.update`) require a `permissionId`. Use the + `permissions.list` method to retrieve the ID for a file, folder, or + shared drive. + type: object + properties: + id: + description: >- + Output only. The ID of this permission. This is a unique identifier + for the grantee, and is published in User resources as + `permissionId`. IDs should be treated as opaque values. + type: string + displayName: + description: >- + Output only. The "pretty" name of the value of the permission. The + following is a list of examples for each type of permission: * + `user` - User's full name, as defined for their Google account, such + as "Joe Smith." * `group` - Name of the Google Group, such as "The + Company Administrators." * `domain` - String domain name, such as + "thecompany.com." * `anyone` - No `displayName` is present. + type: string + type: + description: >- + The type of the grantee. Valid values are: * `user` * `group` * + `domain` * `anyone` When creating a permission, if `type` is `user` + or `group`, you must provide an `emailAddress` for the user or + group. When `type` is `domain`, you must provide a `domain`. There + isn't extra information required for an `anyone` type. + annotations: + required: + - drive.permissions.create + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#permission"`. + default: drive#permission + type: string + permissionDetails: + description: >- + Output only. Details of whether the permissions on this shared drive + item are inherited or directly on this item. This is an output-only + field which is present only for shared drive items. + readOnly: true + type: array + items: + type: object + properties: + permissionType: + description: >- + Output only. The permission type for this user. While new + values may be added in future, the following are currently + possible: * `file` * `member` + type: string + inheritedFrom: + description: >- + Output only. The ID of the item from which this permission is + inherited. This is an output-only field. + type: string + role: + description: >- + Output only. The primary role for this user. While new values + may be added in the future, the following are currently + possible: * `organizer` * `fileOrganizer` * `writer` * + `commenter` * `reader` + type: string + inherited: + description: >- + Output only. Whether this permission is inherited. This field + is always populated. This is an output-only field. + type: boolean + photoLink: + description: Output only. A link to the user's profile photo, if available. + type: string + emailAddress: + description: >- + The email address of the user or group to which this permission + refers. + type: string + role: + description: >- + The role granted by this permission. While new values may be + supported in the future, the following are currently allowed: * + `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * + `reader` + annotations: + required: + - drive.permissions.create + type: string + allowFileDiscovery: + description: >- + Whether the permission allows the file to be discovered through + search. This is only applicable for permissions of type `domain` or + `anyone`. + type: boolean + domain: + description: The domain to which this permission refers. + type: string + expirationTime: + description: >- + The time at which this permission will expire (RFC 3339 date-time). + Expiration times have the following restrictions: - They can only be + set on user and group permissions - The time must be in the future - + The time cannot be more than a year in the future + type: string + format: date-time + teamDrivePermissionDetails: + description: >- + Output only. Deprecated: Output only. Use `permissionDetails` + instead. + readOnly: true + deprecated: true + type: array + items: + type: object + properties: + teamDrivePermissionType: + description: >- + Deprecated: Output only. Use + `permissionDetails/permissionType` instead. + deprecated: true + type: string + inheritedFrom: + description: >- + Deprecated: Output only. Use `permissionDetails/inheritedFrom` + instead. + deprecated: true + type: string + role: + description: 'Deprecated: Output only. Use `permissionDetails/role` instead.' + deprecated: true + type: string + inherited: + description: >- + Deprecated: Output only. Use `permissionDetails/inherited` + instead. + deprecated: true + type: boolean + deleted: + description: >- + Output only. Whether the account associated with this permission has + been deleted. This field only pertains to user and group + permissions. + type: boolean + view: + description: >- + Indicates the view for this permission. Only populated for + permissions that belong to a view. 'published' is the only supported + value. + type: string + pendingOwner: + description: >- + Whether the account associated with this permission is a pending + owner. Only populated for `user` type permissions for files that are + not in a shared drive. + type: boolean + ContentRestriction: + id: ContentRestriction + description: A restriction for accessing the content of the file. + type: object + properties: + readOnly: + description: >- + Whether the content of the file is read-only. If a file is + read-only, a new revision of the file may not be added, comments may + not be added or modified, and the title of the file may not be + modified. + type: boolean + reason: + description: >- + Reason for why the content of the file is restricted. This is only + mutable on requests that also set `readOnly=true`. + type: string + type: + description: >- + Output only. The type of the content restriction. Currently the only + possible value is `globalContentRestriction`. + type: string + restrictingUser: + description: >- + Output only. The user who set the content restriction. Only + populated if `readOnly` is true. + $ref: '#/components/schemas/User' + restrictionTime: + description: >- + The time at which the content restriction was set (formatted RFC + 3339 timestamp). Only populated if readOnly is true. + type: string + format: date-time + ownerRestricted: + description: >- + Whether the content restriction can only be modified or removed by a + user who owns the file. For files in shared drives, any user with + `organizer` capabilities can modify or remove this content + restriction. + type: boolean + systemRestricted: + description: >- + Output only. Whether the content restriction was applied by the + system, for example due to an esignature. Users cannot modify or + remove system restricted content restrictions. + type: boolean + Label: + id: Label + description: Representation of label and label fields. + type: object + properties: + id: + description: The ID of the label. + type: string + revisionId: + description: The revision ID of the label. + type: string + kind: + description: This is always drive#label + type: string + fields: + description: A map of the fields on the label, keyed by the field's ID. + type: object + additionalProperties: + $ref: '#/components/schemas/LabelField' + LabelField: + id: LabelField + description: Representation of field, which is a typed key-value pair. + type: object + properties: + kind: + description: This is always drive#labelField. + type: string + id: + description: The identifier of this label field. + type: string + valueType: + description: >- + The field type. While new values may be supported in the future, the + following are currently allowed: * `dateString` * `integer` * + `selection` * `text` * `user` + type: string + dateString: + description: >- + Only present if valueType is dateString. RFC 3339 formatted date: + YYYY-MM-DD. + type: array + items: + type: string + format: date + integer: + description: Only present if `valueType` is `integer`. + type: array + items: + type: string + format: int64 + selection: + description: Only present if `valueType` is `selection` + type: array + items: + type: string + text: + description: Only present if `valueType` is `text`. + type: array + items: + type: string + user: + description: Only present if `valueType` is `user`. + type: array + items: + $ref: '#/components/schemas/User' + TeamDrive: + id: TeamDrive + description: 'Deprecated: use the drive collection instead.' + type: object + properties: + id: + description: >- + The ID of this Team Drive which is also the ID of the top level + folder of this Team Drive. + type: string + name: + description: The name of this Team Drive. + type: string + colorRgb: + description: >- + The color of this Team Drive as an RGB hex string. It can only be + set on a `drive.teamdrives.update` request that does not set + `themeId`. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#teamDrive"`. + default: drive#teamDrive + type: string + backgroundImageLink: + description: A short-lived link to this Team Drive's background image. + type: string + capabilities: + description: Capabilities the current user has on this Team Drive. + type: object + properties: + canAddChildren: + description: >- + Whether the current user can add children to folders in this + Team Drive. + type: boolean + canComment: + description: >- + Whether the current user can comment on files in this Team + Drive. + type: boolean + canCopy: + description: Whether the current user can copy files in this Team Drive. + type: boolean + canDeleteTeamDrive: + description: >- + Whether the current user can delete this Team Drive. Attempting + to delete the Team Drive may still fail if there are untrashed + items inside the Team Drive. + type: boolean + canDownload: + description: Whether the current user can download files in this Team Drive. + type: boolean + canEdit: + description: Whether the current user can edit files in this Team Drive + type: boolean + canListChildren: + description: >- + Whether the current user can list the children of folders in + this Team Drive. + type: boolean + canManageMembers: + description: >- + Whether the current user can add members to this Team Drive or + remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Whether the current user can read the revisions resource of + files in this Team Drive. + type: boolean + canRemoveChildren: + description: >- + Deprecated: Use `canDeleteChildren` or `canTrashChildren` + instead. + deprecated: true + type: boolean + canRename: + description: >- + Whether the current user can rename files or folders in this + Team Drive. + type: boolean + canRenameTeamDrive: + description: Whether the current user can rename this Team Drive. + type: boolean + canChangeTeamDriveBackground: + description: >- + Whether the current user can change the background of this Team + Drive. + type: boolean + canShare: + description: >- + Whether the current user can share files or folders in this Team + Drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Whether the current user can change the + `copyRequiresWriterPermission` restriction of this Team Drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Whether the current user can change the `domainUsersOnly` + restriction of this Team Drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + Team Drive. + type: boolean + canChangeTeamMembersOnlyRestriction: + description: >- + Whether the current user can change the `teamMembersOnly` + restriction of this Team Drive. + type: boolean + canDeleteChildren: + description: >- + Whether the current user can delete children from folders in + this Team Drive. + type: boolean + canTrashChildren: + description: >- + Whether the current user can trash children from folders in this + Team Drive. + type: boolean + canResetTeamDriveRestrictions: + description: >- + Whether the current user can reset the Team Drive restrictions + to defaults. + type: boolean + themeId: + description: >- + The ID of the theme from which the background image and color will + be set. The set of possible `teamDriveThemes` can be retrieved from + a `drive.about.get` response. When not specified on a + `drive.teamdrives.create` request, a random theme is chosen from + which the background image and color are set. This is a write-only + field; it can only be set on requests that don't set `colorRgb` or + `backgroundImageFile`. + type: string + backgroundImageFile: + description: >- + An image file and cropping parameters from which a background image + for this Team Drive is set. This is a write only field; it can only + be set on `drive.teamdrives.update` requests that don't set + `themeId`. When specified, all fields of the `backgroundImageFile` + must be set. + type: object + properties: + id: + description: >- + The ID of an image file in Drive to use for the background + image. + type: string + xCoordinate: + description: >- + The X coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the horizontal distance from the + left side of the entire image to the left side of the cropping + area divided by the width of the entire image. + type: number + format: float + yCoordinate: + description: >- + The Y coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the vertical distance from the top + side of the entire image to the top side of the cropping area + divided by the height of the entire image. + type: number + format: float + width: + description: >- + The width of the cropped image in the closed range of 0 to 1. + This value represents the width of the cropped image divided by + the width of the entire image. The height is computed by + applying a width to height aspect ratio of 80 to 9. The + resulting image must be at least 1280 pixels wide and 144 pixels + high. + type: number + format: float + createdTime: + description: The time at which the Team Drive was created (RFC 3339 date-time). + type: string + format: date-time + restrictions: + description: >- + A set of restrictions that apply to this Team Drive or items inside + this Team Drive. + type: object + properties: + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download files inside + this Team Drive, should be disabled for readers and commenters. + When this restriction is set to `true`, it will override the + similarly named field to `true` for any file inside this Team + Drive. + type: boolean + domainUsersOnly: + description: >- + Whether access to this Team Drive and items inside this Team + Drive is restricted to users of the domain to which this Team + Drive belongs. This restriction may be overridden by other + sharing policies controlled outside of this Team Drive. + type: boolean + teamMembersOnly: + description: >- + Whether access to items inside this Team Drive is restricted to + members of this Team Drive. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this Team Drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + If true, only users with the organizer role can share folders. + If false, users with either the organizer role or the file + organizer role can share folders. + type: boolean + orgUnitId: + description: >- + The organizational unit of this shared drive. This field is only + populated on `drives.list` responses when the `useDomainAdminAccess` + parameter is set to `true`. + type: string + Drive: + id: Drive + description: >- + Representation of a shared drive. Some resource methods (such as + `drives.update`) require a `driveId`. Use the `drives.list` method to + retrieve the ID for a shared drive. + type: object + properties: + id: + description: >- + Output only. The ID of this shared drive which is also the ID of the + top level folder of this shared drive. + type: string + name: + description: The name of this shared drive. + type: string + colorRgb: + description: >- + The color of this shared drive as an RGB hex string. It can only be + set on a `drive.drives.update` request that does not set `themeId`. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#drive"`. + default: drive#drive + type: string + backgroundImageLink: + description: >- + Output only. A short-lived link to this shared drive's background + image. + type: string + capabilities: + description: Output only. Capabilities the current user has on this shared drive. + type: object + properties: + canAddChildren: + description: >- + Output only. Whether the current user can add children to + folders in this shared drive. + type: boolean + canComment: + description: >- + Output only. Whether the current user can comment on files in + this shared drive. + type: boolean + canCopy: + description: >- + Output only. Whether the current user can copy files in this + shared drive. + type: boolean + canDeleteDrive: + description: >- + Output only. Whether the current user can delete this shared + drive. Attempting to delete the shared drive may still fail if + there are untrashed items inside the shared drive. + type: boolean + canDownload: + description: >- + Output only. Whether the current user can download files in this + shared drive. + type: boolean + canEdit: + description: >- + Output only. Whether the current user can edit files in this + shared drive + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + folders in this shared drive. + type: boolean + canManageMembers: + description: >- + Output only. Whether the current user can add members to this + shared drive or remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Output only. Whether the current user can read the revisions + resource of files in this shared drive. + type: boolean + canRename: + description: >- + Output only. Whether the current user can rename files or + folders in this shared drive. + type: boolean + canRenameDrive: + description: >- + Output only. Whether the current user can rename this shared + drive. + type: boolean + canChangeDriveBackground: + description: >- + Output only. Whether the current user can change the background + of this shared drive. + type: boolean + canShare: + description: >- + Output only. Whether the current user can share files or folders + in this shared drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this shared drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `domainUsersOnly` restriction of this shared drive. + type: boolean + canChangeDriveMembersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `driveMembersOnly` restriction of this shared drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + shared drive. + type: boolean + canResetDriveRestrictions: + description: >- + Output only. Whether the current user can reset the shared drive + restrictions to defaults. + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children from + folders in this shared drive. + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children from + folders in this shared drive. + type: boolean + themeId: + description: >- + The ID of the theme from which the background image and color will + be set. The set of possible `driveThemes` can be retrieved from a + `drive.about.get` response. When not specified on a + `drive.drives.create` request, a random theme is chosen from which + the background image and color are set. This is a write-only field; + it can only be set on requests that don't set `colorRgb` or + `backgroundImageFile`. + type: string + backgroundImageFile: + description: >- + An image file and cropping parameters from which a background image + for this shared drive is set. This is a write only field; it can + only be set on `drive.drives.update` requests that don't set + `themeId`. When specified, all fields of the `backgroundImageFile` + must be set. + type: object + properties: + id: + description: >- + The ID of an image file in Google Drive to use for the + background image. + type: string + xCoordinate: + description: >- + The X coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the horizontal distance from the + left side of the entire image to the left side of the cropping + area divided by the width of the entire image. + type: number + format: float + yCoordinate: + description: >- + The Y coordinate of the upper left corner of the cropping area + in the background image. This is a value in the closed range of + 0 to 1. This value represents the vertical distance from the top + side of the entire image to the top side of the cropping area + divided by the height of the entire image. + type: number + format: float + width: + description: >- + The width of the cropped image in the closed range of 0 to 1. + This value represents the width of the cropped image divided by + the width of the entire image. The height is computed by + applying a width to height aspect ratio of 80 to 9. The + resulting image must be at least 1280 pixels wide and 144 pixels + high. + type: number + format: float + createdTime: + description: The time at which the shared drive was created (RFC 3339 date-time). + type: string + format: date-time + hidden: + description: Whether the shared drive is hidden from default view. + type: boolean + restrictions: + description: >- + A set of restrictions that apply to this shared drive or items + inside this shared drive. Note that restrictions can't be set when + creating a shared drive. To add a restriction, first create a shared + drive and then use `drives.update` to add restrictions. + type: object + properties: + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download files inside + this shared drive, should be disabled for readers and + commenters. When this restriction is set to `true`, it will + override the similarly named field to `true` for any file inside + this shared drive. + type: boolean + domainUsersOnly: + description: >- + Whether access to this shared drive and items inside this shared + drive is restricted to users of the domain to which this shared + drive belongs. This restriction may be overridden by other + sharing policies controlled outside of this shared drive. + type: boolean + driveMembersOnly: + description: >- + Whether access to items inside this shared drive is restricted + to its members. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this shared drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + If true, only users with the organizer role can share folders. + If false, users with either the organizer role or the file + organizer role can share folders. + type: boolean + orgUnitId: + description: >- + Output only. The organizational unit of this shared drive. This + field is only populated on `drives.list` responses when the + `useDomainAdminAccess` parameter is set to `true`. + type: string + Channel: + id: Channel + description: A notification channel used to watch for resource changes. + type: object + properties: + payload: + description: A Boolean value to indicate whether payload is wanted. Optional. + type: boolean + id: + description: A UUID or similar unique string that identifies this channel. + type: string + resourceId: + description: >- + An opaque ID that identifies the resource being watched on this + channel. Stable across different API versions. + type: string + resourceUri: + description: A version-specific identifier for the watched resource. + type: string + token: + description: >- + An arbitrary string delivered to the target address with each + notification delivered over this channel. Optional. + type: string + expiration: + description: >- + Date and time of notification channel expiration, expressed as a + Unix timestamp, in milliseconds. Optional. + type: string + format: int64 + type: + description: >- + The type of delivery mechanism used for this channel. Valid values + are "web_hook" or "webhook". + type: string + address: + description: The address where notifications are delivered for this channel. + type: string + params: + description: >- + Additional parameters controlling delivery channel behavior. + Optional. + type: object + additionalProperties: + type: string + kind: + description: >- + Identifies this as a notification channel used to watch for changes + to a resource, which is `api#channel`. + default: api#channel + type: string + Comment: + id: Comment + description: >- + A comment on a file. Some resource methods (such as `comments.update`) + require a `commentId`. Use the `comments.list` method to retrieve the ID + for a comment in a file. + type: object + properties: + id: + description: Output only. The ID of the comment. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#comment"`. + default: drive#comment + type: string + createdTime: + description: The time at which the comment was created (RFC 3339 date-time). + type: string + format: date-time + modifiedTime: + description: >- + The last time the comment or any of its replies was modified (RFC + 3339 date-time). + type: string + format: date-time + resolved: + description: >- + Output only. Whether the comment has been resolved by one of its + replies. + type: boolean + anchor: + description: >- + A region of the document represented as a JSON string. For details + on defining anchor properties, refer to [Manage comments and + replies](https://developers.google.com/drive/api/v3/manage-comments). + type: string + replies: + description: >- + Output only. The full list of replies to the comment in + chronological order. + type: array + items: + $ref: '#/components/schemas/Reply' + author: + description: >- + Output only. The author of the comment. The author's email address + and permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether the comment has been deleted. A deleted comment + has no content. + type: boolean + htmlContent: + description: Output only. The content of the comment with HTML formatting. + type: string + content: + description: >- + The plain text content of the comment. This field is used for + setting the content, while `htmlContent` should be displayed. + annotations: + required: + - drive.comments.create + - drive.comments.update + type: string + quotedFileContent: + description: >- + The file content to which the comment refers, typically within the + anchor region. For a text file, for example, this would be the text + at the location of the comment. + type: object + properties: + mimeType: + description: The MIME type of the quoted content. + type: string + value: + description: >- + The quoted content itself. This is interpreted as plain text if + set through the API. + type: string + Reply: + id: Reply + description: >- + A reply to a comment on a file. Some resource methods (such as + `replies.update`) require a `replyId`. Use the `replies.list` method to + retrieve the ID for a reply. + type: object + properties: + id: + description: Output only. The ID of the reply. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#reply"`. + default: drive#reply + type: string + createdTime: + description: The time at which the reply was created (RFC 3339 date-time). + type: string + format: date-time + modifiedTime: + description: The last time the reply was modified (RFC 3339 date-time). + type: string + format: date-time + action: + description: >- + The action the reply performed to the parent comment. Valid values + are: * `resolve` * `reopen` + type: string + author: + description: >- + Output only. The author of the reply. The author's email address and + permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether the reply has been deleted. A deleted reply has + no content. + type: boolean + htmlContent: + description: Output only. The content of the reply with HTML formatting. + type: string + content: + description: >- + The plain text content of the reply. This field is used for setting + the content, while `htmlContent` should be displayed. This is + required on creates if no `action` is specified. + annotations: + required: + - drive.replies.update + type: string + CommentList: + id: CommentList + description: A list of comments on a file. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#commentList"`. + default: drive#commentList + type: string + comments: + description: >- + The list of comments. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Comment' + nextPageToken: + description: >- + The page token for the next page of comments. This will be absent if + the end of the comments list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. The page token + is typically valid for several hours. However, if new items are + added or removed, your expected results might differ. + type: string + DriveList: + id: DriveList + description: A list of shared drives. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of shared drives. This will be + absent if the end of the list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. The page token + is typically valid for several hours. However, if new items are + added or removed, your expected results might differ. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#driveList"`. + default: drive#driveList + type: string + drives: + description: >- + The list of shared drives. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Drive' + GeneratedIds: + id: GeneratedIds + description: A list of generated file IDs which can be provided in create requests. + type: object + properties: + ids: + description: The IDs generated for the requesting user in the specified space. + type: array + items: + type: string + space: + description: The type of file that can be created with these IDs. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#generatedIds"`. + default: drive#generatedIds + type: string + FileList: + id: FileList + description: A list of files. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of files. This will be absent if + the end of the files list has been reached. If the token is rejected + for any reason, it should be discarded, and pagination should be + restarted from the first page of results. The page token is + typically valid for several hours. However, if new items are added + or removed, your expected results might differ. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#fileList"`. + default: drive#fileList + type: string + incompleteSearch: + description: >- + Whether the search process was incomplete. If true, then some search + results might be missing, since all documents were not searched. + This can occur when searching multiple drives with the 'allDrives' + corpora, but all corpora couldn't be searched. When this happens, + it's suggested that clients narrow their query by choosing a + different corpus such as 'user' or 'drive'. + type: boolean + files: + description: >- + The list of files. If nextPageToken is populated, then this list may + be incomplete and an additional page of results should be fetched. + type: array + items: + $ref: '#/components/schemas/File' + LabelList: + id: LabelList + description: A list of labels applied to a file. + type: object + properties: + labels: + description: The list of labels. + type: array + items: + $ref: '#/components/schemas/Label' + nextPageToken: + description: >- + The page token for the next page of labels. This field will be + absent if the end of the list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. The page token + is typically valid for several hours. However, if new items are + added or removed, your expected results might differ. + type: string + kind: + description: This is always drive#labelList + type: string + ModifyLabelsRequest: + id: ModifyLabelsRequest + description: >- + A request to modify the set of labels on a file. This request may + contain many modifications that will either all succeed or all fail + atomically. + type: object + properties: + labelModifications: + description: The list of modifications to apply to the labels on the file. + type: array + items: + $ref: '#/components/schemas/LabelModification' + kind: + description: This is always drive#modifyLabelsRequest. + type: string + LabelModification: + id: LabelModification + description: >- + A modification to a label on a file. A LabelModification can be used to + apply a label to a file, update an existing label on a file, or remove a + label from a file. + type: object + properties: + labelId: + description: The ID of the label to modify. + annotations: + required: + - drive.files.modifyLabels + type: string + fieldModifications: + description: The list of modifications to this label's fields. + type: array + items: + $ref: '#/components/schemas/LabelFieldModification' + removeLabel: + description: If true, the label will be removed from the file. + type: boolean + kind: + description: This is always drive#labelModification. + type: string + LabelFieldModification: + id: LabelFieldModification + description: A modification to a label's field. + type: object + properties: + fieldId: + description: The ID of the field to be modified. + type: string + kind: + description: This is always drive#labelFieldModification. + type: string + setDateValues: + description: >- + Replaces the value of a dateString Field with these new values. The + string must be in the RFC 3339 full-date format: YYYY-MM-DD. + type: array + items: + type: string + format: date + setTextValues: + description: Sets the value of a `text` field. + type: array + items: + type: string + setSelectionValues: + description: Replaces a `selection` field with these new values. + type: array + items: + type: string + setIntegerValues: + description: Replaces the value of an `integer` field with these new values. + type: array + items: + type: string + format: int64 + setUserValues: + description: >- + Replaces a `user` field with these new values. The values must be + valid email addresses. + type: array + items: + type: string + unsetValues: + description: Unsets the values for this field. + type: boolean + ModifyLabelsResponse: + id: ModifyLabelsResponse + description: >- + Response to a ModifyLabels request. This contains only those labels + which were added or updated by the request. + type: object + properties: + modifiedLabels: + description: The list of labels which were added or updated by the request. + type: array + items: + $ref: '#/components/schemas/Label' + kind: + description: This is always drive#modifyLabelsResponse + type: string + PermissionList: + id: PermissionList + description: A list of permissions for a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of permissions. This field will be + absent if the end of the permissions list has been reached. If the + token is rejected for any reason, it should be discarded, and + pagination should be restarted from the first page of results. The + page token is typically valid for several hours. However, if new + items are added or removed, your expected results might differ. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#permissionList"`. + default: drive#permissionList + type: string + permissions: + description: >- + The list of permissions. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Permission' + ReplyList: + id: ReplyList + description: A list of replies to a comment on a file. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#replyList"`. + default: drive#replyList + type: string + replies: + description: >- + The list of replies. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Reply' + nextPageToken: + description: >- + The page token for the next page of replies. This will be absent if + the end of the replies list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. The page token + is typically valid for several hours. However, if new items are + added or removed, your expected results might differ. + type: string + Revision: + id: Revision + description: >- + The metadata for a revision to a file. Some resource methods (such as + `revisions.update`) require a `revisionId`. Use the `revisions.list` + method to retrieve the ID for a revision. + type: object + properties: + id: + description: Output only. The ID of the revision. + type: string + mimeType: + description: Output only. The MIME type of the revision. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#revision"`. + default: drive#revision + type: string + published: + description: >- + Whether this revision is published. This is only applicable to Docs + Editors files. + type: boolean + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + type: object + additionalProperties: + type: string + keepForever: + description: >- + Whether to keep this revision forever, even if it is no longer the + head revision. If not set, the revision will be automatically purged + 30 days after newer content is uploaded. This can be set on a + maximum of 200 revisions for a file. This field is only applicable + to files with binary content in Drive. + type: boolean + md5Checksum: + description: >- + Output only. The MD5 checksum of the revision's content. This is + only applicable to files with binary content in Drive. + type: string + modifiedTime: + description: The last time the revision was modified (RFC 3339 date-time). + type: string + format: date-time + publishAuto: + description: >- + Whether subsequent revisions will be automatically republished. This + is only applicable to Docs Editors files. + type: boolean + publishedOutsideDomain: + description: >- + Whether this revision is published outside the domain. This is only + applicable to Docs Editors files. + type: boolean + publishedLink: + description: >- + Output only. A link to the published revision. This is only + populated for Google Sites files. + type: string + size: + description: >- + Output only. The size of the revision's content in bytes. This is + only applicable to files with binary content in Drive. + type: string + format: int64 + originalFilename: + description: >- + Output only. The original filename used to create this revision. + This is only applicable to files with binary content in Drive. + type: string + lastModifyingUser: + description: >- + Output only. The last user to modify this revision. This field is + only populated when the last modification was performed by a + signed-in user. + $ref: '#/components/schemas/User' + RevisionList: + id: RevisionList + description: A list of revisions of a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of revisions. This will be absent + if the end of the revisions list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. The page token + is typically valid for several hours. However, if new items are + added or removed, your expected results might differ. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#revisionList"`. + default: drive#revisionList + type: string + revisions: + description: >- + The list of revisions. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Revision' + TeamDriveList: + id: TeamDriveList + description: A list of Team Drives. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of Team Drives. This will be absent + if the end of the Team Drives list has been reached. If the token is + rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. The page token + is typically valid for several hours. However, if new items are + added or removed, your expected results might differ. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#teamDriveList"`. + default: drive#teamDriveList + type: string + teamDrives: + description: >- + The list of Team Drives. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/TeamDrive' + AccessProposal: + id: AccessProposal + description: The Access Proposal resource for outstanding access proposals on a file + type: object + properties: + fileId: + description: The file id that the proposal for access is on + type: string + proposalId: + description: The id of the access proposal + type: string + requesterEmailAddress: + description: The email address of the requesting user + type: string + recipientEmailAddress: + description: >- + The email address of the user that will receive permissions if + accepted + type: string + rolesAndViews: + description: A wrapper for the role and view of an access proposal. + type: array + items: + $ref: '#/components/schemas/AccessProposalRoleAndView' + requestMessage: + description: The message that the requester added to the proposal + type: string + createTime: + description: The creation time + type: string + format: google-datetime + AccessProposalRoleAndView: + id: AccessProposalRoleAndView + description: A wrapper for the role and view of an access proposal. + type: object + properties: + role: + description: >- + The role that was proposed by the requester New values may be added + in the future, but the following are currently possible: * `writer` + * `commenter` * `reader` + type: string + view: + description: >- + Indicates the view for this access proposal. Only populated for + proposals that belong to a view. `published` is the only supported + value. + type: string + ResolveAccessProposalRequest: + id: ResolveAccessProposalRequest + description: Request message for resolving an AccessProposal on a file. + type: object + properties: + role: + description: >- + Optional. The roles the approver has allowed, if any. Note: This + field is required for the `ACCEPT` action. + type: array + items: + type: string + view: + description: >- + Optional. Indicates the view for this access proposal. This should + only be set when the proposal belongs to a view. `published` is the + only supported value. + type: string + action: + description: Required. The action to take on the AccessProposal. + type: string + enumDescriptions: + - Unspecified action + - >- + The user accepts the proposal. Note: If this action is used, the + `role` field must have at least one value. + - The user denies the proposal + enum: + - ACTION_UNSPECIFIED + - ACCEPT + - DENY + sendNotification: + description: >- + Optional. Whether to send an email to the requester when the + AccessProposal is denied or accepted. + type: boolean + ListAccessProposalsResponse: + id: ListAccessProposalsResponse + description: The response to an Access Proposal list request. + type: object + properties: + accessProposals: + description: >- + The list of Access Proposals. This field is only populated in v3 and + v3beta. + type: array + items: + $ref: '#/components/schemas/AccessProposal' + nextPageToken: + description: >- + The continuation token for the next page of results. This will be + absent if the end of the results list has been reached. If the token + is rejected for any reason, it should be discarded, and pagination + should be restarted from the first page of results. + type: string + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + operations: + id: googleworkspace.drivev3.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: '#/paths/~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: '#/paths/~1operations~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operation: + id: googleworkspace.drivev3.operation + name: operation + title: Operation + methods: + delete: + operation: + $ref: '#/paths/~1operation~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1operation~1{name}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operation/methods/delete' + about: + id: googleworkspace.drivev3.about + name: about + title: About + methods: + get: + operation: + $ref: '#/paths/~1about/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/about/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + apps: + id: googleworkspace.drivev3.apps + name: apps + title: Apps + methods: + get: + operation: + $ref: '#/paths/~1apps~1{appId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + changes_start_page_token: + id: googleworkspace.drivev3.changes_start_page_token + name: changes_start_page_token + title: Changes_start_page_token + methods: + get_start_page_token: + operation: + $ref: '#/paths/~1changes~1startPageToken/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/changes_start_page_token/methods/get_start_page_token + insert: [] + update: [] + replace: [] + delete: [] + changes: + id: googleworkspace.drivev3.changes + name: changes + title: Changes + methods: + list: + operation: + $ref: '#/paths/~1changes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.changes + watch: + operation: + $ref: '#/paths/~1changes~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/changes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + channels: + id: googleworkspace.drivev3.channels + name: channels + title: Channels + methods: + stop: + operation: + $ref: '#/paths/~1channels~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + comments: + id: googleworkspace.drivev3.comments + name: comments + title: Comments + methods: + create: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.comments + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/get' + - $ref: '#/components/x-stackQL-resources/comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/comments/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/comments/methods/delete' + drives: + id: googleworkspace.drivev3.drives + name: drives + title: Drives + methods: + create: + operation: + $ref: '#/paths/~1drives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1drives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drives + delete: + operation: + $ref: '#/paths/~1drives~1{driveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1drives~1{driveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1drives~1{driveId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + hide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1hide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + unhide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1unhide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drives/methods/get' + - $ref: '#/components/x-stackQL-resources/drives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drives/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/drives/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/drives/methods/delete' + files: + id: googleworkspace.drivev3.files + name: files + title: Files + methods: + copy: + operation: + $ref: '#/paths/~1files~1{fileId}~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1files/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.files + delete: + operation: + $ref: '#/paths/~1files~1{fileId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + empty_trash: + operation: + $ref: '#/paths/~1files~1trash/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: '#/paths/~1files~1{fileId}~1export/get' + response: + mediaType: application/json + openAPIDocKey: '200' + generate_ids: + operation: + $ref: '#/paths/~1files~1generateIds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + modify_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1modifyLabels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + watch: + operation: + $ref: '#/paths/~1files~1{fileId}~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + download: + operation: + $ref: '#/paths/~1files~1{fileId}~1download/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/get' + - $ref: '#/components/x-stackQL-resources/files/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/files/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/files/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/files/methods/delete' + files_labels: + id: googleworkspace.drivev3.files_labels + name: files_labels + title: Files_labels + methods: + list_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1listLabels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files_labels/methods/list_labels' + insert: [] + update: [] + replace: [] + delete: [] + permissions: + id: googleworkspace.drivev3.permissions + name: permissions + title: Permissions + methods: + create: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.permissions + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + replies: + id: googleworkspace.drivev3.replies + name: replies + title: Replies + methods: + create: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.replies + delete: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/replies/methods/get' + - $ref: '#/components/x-stackQL-resources/replies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/replies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/replies/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/replies/methods/delete' + revisions: + id: googleworkspace.drivev3.revisions + name: revisions + title: Revisions + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.revisions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/revisions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' + teamdrives: + id: googleworkspace.drivev3.teamdrives + name: teamdrives + title: Teamdrives + methods: + create: + operation: + $ref: '#/paths/~1teamdrives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1teamdrives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.teamDrives + delete: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/get' + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/delete' + accessproposals: + id: googleworkspace.drivev3.accessproposals + name: accessproposals + title: Accessproposals + methods: + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1accessproposals~1{proposalId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + resolve: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1accessproposals~1{proposalId}:resolve/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1accessproposals/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.accessProposals + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accessproposals/methods/get' + - $ref: '#/components/x-stackQL-resources/accessproposals/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /operations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: drive.operations.list + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: query + name: name + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /operations/{name}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: drive.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: name + required: true + schema: + type: string + /operation/{name}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: drive.operation.delete + security: [] + responses: + '204': + description: No Content + parameters: + - in: path + name: name + required: true + schema: + type: string + /operation/{name}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: drive.operation.cancel + security: [] + responses: + '204': + description: No Content + parameters: + - in: path + name: name + required: true + schema: + type: string + /about: + parameters: *ref_1 + get: + description: >- + Gets information about the user, the user's Drive, and system + capabilities. + operationId: drive.about.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/About' + parameters: [] + /apps/{appId}: + parameters: *ref_1 + get: + description: Gets a specific app. + operationId: drive.apps.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/App' + parameters: + - in: path + name: appId + required: true + schema: + type: string + /apps: + parameters: *ref_1 + get: + description: Lists a user's installed apps. + operationId: drive.apps.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AppList' + parameters: + - in: query + name: appFilterExtensions + schema: + type: string + - in: query + name: appFilterMimeTypes + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /changes/startPageToken: + parameters: *ref_1 + get: + description: Gets the starting pageToken for listing future changes. + operationId: drive.changes.getStartPageToken + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StartPageToken' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + /changes: + parameters: *ref_1 + get: + description: Lists the changes for a user or shared drive. + operationId: drive.changes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeList' + parameters: + - in: query + name: pageToken + required: true + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeRemoved + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: restrictToMyDrive + schema: + type: boolean + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /changes/watch: + parameters: *ref_1 + post: + description: Subscribes to changes for a user. + operationId: drive.changes.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: query + name: pageToken + required: true + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeRemoved + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: restrictToMyDrive + schema: + type: boolean + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /channels/stop: + parameters: *ref_1 + post: + description: Stops watching resources through this channel. + operationId: drive.channels.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: [] + /files/{fileId}/comments: + parameters: *ref_1 + post: + description: Creates a comment on a file. + operationId: drive.comments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + get: + description: Lists a file's comments. + operationId: drive.comments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: startModifiedTime + schema: + type: string + /files/{fileId}/comments/{commentId}: + parameters: *ref_1 + delete: + description: Deletes a comment. + operationId: drive.comments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Gets a comment by ID. + operationId: drive.comments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates a comment with patch semantics. + operationId: drive.comments.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + /drives: + parameters: *ref_1 + post: + description: Creates a shared drive. + operationId: drive.drives.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: ' Lists the user''s shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.' + operationId: drive.drives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DriveList' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a shared drive for which the user is an `organizer`. + The shared drive cannot contain any untrashed items. + operationId: drive.drives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: allowItemDeletion + schema: + type: boolean + get: + description: Gets a shared drive's metadata by ID. + operationId: drive.drives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: Updates the metadata for a shared drive. + operationId: drive.drives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}/hide: + parameters: *ref_1 + post: + description: Hides a shared drive from the default view. + operationId: drive.drives.hide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /drives/{driveId}/unhide: + parameters: *ref_1 + post: + description: Restores a shared drive to the default view. + operationId: drive.drives.unhide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /files/{fileId}/copy: + parameters: *ref_1 + post: + description: >- + Creates a copy of a file and applies any requested updates with patch + semantics. + operationId: drive.files.copy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ignoreDefaultVisibility + schema: + type: boolean + - in: query + name: keepRevisionForever + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files: + parameters: *ref_1 + post: + description: ' Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file''s MIME type.' + operationId: drive.files.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ignoreDefaultVisibility + schema: + type: boolean + - in: query + name: keepRevisionForever + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + get: + description: ' Lists the user''s files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don''t want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.' + operationId: drive.files.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FileList' + parameters: + - in: query + name: corpora + schema: + type: string + - in: query + name: corpus + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file owned by the user without moving it to the + trash. If the file belongs to a shared drive, the user must be an + `organizer` on the parent folder. If the target is a folder, all + descendants owned by the user are also deleted. + operationId: drive.files.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: ' Gets a file''s metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).' + operationId: drive.files.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + patch: + description: ' Updates a file''s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).' + operationId: drive.files.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.scripts + Oauth2c: + - https://www.googleapis.com/auth/drive.scripts + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: addParents + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: keepRevisionForever + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: removeParents + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/trash: + parameters: *ref_1 + delete: + description: Permanently deletes all of the user's trashed files. + operationId: drive.files.emptyTrash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: driveId + schema: + type: string + /files/{fileId}/export: + parameters: *ref_1 + get: + description: >- + Exports a Google Workspace document to the requested MIME type and + returns exported byte content. Note that the exported content is limited + to 10MB. + operationId: drive.files.export + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: mimeType + required: true + schema: + type: string + /files/generateIds: + parameters: *ref_1 + get: + description: >- + Generates a set of file IDs which can be provided in create or copy + requests. + operationId: drive.files.generateIds + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GeneratedIds' + parameters: + - in: query + name: count + schema: + type: integer + format: int32 + - in: query + name: space + schema: + type: string + - in: query + name: type + schema: + type: string + /files/{fileId}/listLabels: + parameters: *ref_1 + get: + description: Lists the labels on a file. + operationId: drive.files.listLabels + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LabelList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/modifyLabels: + parameters: *ref_1 + post: + description: >- + Modifies the set of labels applied to a file. Returns a list of the + labels that were added or modified. + operationId: drive.files.modifyLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsResponse' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/watch: + parameters: *ref_1 + post: + description: Subscribes to changes to a file. + operationId: drive.files.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/download: + parameters: *ref_1 + post: + description: >- + Downloads content of a file. Operations are valid for 24 hours from the + time of creation. + operationId: drive.files.download + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: mimeType + schema: + type: string + - in: query + name: revisionId + schema: + type: string + /files/{fileId}/permissions: + parameters: *ref_1 + post: + description: >- + Creates a permission for a file or shared drive. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: emailMessage + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: moveToNewOwnersRoot + schema: + type: boolean + - in: query + name: sendNotificationEmail + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Lists a file's or shared drive's permissions. + operationId: drive.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + /files/{fileId}/permissions/{permissionId}: + parameters: *ref_1 + delete: + description: >- + Deletes a permission. **Warning:** Concurrent permissions operations on + the same file are not supported; only the last update is applied. + operationId: drive.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Gets a permission by ID. + operationId: drive.permissions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: >- + Updates a permission with patch semantics. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: removeExpiration + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /files/{fileId}/comments/{commentId}/replies: + parameters: *ref_1 + post: + description: Creates a reply to a comment. + operationId: drive.replies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Lists a comment's replies. + operationId: drive.replies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ReplyList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/comments/{commentId}/replies/{replyId}: + parameters: *ref_1 + delete: + description: Deletes a reply. + operationId: drive.replies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + get: + description: Gets a reply by ID. + operationId: drive.replies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates a reply with patch semantics. + operationId: drive.replies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + /files/{fileId}/revisions/{revisionId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file version. You can only delete revisions for + files with binary content in Google Drive, like images or videos. + Revisions for other files, like Google Docs or Sheets, and the last + remaining file version can't be deleted. + operationId: drive.revisions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + get: + description: Gets a revision's metadata or content by ID. + operationId: drive.revisions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + - in: query + name: acknowledgeAbuse + schema: + type: boolean + patch: + description: Updates a revision with patch semantics. + operationId: drive.revisions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + /files/{fileId}/revisions: + parameters: *ref_1 + get: + description: Lists a file's revisions. + operationId: drive.revisions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RevisionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /teamdrives: + parameters: *ref_1 + post: + description: 'Deprecated: Use `drives.create` instead.' + operationId: drive.teamdrives.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.list` instead.' + operationId: drive.teamdrives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDriveList' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /teamdrives/{teamDriveId}: + parameters: *ref_1 + delete: + description: 'Deprecated: Use `drives.delete` instead.' + operationId: drive.teamdrives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.get` instead.' + operationId: drive.teamdrives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: 'Deprecated: Use `drives.update` instead.' + operationId: drive.teamdrives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /files/{fileId}/accessproposals/{proposalId}: + parameters: *ref_1 + get: + description: Retrieves an AccessProposal by ID. + operationId: drive.accessproposals.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AccessProposal' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: proposalId + required: true + schema: + type: string + /files/{fileId}/accessproposals/{proposalId}:resolve: + parameters: *ref_1 + post: + description: Used to approve or deny an Access Proposal. + operationId: drive.accessproposals.resolve + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResolveAccessProposalRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: proposalId + required: true + schema: + type: string + /files/{fileId}/accessproposals: + parameters: *ref_1 + get: + description: >- + List the AccessProposals on a file. Note: Only approvers are able to + list AccessProposals on a file. If the user is not an approver, returns + a 403. + operationId: drive.accessproposals.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAccessProposalsResponse' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32