{
"openapi" : "3.0.1",
"info" : {
"title" : "Starburst Public API",
"version" : "v1"
},
"security" : [ {
"accessToken" : [ ]
} ],
"tags" : [ {
"name" : "Cluster Service",
"description" : "Cluster related operations"
}, {
"name" : "User Service",
"description" : "User related operations"
}, {
"name" : "Role Service",
"description" : "Role related operations"
}, {
"name" : "Group Service",
"description" : "Group related operations"
}, {
"name" : "Privilege Service",
"description" : "List, grant and revoke role privileges"
}, {
"name" : "SchemaDiscovery Service",
"description" : "Schema discovery related operations\n\nSee feature documentation\n"
}, {
"name" : "Catalog Service",
"description" : "Catalog related operations"
}, {
"name" : "Discovery Service",
"description" : "Catalog data discovery operations"
}, {
"name" : "Tag Service",
"description" : "Tag related operations"
}, {
"name" : "RowFilter Service",
"description" : "Row filter related operations"
}, {
"name" : "ServiceAccount Service",
"description" : "Service account related operations"
}, {
"name" : "ColumnMask Service",
"description" : "Column mask related operations"
}, {
"name" : "Policy Service",
"description" : "Policy related operatios"
}, {
"name" : "DataProduct Service",
"description" : "Data Product related operations"
}, {
"name" : "DataDomain Service",
"description" : "Data Domain related operations"
}, {
"name" : "Data Product Usage Example Service",
"description" : "Manage usage examples for a Galaxy Data Product"
}, {
"name" : "CrossAccountIamRole Service",
"description" : "AWS cross account IAM role related operations"
}, {
"name" : "Privatelink Service",
"description" : "Private link related operations"
}, {
"name" : "Data quality metrics Service",
"description" : "Get data quality summary for account, catalog, schema or table level"
}, {
"name" : "SqlJobs Service",
"description" : "SQL jobs service that allows managing and executing scheduled SQL queries\n"
}, {
"name" : "LiveTable Service",
"description" : "Operations on live tables"
}, {
"name" : "KafkaIngestSource Service",
"description" : "Operations on Kafka ingest sources"
}, {
"name" : "FileIngestSource Service",
"description" : "Operations on file ingest sources"
}, {
"name" : "Data Quality Service",
"description" : "CRUD API for Data Quality checks - create, read, update, delete, and trigger data quality checks evaluations"
}, {
"name" : "Data Quality Schedule Service",
"description" : "Manage scheduled execution of data quality checks per table"
}, {
"name" : "About",
"description" : "APIs for managing your Starburst account.\n\n⬇️ Download OpenAPI specification\n"
}, {
"name" : "API Versions",
"description" : "Two versions of the Starburst Galaxy Public API are available:\n\n* **V1** — stable API covering account management, catalogs, clusters, roles, policies, and data discovery.\n\n [Download the V1 specification](/public/openapi/v1/json)\n\n* **V2** — introduces new versions of existing resources such as Data Products.\n\n [Download the V2 specification](/public/openapi/v2/json)\n"
}, {
"name" : "Access Tokens",
"description" : "Access tokens are obtained using the OAuth2 credentials flow and API authentication tokens.\n\n1. Create an API authentication token at `https://{account-domain}/api-auth-token`\n2. Use the API authentication token to obtain a temporary access token by POST to `https://{account-domain}/oauth/v2/token`. The request must have a Basic Authorization header with the client ID and secret Base64 encoded in the form `clientId:clientSecret`. The request body must be `grant_type=client_credentials`.\n\n`cURL` example:\n\n```\ncurl -X POST \\\n -H 'Authorization: Basic {base64(clientId:clientSecret)}' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'grant_type=client_credentials' \\\n https://{account-domain}/oauth/v2/token\n```\n\nThe access token returned can be used to make API calls with the header `Authorization: Bearer {access token}`.\n"
}, {
"name" : "Model Definitions",
"description" : ""
}, {
"name" : "Responses",
"description" : ""
} ],
"paths" : {
"/public/api/v1/cluster" : {
"get" : {
"tags" : [ "Cluster Service" ],
"description" : "Return the clusters of your account",
"operationId" : "listCluster",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
}, {
"in" : "query",
"name" : "extended",
"description" : "",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedCluster"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Cluster Service" ],
"description" : "Create a cluster",
"operationId" : "createCluster",
"parameters" : [ {
"in" : "query",
"name" : "extended",
"description" : "",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateCluster"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Cluster"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/cluster/{clusterId}" : {
"get" : {
"tags" : [ "Cluster Service" ],
"description" : "Get cluster by id",
"operationId" : "getCluster",
"parameters" : [ {
"in" : "path",
"name" : "clusterId",
"description" : "- A Trino cluster\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "extended",
"description" : "",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Cluster"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Cluster Service" ],
"description" : "Delete a cluster",
"operationId" : "deleteCluster",
"parameters" : [ {
"in" : "path",
"name" : "clusterId",
"description" : "- A Trino cluster\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Cluster Service" ],
"description" : "Update a cluster. Only the owner of the cluster can perform this operation\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateCluster",
"parameters" : [ {
"in" : "path",
"name" : "clusterId",
"description" : "- A Trino cluster\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "extended",
"description" : "",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateClusterPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Cluster"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/user" : {
"get" : {
"tags" : [ "User Service" ],
"description" : "Return a list of users",
"operationId" : "listUser",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedUser"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "User Service" ],
"description" : "Create a user",
"operationId" : "createUser",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateUser"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/User"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/user/{userId}" : {
"get" : {
"tags" : [ "User Service" ],
"description" : "Get a user",
"operationId" : "getUser",
"parameters" : [ {
"in" : "path",
"name" : "userId",
"description" : "- A user\n- This parameter can be looked up using `email` instead of its Id. Use `email=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/User"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "User Service" ],
"description" : "Update user role grants and default role\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateUser",
"parameters" : [ {
"in" : "path",
"name" : "userId",
"description" : "- A user\n- This parameter can be looked up using `email` instead of its Id. Use `email=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUserPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/User"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/role" : {
"get" : {
"tags" : [ "Role Service" ],
"description" : "Return a list of roles",
"operationId" : "listRole",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedRole"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Role Service" ],
"description" : "Create a role",
"operationId" : "createRole",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateRole"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Role"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/role/{roleId}" : {
"get" : {
"tags" : [ "Role Service" ],
"description" : "Get information about a role",
"operationId" : "getRole",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Role"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Role Service" ],
"description" : "Delete a role",
"operationId" : "deleteRole",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Role Service" ],
"description" : "Grant and revoke roles\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateRole",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRolePatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Role"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/role/{roleId}/rolegrant" : {
"get" : {
"tags" : [ "Role Service" ],
"description" : " List all users, groups, and roles a role has been granted to. This includes transitive grants.\n\n For example, if Role B has been granted to Role A, and Role C has been granted to Role B, the grants returned in this API for Role A will include both Role B and Role C.\n\n Similarly, in this example, if User Y and User Z both have been granted Role A, querying this API for Role C will include both users.\n Both users can assume Role C via their transitive grants of Role A.\n\n For more information about roles, please visit https://docs.starburst.io/starburst-galaxy/security/roles.html\n",
"operationId" : "listRoleRolegrant",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
}, {
"in" : "query",
"name" : "type",
"description" : "Query filter",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedRolegrant"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/group" : {
"get" : {
"tags" : [ "Group Service" ],
"description" : "Return a list of groups for the current account",
"operationId" : "listGroup",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedGroup"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/group/{groupId}" : {
"patch" : {
"tags" : [ "Group Service" ],
"description" : "Update roles assigned to a group\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateGroup",
"parameters" : [ {
"in" : "path",
"name" : "groupId",
"description" : "A group",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateGroupRoleGrantsPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Group"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/role/{roleId}/privilege:grant" : {
"post" : {
"tags" : [ "Privilege Service" ],
"description" : "Grant a privilege to a role",
"operationId" : "grantRolePrivilege",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Privilege"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/role/{roleId}/privilege" : {
"get" : {
"tags" : [ "Privilege Service" ],
"description" : "List all privileges granted to a role, or to all roles in that role's active role set if the listAllPrivileges parameter is set.\n\nThis endpoint may return stale data (from approximately five seconds before the time of the request) to ensure maximum performance.\n",
"operationId" : "listRolePrivilege",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
}, {
"in" : "query",
"name" : "listAllPrivileges",
"description" : "Lists all inherited and directly granted privileges if true, or only directly granted privileges if false.",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedGrantedPrivilege"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/role/{roleId}/privilege:revoke" : {
"post" : {
"tags" : [ "Privilege Service" ],
"description" : "Revoke a privilege from a role",
"operationId" : "revokeRolePrivilege",
"parameters" : [ {
"in" : "path",
"name" : "roleId",
"description" : "- A role\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RevokePrivilege"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/schemaDiscovery/{schemaDiscoveryId}:apply" : {
"post" : {
"tags" : [ "SchemaDiscovery Service" ],
"description" : "Execute SQL statements generated by schema discovery",
"operationId" : "applySchemaDiscovery",
"parameters" : [ {
"in" : "path",
"name" : "schemaDiscoveryId",
"description" : "A schema discovery run",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaDiscovery"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/schemaDiscovery/{schemaDiscoveryId}" : {
"get" : {
"tags" : [ "SchemaDiscovery Service" ],
"description" : "Get schema discovery by id",
"operationId" : "getSchemaDiscovery",
"parameters" : [ {
"in" : "path",
"name" : "schemaDiscoveryId",
"description" : "A schema discovery run",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaDiscovery"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "SchemaDiscovery Service" ],
"description" : "Delete schema discovery by schemaDiscoveryId. Discoveries in progress or ones that are latest applied for path cannot be deleted.",
"operationId" : "deleteSchemaDiscovery",
"parameters" : [ {
"in" : "path",
"name" : "schemaDiscoveryId",
"description" : "A schema discovery run",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schemaDiscovery" : {
"get" : {
"tags" : [ "SchemaDiscovery Service" ],
"description" : "Get schema discoveries for catalog. When getting all runs, they won't contain same level of detail as when getting run by its ID.",
"operationId" : "listCatalogSchemaDiscovery",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "latest",
"description" : "",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSchemaDiscovery"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "SchemaDiscovery Service" ],
"description" : "Run schema discovery under catalog, for specified uri. This operation is async and runs in background. It is important to check `status` field to make sure it has completed and results are ready.",
"operationId" : "createCatalogSchemaDiscovery",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RunSchemaDiscovery"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SchemaDiscovery"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/bigquery/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's BigQuery catalogs",
"operationId" : "listBigQueryCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedBigQueryCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a BigQuery catalog",
"operationId" : "createBigQueryCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateBigQueryCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BigQueryCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/cassandra/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's Cassandra catalogs",
"operationId" : "listCassandraCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedCassandraCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a Cassandra catalog",
"operationId" : "createCassandraCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateCassandraCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CassandraCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/gcs/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's GCS catalogs",
"operationId" : "listGcsCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedGcsCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a GCS catalog",
"operationId" : "createGcsCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateGcsCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GcsCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/mongodb/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's MongoDB catalogs",
"operationId" : "listMongoDBCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedMongoDBCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a MongoDB catalog",
"operationId" : "createMongoDBCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateMongoDBCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MongoDBCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/mysql/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's MySQL catalogs",
"operationId" : "listMySQLCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedMySQLCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a MySQL catalog",
"operationId" : "createMySQLCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateMySQLCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MySQLCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/opensearch/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's OpenSearch catalogs",
"operationId" : "listOpenSearchCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedOpenSearchCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a OpenSearch catalog",
"operationId" : "createOpenSearchCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateOpenSearchCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/postgresql/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's PostgreSQL catalogs",
"operationId" : "listPostgresqlCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedPostgresqlCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a PostgreSQL catalog",
"operationId" : "createPostgresqlCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePostgresqlCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PostgresqlCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/redshift/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's Redshift catalogs",
"operationId" : "listRedshiftCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedRedshiftCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a Redshift catalog",
"operationId" : "createRedshiftCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateRedshiftCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RedshiftCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/s3/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's S3 catalogs",
"operationId" : "listS3Catalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedS3Catalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create an S3 catalog",
"operationId" : "createS3Catalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateS3CatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/S3Catalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/snowflake/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's Snowflake catalogs",
"operationId" : "listSnowflakeCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSnowflakeCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a Snowflake catalog",
"operationId" : "createSnowflakeCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateSnowflakeCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SnowflakeCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/sqlserver/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's SQL Server catalogs",
"operationId" : "listSQLServerCatalogs",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSqlServerCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Catalog Service" ],
"description" : "Create a SQL Server catalog",
"operationId" : "createSqlServerCatalog",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateSqlServerCatalogRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlServerCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/bigquery/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a BigQuery catalog by id",
"operationId" : "getBigQueryCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to BigQuery",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BigQueryCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a BigQuery catalog",
"operationId" : "deleteBigQueryCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to BigQuery",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a BigQuery catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateBigQueryCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to BigQuery",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BigQueryCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BigQueryCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/cassandra/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a Cassandra catalog by id",
"operationId" : "getCassandraCatalogs",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Cassandra, with options for integration with AstraDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CassandraCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a Cassandra catalog",
"operationId" : "deleteCassandraCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Cassandra, with options for integration with AstraDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a Cassandra catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateCassandraCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Cassandra, with options for integration with AstraDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CassandraCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CassandraCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/gcs/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a GCS catalog by id",
"operationId" : "getGcsCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to GCS",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GcsCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a GCS catalog",
"operationId" : "deleteGcsCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to GCS",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a GCS catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateGcsCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to GCS",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GcsCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GcsCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/mongodb/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a MongoDB catalog by id",
"operationId" : "getMongoDBCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MongoDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MongoDBCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a MongoDB catalog",
"operationId" : "deleteMongoDBCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MongoDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a MongoDB catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateMongoDBCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MongoDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MongoDBCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MongoDBCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/mysql/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a MySQL catalog by id",
"operationId" : "getMySQLCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MySQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MySQLCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a MySQL catalog",
"operationId" : "deleteMySQLCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MySQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a MySQL catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateMySQLCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MySQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MySQLCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MySQLCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/opensearch/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a OpenSearch catalog by id",
"operationId" : "getOpenSearchCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to OpenSearch",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a OpenSearch catalog",
"operationId" : "deleteOpenSearchCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to OpenSearch",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a OpenSearch catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateOpenSearchCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to OpenSearch",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OpenSearchCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/postgresql/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a PostgreSQL catalog by id",
"operationId" : "getPostgresqlCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to PostgreSQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PostgresqlCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a PostgreSQL catalog",
"operationId" : "deletePostgresqlCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to PostgreSQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a PostgreSQL catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updatePostgresqlCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to PostgreSQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PostgresqlCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PostgresqlCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/redshift/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a Redshift catalog by id",
"operationId" : "getRedshiftCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to AWS Redshift",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RedshiftCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a Redshift catalog",
"operationId" : "deleteRedshiftCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to AWS Redshift",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a Redshift catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateRedshiftCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to AWS Redshift",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RedshiftCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RedshiftCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/s3/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get an S3 catalog by id",
"operationId" : "getS3Catalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to S3",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/S3Catalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete an S3 catalog",
"operationId" : "deleteS3Catalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to S3",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update an S3 catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateS3Catalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to S3",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/S3CatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/S3Catalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/snowflake/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a Snowflake catalog by id",
"operationId" : "getSnowflakeCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Snowflake",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SnowflakeCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a Snowflake catalog",
"operationId" : "deleteSnowflakeCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Snowflake",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a Snowflake catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateSnowflakeCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Snowflake",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SnowflakeCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SnowflakeCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/sqlserver/catalog/{catalogId}" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Get a SQL Server catalog by id",
"operationId" : "getSQLServerCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to SQL Server",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlServerCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Catalog Service" ],
"description" : "Delete a SQL Server catalog",
"operationId" : "deleteSqlServerCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to SQL Server",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Catalog Service" ],
"description" : "Update a SQL Server catalog\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateSqlServerCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to SQL Server",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlServerCatalogPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlServerCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "List an account's catalog identifiers",
"operationId" : "listCatalog",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedCatalog"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/bigquery/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a BigQuery catalog",
"operationId" : "validateBigQueryCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to BigQuery",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/cassandra/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a Cassandra catalog",
"operationId" : "validateCassandraCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Cassandra, with options for integration with AstraDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/gcs/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a GCS catalog",
"operationId" : "validateGcsCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to GCS",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/mongodb/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a MongoDB catalog",
"operationId" : "validateMongoDBCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MongoDB",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/mysql/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a MySQL catalog",
"operationId" : "validateMySQLCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to MySQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/opensearch/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a OpenSearch catalog",
"operationId" : "validateOpenSearchCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to OpenSearch",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/postgresql/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a PostgreSQL catalog",
"operationId" : "validatePostgresqlCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to PostgreSQL",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/redshift/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a Redshift catalog",
"operationId" : "validateRedshiftCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to AWS Redshift",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/s3/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate an S3 catalog",
"operationId" : "validateS3Catalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to S3",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/snowflake/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a Snowflake catalog",
"operationId" : "validateSnowflakeCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to Snowflake",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalogType/sqlserver/catalog/{catalogId}/validate" : {
"get" : {
"tags" : [ "Catalog Service" ],
"description" : "Test and validate a SQL Server catalog",
"operationId" : "validateSqlServerCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "A catalog connecting to SQL Server",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Validate"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}" : {
"delete" : {
"tags" : [ "Discovery Service" ],
"description" : "Delete catalog metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table/{tableId}/column/{columnId}" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return a specific column with any Galaxy added metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getCatalogSchemaTableColumn",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "columnId",
"description" : "A column from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Column"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Discovery Service" ],
"description" : "Delete column metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteSchemaTableColumnCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "columnId",
"description" : "A column from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Discovery Service" ],
"description" : "Update column metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateCatalogSchemaTableColumn",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "columnId",
"description" : "A column from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateColumnPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Column"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return a specific schema with any Galaxy added metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getCatalogSchema",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Schema"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Discovery Service" ],
"description" : "Delete schema metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteSchemaCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Discovery Service" ],
"description" : "Update schema metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateCatalogSchema",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateSchemaPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Schema"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table/{tableId}" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return a specific table with any Galaxy added metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getCatalogSchemaTable",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Table"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Discovery Service" ],
"description" : "Delete table metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteSchemaTableCatalog",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Discovery Service" ],
"description" : "Update table metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateCatalogSchemaTable",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTablePatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Table"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/catalogMetadata" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return catalog metadata with any Galaxy added metadata",
"operationId" : "getCatalogCatalogMetadata",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CatalogMetadata"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Discovery Service" ],
"description" : "Update catalog metadata\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateCatalogCatalogMetadata",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCatalogMetadataPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CatalogMetadata"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table/{tableId}/column" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return a catalog table's columns along with any Galaxy added metadata",
"operationId" : "listCatalogSchemaTableColumn",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedColumn"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Discovery Service" ],
"description" : "Update descriptions for multiple columns in a single request\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "discovery.patchUpdateCatalogSchemaTableColumn",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateColumnsPatch"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return a catalog's schemas along with any Galaxy added metadata",
"operationId" : "listCatalogSchema",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSchema"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table" : {
"get" : {
"tags" : [ "Discovery Service" ],
"description" : "Return a catalog schema's tables along with any Galaxy added metadata",
"operationId" : "listCatalogSchemaTable",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedTable"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/tag/{tagId}/catalog/{catalogId}" : {
"put" : {
"tags" : [ "Tag Service" ],
"description" : "Apply a tag to a catalog",
"operationId" : "updateCatalogTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Tag Service" ],
"description" : "Revoke a tag applied to a catalog",
"operationId" : "deleteCatalogTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/tag/{tagId}/catalog/{catalogId}/schema/{schemaId}/table/{tableId}/column/{columnId}" : {
"put" : {
"tags" : [ "Tag Service" ],
"description" : "Apply a tag to a column",
"operationId" : "updateCatalogSchemaTableColumnTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "columnId",
"description" : "A column from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Tag Service" ],
"description" : "Revoke a tag applied to a column",
"operationId" : "deleteCatalogSchemaTableColumnTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "columnId",
"description" : "A column from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/tag/{tagId}/catalog/{catalogId}/schema/{schemaId}" : {
"put" : {
"tags" : [ "Tag Service" ],
"description" : "Apply a tag to a schema",
"operationId" : "updateCatalogSchemaTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Tag Service" ],
"description" : "Revoke a tag applied to a schema",
"operationId" : "deleteCatalogSchemaTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/tag/{tagId}/catalog/{catalogId}/schema/{schemaId}/table/{tableId}" : {
"put" : {
"tags" : [ "Tag Service" ],
"description" : "Apply a tag to a table",
"operationId" : "updateCatalogSchemaTableTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Tag Service" ],
"description" : "Revoke a tag applied to a table",
"operationId" : "deleteCatalogSchemaTableTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "Aborted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Aborted"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/tag" : {
"get" : {
"tags" : [ "Tag Service" ],
"description" : "Return all tags defined for your account",
"operationId" : "listTag",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedTag"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Tag Service" ],
"description" : "Create a tag",
"operationId" : "createTag",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateTag"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/tag/{tagId}" : {
"get" : {
"tags" : [ "Tag Service" ],
"description" : "Get a tag by id",
"operationId" : "getTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Tag Service" ],
"description" : "Delete a tag",
"operationId" : "deleteTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Tag Service" ],
"description" : "Update a tag\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateTag",
"parameters" : [ {
"in" : "path",
"name" : "tagId",
"description" : "- A tag\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTagPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tag"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/rowFilter" : {
"get" : {
"tags" : [ "RowFilter Service" ],
"description" : "Return all row filters defined for your account",
"operationId" : "listRowFilter",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedRowFilter"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "RowFilter Service" ],
"description" : "Create a row filter",
"operationId" : "createRowFilter",
"parameters" : [ {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateRowFilter"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RowFilter"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/rowFilter/{rowFilterId}" : {
"get" : {
"tags" : [ "RowFilter Service" ],
"description" : "Get a row filter by id",
"operationId" : "getRowFilter",
"parameters" : [ {
"in" : "path",
"name" : "rowFilterId",
"description" : "- A row filter\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RowFilter"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "RowFilter Service" ],
"description" : "Delete a row filter",
"operationId" : "deleteRowFilter",
"parameters" : [ {
"in" : "path",
"name" : "rowFilterId",
"description" : "- A row filter\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "RowFilter Service" ],
"description" : "Update a row filter\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateRowFilter",
"parameters" : [ {
"in" : "path",
"name" : "rowFilterId",
"description" : "- A row filter\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RowFilterForUpdatePatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RowFilter"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/serviceAccount" : {
"get" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Return all service accounts defined for your account",
"operationId" : "listServiceAccount",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedServiceAccount"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Create a service account",
"operationId" : "createServiceAccount",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateServiceAccount"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceAccount"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/serviceAccount/{serviceAccountId}/serviceAccountPassword" : {
"post" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Create a new service account password. To construct the password to be used for querying, concatenate the following strings without the angle brackets: GXY$<passwordPrefix><password>. The values for these can be found in the reply JSON",
"operationId" : "createServiceAccountServiceAccountPassword",
"parameters" : [ {
"in" : "path",
"name" : "serviceAccountId",
"description" : "A service account",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateServiceAccountPassword"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceAccountPassword"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/serviceAccount/{serviceAccountId}" : {
"get" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Get a service account by user id",
"operationId" : "getServiceAccount",
"parameters" : [ {
"in" : "path",
"name" : "serviceAccountId",
"description" : "A service account",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceAccount"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Delete a service account",
"operationId" : "deleteServiceAccount",
"parameters" : [ {
"in" : "path",
"name" : "serviceAccountId",
"description" : "A service account",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Update a service account\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateServiceAccount",
"parameters" : [ {
"in" : "path",
"name" : "serviceAccountId",
"description" : "A service account",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateServiceAccountPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceAccount"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/serviceAccount/{serviceAccountId}/serviceAccountPassword/{serviceAccountPasswordId}" : {
"delete" : {
"tags" : [ "ServiceAccount Service" ],
"description" : "Delete a service account password",
"operationId" : "deleteServiceAccountPasswordServiceAccount",
"parameters" : [ {
"in" : "path",
"name" : "serviceAccountId",
"description" : "A service account",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "serviceAccountPasswordId",
"description" : "A service account password",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/columnMask" : {
"get" : {
"tags" : [ "ColumnMask Service" ],
"description" : "Return all column masks defined for your account",
"operationId" : "listColumnMask",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedColumnMask"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "ColumnMask Service" ],
"description" : "Create a column mask",
"operationId" : "createColumnMask",
"parameters" : [ {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateColumnMask"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ColumnMask"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/columnMask/{columnMaskId}" : {
"get" : {
"tags" : [ "ColumnMask Service" ],
"description" : "Get a column mask by id",
"operationId" : "getColumnMask",
"parameters" : [ {
"in" : "path",
"name" : "columnMaskId",
"description" : "- A column mask\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ColumnMask"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "ColumnMask Service" ],
"description" : "Delete a column mask",
"operationId" : "deleteColumnMask",
"parameters" : [ {
"in" : "path",
"name" : "columnMaskId",
"description" : "- A column mask\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "ColumnMask Service" ],
"description" : "Update a column mask\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateColumnMask",
"parameters" : [ {
"in" : "path",
"name" : "columnMaskId",
"description" : "- A column mask\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateColumnMaskPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ColumnMask"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/policy" : {
"get" : {
"tags" : [ "Policy Service" ],
"description" : "Return all policies defined for your account",
"operationId" : "listPolicy",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
}, {
"in" : "query",
"name" : "enablingRoleId",
"description" : "Query filter",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedPolicy"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Policy Service" ],
"description" : "Create a policy",
"operationId" : "createPolicy",
"parameters" : [ {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePolicy"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Policy"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/policy/{policyId}" : {
"get" : {
"tags" : [ "Policy Service" ],
"description" : "Get a policy by id",
"operationId" : "getPolicy",
"parameters" : [ {
"in" : "path",
"name" : "policyId",
"description" : "- A policy\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Policy"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Policy Service" ],
"description" : "Delete a policy",
"operationId" : "deletePolicy",
"parameters" : [ {
"in" : "path",
"name" : "policyId",
"description" : "- A policy\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Policy Service" ],
"description" : "Update a policy\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdatePolicy",
"parameters" : [ {
"in" : "path",
"name" : "policyId",
"description" : "- A policy\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "validateOnly",
"description" : "If true validate only without taking any action",
"required" : false,
"schema" : {
"type" : "boolean",
"nullable" : false
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdatePolicyPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Policy"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/dataProduct" : {
"get" : {
"tags" : [ "DataProduct Service" ],
"description" : "Return a paginated list of Data Products that are visible to the logged in role - DEPRECATED - Use listDataProductsV2. DataDomains are required part of DataProduct API. - Deprecation Date: 2026-12-31T23:59:59Z - New Implementation: public/api/v2/dataProduct",
"operationId" : "listDataProduct",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedDataProduct"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
},
"deprecated" : true
},
"post" : {
"tags" : [ "DataProduct Service" ],
"description" : "Create a Data Product - DEPRECATED - Use createDataProductV2, which requires a Data Domain to be specified at creation time. - Deprecation Date: 2026-12-31T23:59:59Z - New Implementation: public/api/v2/dataProduct",
"operationId" : "createDataProduct",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDataProduct"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataProduct"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
},
"deprecated" : true
}
},
"/public/api/v1/dataProduct/{dataProductId}" : {
"get" : {
"tags" : [ "DataProduct Service" ],
"description" : "Get Data Product by id - DEPRECATED - Use getDataProductV2. DataDomains are required part of DataProduct API. - Deprecation Date: 2026-12-31T23:59:59Z - New Implementation: public/api/v2/dataProduct/{dataProductId}",
"operationId" : "getDataProduct",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataProduct"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
},
"deprecated" : true
},
"delete" : {
"tags" : [ "DataProduct Service" ],
"description" : "Delete a Data Product - DEPRECATED - Use deleteDataProductV2. DataDomains are required part of DataProduct API. - Deprecation Date: 2026-12-31T23:59:59Z - New Implementation: public/api/v2/dataProduct/{dataProductId}",
"operationId" : "deleteDataProduct",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
},
"deprecated" : true
},
"patch" : {
"tags" : [ "DataProduct Service" ],
"description" : "Update a Data Product\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored. - DEPRECATED - Use updateDataProductV2. DataDomains are required part of DataProduct API. - Deprecation Date: 2026-12-31T23:59:59Z - New Implementation: public/api/v2/dataProduct/{dataProductId}",
"operationId" : "patchUpdateDataProduct",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDataProductPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataProduct"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
},
"deprecated" : true
}
},
"/public/api/v1/dataProduct/{dataProductId}/dataDomain" : {
"get" : {
"tags" : [ "DataProduct Service" ],
"description" : "Get the Data Domain id and name for a Data Product",
"operationId" : "getDataProductDataDomain",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataDomainIdAndName"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/dataDomain" : {
"get" : {
"tags" : [ "DataDomain Service" ],
"description" : "Return a paginated list of Data Domains\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "listDataDomain",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedDataDomain"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "DataDomain Service" ],
"description" : "Create a Data Domain\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "createDataDomain",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDataDomain"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataDomain"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"429" : {
"description" : "ResourceExhausted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResourceExhausted"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/dataDomain/{dataDomainId}" : {
"get" : {
"tags" : [ "DataDomain Service" ],
"description" : "Get Data Domain by id\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getDataDomain",
"parameters" : [ {
"in" : "path",
"name" : "dataDomainId",
"description" : "- A Galaxy Data Domain\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataDomain"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "DataDomain Service" ],
"description" : "Delete a Data Domain\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteDataDomain",
"parameters" : [ {
"in" : "path",
"name" : "dataDomainId",
"description" : "- A Galaxy Data Domain\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "DataDomain Service" ],
"description" : "Update a Data Domain\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateDataDomain",
"parameters" : [ {
"in" : "path",
"name" : "dataDomainId",
"description" : "- A Galaxy Data Domain\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDataDomainPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataDomain"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/dataDomain/{dataDomainId}/dataProductsReassignment" : {
"patch" : {
"tags" : [ "DataDomain Service" ],
"description" : "Reassign a set of data products into this data domain\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateDataDomainDataProductsReassignment",
"parameters" : [ {
"in" : "path",
"name" : "dataDomainId",
"description" : "- A Galaxy Data Domain\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataProductsReassignmentPatch"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/dataProduct/{dataProductId}/usageExample" : {
"get" : {
"tags" : [ "Data Product Usage Example Service" ],
"description" : "Return a paginated list of usage examples for a Data Product",
"operationId" : "listDataProductUsageExample",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedUsageExample"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Data Product Usage Example Service" ],
"description" : "Create a usage example for a Data Product",
"operationId" : "createDataProductUsageExample",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateUsageExample"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsageExample"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/dataProduct/{dataProductId}/usageExample/{usageExampleId}" : {
"delete" : {
"tags" : [ "Data Product Usage Example Service" ],
"description" : "Delete a usage example",
"operationId" : "deleteUsageExampleDataProduct",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "usageExampleId",
"description" : "A usage example for a Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Data Product Usage Example Service" ],
"description" : "Update a usage example\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateDataProductUsageExample",
"parameters" : [ {
"in" : "path",
"name" : "dataProductId",
"description" : "A Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "usageExampleId",
"description" : "A usage example for a Galaxy Data Product",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUsageExamplePatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UsageExample"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/crossAccountIamRole" : {
"get" : {
"tags" : [ "CrossAccountIamRole Service" ],
"description" : "List an account's cross account IAM roles",
"operationId" : "listCrossAccountIamRole",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedCrossAccountIamRole"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "CrossAccountIamRole Service" ],
"description" : "Create an AWS cross account IAM role",
"operationId" : "createCrossAccountIamRole",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateCrossAccountIamRole"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CrossAccountIamRole"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/crossAccountIamRole/{crossAccountIamRoleId}" : {
"delete" : {
"tags" : [ "CrossAccountIamRole Service" ],
"description" : "Delete an AWS cross account IAM role",
"operationId" : "deleteCrossAccountIamRole",
"parameters" : [ {
"in" : "path",
"name" : "crossAccountIamRoleId",
"description" : "An url-encoded AWS cross account IAM role ARN",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/crossAccountIamRoleMetadata" : {
"get" : {
"tags" : [ "CrossAccountIamRole Service" ],
"description" : "Get the account's metadata for cross account IAM roles",
"operationId" : "crossAccountIamRoleMetadata",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CrossAccountIamRoleMetadata"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/privatelink/{privatelinkId}" : {
"get" : {
"tags" : [ "Privatelink Service" ],
"description" : "Get a private link by ID",
"operationId" : "getPrivateLinkById",
"parameters" : [ {
"in" : "path",
"name" : "privatelinkId",
"description" : "- A private link\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Privatelink"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/privatelink" : {
"get" : {
"tags" : [ "Privatelink Service" ],
"description" : "Get all private links for your account",
"operationId" : "getPrivateLinks",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedPrivatelink"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/dataQualitySummary" : {
"get" : {
"tags" : [ "Data quality metrics Service" ],
"description" : "Get data quality summary for an account",
"operationId" : "getDataQualitySummary",
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityAccountSummary"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/dataQualitySummary" : {
"get" : {
"tags" : [ "Data quality metrics Service" ],
"description" : "Get data quality summary for a catalog",
"operationId" : "getCatalogDataQualitySummary",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCatalogSummary"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/dataQualitySummary" : {
"get" : {
"tags" : [ "Data quality metrics Service" ],
"description" : "Get data quality summary for a schema",
"operationId" : "getCatalogSchemaDataQualitySummary",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualitySchemaSummary"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table/{tableId}/dataQualitySummary" : {
"get" : {
"tags" : [ "Data quality metrics Service" ],
"description" : "Get data quality summary for a table",
"operationId" : "getCatalogSchemaTableDataQualitySummary",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityTableSummary"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/sqlJob" : {
"get" : {
"tags" : [ "SqlJobs Service" ],
"description" : "List SQL jobs",
"operationId" : "listSqlJob",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSqlJobListItem"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"put" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Update SQL job",
"operationId" : "updateSqlJob",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateSqlJob"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlJob"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Create SQL job",
"operationId" : "createSqlJob",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateSqlJob"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlJob"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/sqlJob/{sqlJobId}" : {
"get" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Get SQL job by id",
"operationId" : "getSqlJob",
"parameters" : [ {
"in" : "path",
"name" : "sqlJobId",
"description" : "SQL query scheduled job",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlJob"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Delete sql job",
"operationId" : "deleteSqlJob",
"parameters" : [ {
"in" : "path",
"name" : "sqlJobId",
"description" : "SQL query scheduled job",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlJob"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/sqlJob/{sqlJobId}:execute" : {
"put" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Execute SQL job",
"operationId" : "executeSqlJob",
"parameters" : [ {
"in" : "path",
"name" : "sqlJobId",
"description" : "SQL query scheduled job",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/sqlJob/{sqlJobId}/sqlJobHistory" : {
"get" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Get history of a SQL job",
"operationId" : "listSqlJobSqlJobHistory",
"parameters" : [ {
"in" : "path",
"name" : "sqlJobId",
"description" : "SQL query scheduled job",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSqlJobHistory"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/sqlJob/{sqlJobId}/sqlJobStatus" : {
"get" : {
"tags" : [ "SqlJobs Service" ],
"description" : "Get latest status of a SQL job",
"operationId" : "getSqlJobSqlJobStatus",
"parameters" : [ {
"in" : "path",
"name" : "sqlJobId",
"description" : "SQL query scheduled job",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SqlJobStatus"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/liveTable" : {
"get" : {
"tags" : [ "LiveTable Service" ],
"description" : "Returns all live tables in your account\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "listLiveTable",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedLiveTable"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "LiveTable Service" ],
"description" : "Creates a new live table\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "createLiveTable",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NewLiveTable"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LiveTable"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/liveTable/{liveTableId}" : {
"get" : {
"tags" : [ "LiveTable Service" ],
"description" : "Returns a live table by ID\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getLiveTable",
"parameters" : [ {
"in" : "path",
"name" : "liveTableId",
"description" : "A managed live table",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LiveTable"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"delete" : {
"tags" : [ "LiveTable Service" ],
"description" : "Deletes a live table\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteLiveTable",
"parameters" : [ {
"in" : "path",
"name" : "liveTableId",
"description" : "A managed live table",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/liveTable:brieflist" : {
"get" : {
"tags" : [ "LiveTable Service" ],
"description" : "Returns all live tables in your account, but in brief form, without all details\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "brieflistLiveTable",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedLiveTable"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/liveTable:schema" : {
"put" : {
"tags" : [ "LiveTable Service" ],
"description" : "Updates a live table's schema\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "schemaLiveTable",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransformLiveTableSchemaUpdate"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LiveTable"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/kafkaIngestSource" : {
"get" : {
"tags" : [ "KafkaIngestSource Service" ],
"description" : "Returns all Kafka ingest sources in your account\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "listKafkaIngestSource",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedKafkaIngestSource"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "KafkaIngestSource Service" ],
"description" : "Create a Kafka ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "createKafkaIngestSource",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NewKafkaIngestSource"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/KafkaIngestSource"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/kafkaIngestSource/{kafkaIngestSourceId}" : {
"get" : {
"tags" : [ "KafkaIngestSource Service" ],
"description" : "Returns a single kafka ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getKafkaIngestSource",
"parameters" : [ {
"in" : "path",
"name" : "kafkaIngestSourceId",
"description" : "A Kafka source from which ingest tables can be populated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/KafkaIngestSource"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "KafkaIngestSource Service" ],
"description" : "Deletes a Kafka ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteKafkaIngestSource",
"parameters" : [ {
"in" : "path",
"name" : "kafkaIngestSourceId",
"description" : "A Kafka source from which ingest tables can be populated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "KafkaIngestSource Service" ],
"description" : "Update a Kafka ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateKafkaIngestSource",
"parameters" : [ {
"in" : "path",
"name" : "kafkaIngestSourceId",
"description" : "A Kafka source from which ingest tables can be populated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/KafkaIngestSourceUpdatePatch"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/fileIngestSource" : {
"get" : {
"tags" : [ "FileIngestSource Service" ],
"description" : "Returns all file ingest sources in your account\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "listFileIngestSource",
"parameters" : [ {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedFileIngestSource"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "FileIngestSource Service" ],
"description" : "Create a file ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "createFileIngestSource",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NewFileIngestSource"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileIngestSource"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
}
},
"/public/api/v1/fileIngestSource/{fileIngestSourceId}" : {
"get" : {
"tags" : [ "FileIngestSource Service" ],
"description" : "Returns a single file ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "getFileIngestSource",
"parameters" : [ {
"in" : "path",
"name" : "fileIngestSourceId",
"description" : "A file source from which ingest tables can be populated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileIngestSource"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "FileIngestSource Service" ],
"description" : "Deletes a file ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.",
"operationId" : "deleteFileIngestSource",
"parameters" : [ {
"in" : "path",
"name" : "fileIngestSourceId",
"description" : "A file source from which ingest tables can be populated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "FileIngestSource Service" ],
"description" : "Update a file ingest source\n\n**BETA API:** This API is subject to incompatible changes, or even removal, in the future.\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "patchUpdateFileIngestSource",
"parameters" : [ {
"in" : "path",
"name" : "fileIngestSourceId",
"description" : "A file source from which ingest tables can be populated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileIngestSourceUpdatePatch"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/dataQualityCheck" : {
"get" : {
"tags" : [ "Data Quality Service" ],
"description" : "List all data quality check definitions for account with optional filters by catalog, schema, or table",
"operationId" : "listDataQualityChecks",
"parameters" : [ {
"in" : "query",
"name" : "catalogId",
"description" : "Query filter",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "schemaId",
"description" : "Query filter",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "tableId",
"description" : "Query filter",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageToken",
"description" : "Pagination token",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
"name" : "pageSize",
"description" : "Page size or 0 for default (current maximum is 100)",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer",
"nullable" : false
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedDataQualityCheckListItem"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Data Quality Service" ],
"description" : "Create a new data quality check definition",
"operationId" : "createDataQualityCheck",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDataQualityCheck"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCheckDetails"
}
}
}
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/dataQualityCheck/{dataQualityCheckId}" : {
"get" : {
"tags" : [ "Data Quality Service" ],
"description" : "Get data quality check definition by ID",
"operationId" : "getDataQualityCheckDetails",
"parameters" : [ {
"in" : "path",
"name" : "dataQualityCheckId",
"description" : "Data quality check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCheckDetails"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Data Quality Service" ],
"description" : "Delete a data quality check definition",
"operationId" : "deleteDataQualityCheck",
"parameters" : [ {
"in" : "path",
"name" : "dataQualityCheckId",
"description" : "Data quality check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCheckDetails"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Data Quality Service" ],
"description" : "Update an existing data quality check definition\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateDataQualityCheck",
"parameters" : [ {
"in" : "path",
"name" : "dataQualityCheckId",
"description" : "Data quality check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDataQualityCheckPatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCheckDetails"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/dataQualityCheck/{dataQualityCheckId}/evaluation" : {
"get" : {
"tags" : [ "Data Quality Service" ],
"description" : "Get status and result of a data quality check evaluation (pass/fail)",
"operationId" : "getDataQualityCheckEvaluations",
"parameters" : [ {
"in" : "path",
"name" : "dataQualityCheckId",
"description" : "Data quality check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCheckWithEvaluations"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Data Quality Service" ],
"description" : "Trigger a data quality check evaluation on demand",
"operationId" : "evaluateDataQualityCheck",
"parameters" : [ {
"in" : "path",
"name" : "dataQualityCheckId",
"description" : "Data quality check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EvaluateDataQualityCheck"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Success"
},
"404" : {
"description" : "NotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFoundError"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
}
}
}
},
"/public/api/v1/dataQualityCheck/{dataQualityCheckId}/evaluation:latest" : {
"get" : {
"tags" : [ "Data Quality Service" ],
"description" : "Get status of latest quality check evaluation",
"operationId" : "getLatestDataQualityCheckEvaluation",
"parameters" : [ {
"in" : "path",
"name" : "dataQualityCheckId",
"description" : "Data quality check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityCheckWithEvaluation"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table/{tableId}/dataQualitySchedule" : {
"get" : {
"tags" : [ "Data Quality Schedule Service" ],
"description" : "Get data quality schedule for a table",
"operationId" : "getDataQualitySchedule",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualityScheduleWithQualityChecks"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"post" : {
"tags" : [ "Data Quality Schedule Service" ],
"description" : "Create data quality schedule for a table",
"operationId" : "createDataQualitySchedule",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateDataQualitySchedule"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualitySchedule"
}
}
}
},
"412" : {
"description" : "FailedPrecondition",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailedPrecondition"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
},
"/public/api/v1/catalog/{catalogId}/schema/{schemaId}/table/{tableId}/dataQualitySchedule/{dataQualityScheduleId}" : {
"delete" : {
"tags" : [ "Data Quality Schedule Service" ],
"description" : "Delete data quality schedule for a table",
"operationId" : "deleteDataQualitySchedule",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "dataQualityScheduleId",
"description" : "Data quality schedule for a table",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Success"
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Data Quality Schedule Service" ],
"description" : "Update data quality schedule for a table\n\nOnly include fields you wish to update. Missing or unrecognized fields are ignored.",
"operationId" : "updateDataQualitySchedule",
"parameters" : [ {
"in" : "path",
"name" : "catalogId",
"description" : "- A catalog\n- This parameter can be looked up using `name` instead of its Id. Use `name=value` instead of an Id to lookup/search using the `value`. `value` must be encoded ([see RFC](https://www.rfc-editor.org/rfc/rfc3986#section-2.2) including `=`)\n",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "schemaId",
"description" : "A schema from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "tableId",
"description" : "A table from a catalog",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
"name" : "dataQualityScheduleId",
"description" : "Data quality schedule for a table",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDataQualitySchedulePatch"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DataQualitySchedule"
}
}
}
},
"400" : {
"description" : "ApiBadRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BadRequest"
}
}
}
},
"401" : {
"description" : "ApiUnauthorized",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Unauthorized"
}
}
}
},
"403" : {
"description" : "ApiForbidden",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Forbidden"
}
}
}
},
"409" : {
"description" : "ApiAlreadyExists",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Exists"
}
}
}
},
"404" : {
"description" : "ApiNotFound",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NotFound"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"Aborted" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Errorinfo"
}
},
"description" : "Concurrency conflict, such as read-modify-write conflict.",
"x-tags" : [ "Responses" ]
},
"AccessKey" : {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
},
"AlreadyExists" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Resourceinfo"
}
},
"description" : "The resource that a client tried to create already exists.",
"x-tags" : [ "Responses" ]
},
"ApacheCassandraConnection" : {
"properties" : {
"contactPoints" : {
"type" : "string",
"description" : "Cassandra hosts"
},
"localDatacenter" : {
"type" : "string",
"description" : "Local datacenter"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "Cassandra port. Defaults to 9042.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "Cassandra username"
},
"password" : {
"type" : "string",
"description" : "Cassandra password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Connect to Cassandra instance",
"x-tags" : [ "Model Definitions" ]
},
"AstraDBConnection" : {
"properties" : {
"databaseId" : {
"type" : "string",
"description" : "AstraDB database ID"
},
"region" : {
"type" : "string",
"description" : "AstraDB region"
},
"token" : {
"type" : "string",
"description" : "AstraDB token"
}
},
"description" : "Connect to AstraDB instance",
"x-tags" : [ "Model Definitions" ]
},
"BadRequest" : {
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"fields" : {
"type" : "array",
"description" : "Any fields/values that are invalid or incorrect",
"items" : {
"type" : "string",
"description" : "Any fields/values that are invalid or incorrect"
}
}
},
"description" : "Invalid request",
"x-tags" : [ "Responses" ]
},
"Badrequest" : {
"required" : [ "fieldViolations" ],
"properties" : {
"fieldViolations" : {
"type" : "array",
"description" : "Field violations (read only)",
"items" : {
"$ref" : "#/components/schemas/Fieldviolation"
}
}
},
"description" : "Error details (read only)",
"x-tags" : [ "Responses" ]
},
"Basic" : {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
},
"BasicAwsCredentials" : {
"properties" : {
"accessKeyId" : {
"type" : "string",
"description" : "AWS access key ID"
},
"secretAccessKey" : {
"type" : "string",
"description" : "AWS secret access key"
}
},
"description" : "AWS access key and secret credentials",
"x-tags" : [ "Model Definitions" ]
},
"BigQueryCatalog" : {
"required" : [ "catalogId", "credentialsKey", "name", "readOnly", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "BigQuery catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"credentialsKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text BigQuery JSON key"
},
"projectId" : {
"type" : "string",
"description" : "The Google Cloud Project ID. Mutually required with parentProjectId"
},
"parentProjectId" : {
"type" : "string",
"description" : "The Google Cloud Project ID to bill for the export. Mutually required with projectId"
}
},
"description" : "A catalog connecting to BigQuery",
"x-tags" : [ "Model Definitions" ]
},
"BigQueryCatalogPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"credentialsKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text BigQuery JSON key"
},
"projectId" : {
"type" : "string",
"description" : "The Google Cloud Project ID. Mutually required with parentProjectId"
},
"parentProjectId" : {
"type" : "string",
"description" : "The Google Cloud Project ID to bill for the export. Mutually required with projectId"
}
},
"description" : "A catalog connecting to BigQuery",
"x-tags" : [ "Model Definitions" ]
},
"CassandraCatalog" : {
"required" : [ "catalogId", "deploymentType", "name", "readOnly", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "Cassandra catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "Cassandra cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"deploymentType" : {
"type" : "string"
}
},
"description" : "A catalog connecting to Cassandra, with options for integration with AstraDB",
"discriminator" : {
"propertyName" : "deploymentType",
"mapping" : {
"apacheCassandra" : "#/components/schemas/CassandraCatalogApacheCassandraConnection",
"astraDB" : "#/components/schemas/CassandraCatalogAstraDBConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CassandraCatalogApacheCassandraConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CassandraCatalog"
}, {
"required" : [ "contactPoints", "localDatacenter", "password", "username" ],
"properties" : {
"contactPoints" : {
"type" : "string",
"description" : "Cassandra hosts"
},
"localDatacenter" : {
"type" : "string",
"description" : "Local datacenter"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "Cassandra port. Defaults to 9042.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "Cassandra username"
},
"password" : {
"type" : "string",
"description" : "Cassandra password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Connect to Cassandra instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CassandraCatalogAstraDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CassandraCatalog"
}, {
"required" : [ "databaseId", "region", "token" ],
"properties" : {
"databaseId" : {
"type" : "string",
"description" : "AstraDB database ID"
},
"region" : {
"type" : "string",
"description" : "AstraDB region"
},
"token" : {
"type" : "string",
"description" : "AstraDB token"
}
},
"description" : "Connect to AstraDB instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CassandraCatalogPatch" : {
"required" : [ "deploymentType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "Cassandra cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"deploymentType" : {
"type" : "string"
}
},
"description" : "A catalog connecting to Cassandra, with options for integration with AstraDB",
"discriminator" : {
"propertyName" : "deploymentType",
"mapping" : {
"apacheCassandra" : "#/components/schemas/CassandraCatalogPatchApacheCassandraConnection",
"astraDB" : "#/components/schemas/CassandraCatalogPatchAstraDBConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CassandraCatalogPatchApacheCassandraConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CassandraCatalogPatch"
}, {
"properties" : {
"contactPoints" : {
"type" : "string",
"description" : "Cassandra hosts"
},
"localDatacenter" : {
"type" : "string",
"description" : "Local datacenter"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "Cassandra port. Defaults to 9042.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "Cassandra username"
},
"password" : {
"type" : "string",
"description" : "Cassandra password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Connect to Cassandra instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CassandraCatalogPatchAstraDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CassandraCatalogPatch"
}, {
"properties" : {
"databaseId" : {
"type" : "string",
"description" : "AstraDB database ID"
},
"region" : {
"type" : "string",
"description" : "AstraDB region"
},
"token" : {
"type" : "string",
"description" : "AstraDB token"
}
},
"description" : "Connect to AstraDB instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"Catalog" : {
"required" : [ "catalogId", "catalogName" ],
"properties" : {
"catalogId" : {
"type" : "string",
"description" : "Catalog ID (read only)"
},
"catalogName" : {
"type" : "string",
"description" : "Catalog name (read only)"
}
},
"description" : "A catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"CatalogDataQualityChecksRollup" : {
"required" : [ "catalogId", "catalogName", "evaluatedChecks", "failedChecks", "notYetEvaluatedChecks", "numberOfChecks", "successfulChecks" ],
"properties" : {
"catalogId" : {
"type" : "string",
"description" : "Catalog ID (read only)"
},
"catalogName" : {
"type" : "string",
"description" : "Catalog name (read only)"
},
"numberOfChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Total number of quality checks",
"nullable" : false
},
"evaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of evaluated quality checks",
"nullable" : false
},
"failedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of failed quality checks",
"nullable" : false
},
"successfulChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of successful quality checks",
"nullable" : false
},
"notYetEvaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of not yet evaluated quality checks",
"nullable" : false
}
},
"description" : "Summaries per catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"CatalogMetadata" : {
"required" : [ "catalogId", "catalogName", "contacts", "tags" ],
"properties" : {
"catalogId" : {
"type" : "string",
"description" : "Catalog ID (read only)"
},
"catalogName" : {
"type" : "string",
"description" : "Catalog name (read only)"
},
"description" : {
"type" : "string",
"description" : "Any description set for this catalog (read only)"
},
"owner" : {
"$ref" : "#/components/schemas/RoleWithName2"
},
"tags" : {
"type" : "array",
"description" : "Any tags set for this catalog (read only)",
"items" : {
"$ref" : "#/components/schemas/TagName"
}
},
"contacts" : {
"type" : "array",
"description" : "Any contacts set for this catalog (read only)",
"items" : {
"$ref" : "#/components/schemas/UserAndEmail"
}
}
},
"description" : "A catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"CategoryEvaluationCounts" : {
"required" : [ "category", "failedEvaluations", "successfulEvaluations", "totalEvaluations" ],
"properties" : {
"category" : {
"type" : "string",
"description" : "Data quality check category",
"enum" : [ "Validity", "Completeness", "Consistency", "Accuracy", "None" ]
},
"totalEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Total evaluations",
"nullable" : false
},
"successfulEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Successful evaluations",
"nullable" : false
},
"failedEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Failed evaluations",
"nullable" : false
}
},
"description" : "Counts grouped by category (read only)",
"x-tags" : [ "Model Definitions" ]
},
"CloudStorageCredentials" : {
"required" : [ "credentialsType" ],
"properties" : {
"credentialsType" : {
"type" : "string"
}
},
"description" : "Cloud storage credentials",
"discriminator" : {
"propertyName" : "credentialsType",
"mapping" : {
"basicAwsCredentials" : "#/components/schemas/CloudStorageCredentialsBasicAwsCredentials",
"externalIamRole" : "#/components/schemas/CloudStorageCredentialsExternalIamRole"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CloudStorageCredentialsBasicAwsCredentials" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CloudStorageCredentials"
}, {
"required" : [ "accessKeyId", "secretAccessKey" ],
"properties" : {
"accessKeyId" : {
"type" : "string",
"description" : "AWS access key ID"
},
"secretAccessKey" : {
"type" : "string",
"description" : "AWS secret access key"
}
},
"description" : "AWS access key and secret credentials",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CloudStorageCredentialsExternalIamRole" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CloudStorageCredentials"
}, {
"required" : [ "externalRoleArn" ],
"properties" : {
"externalRoleArn" : {
"type" : "string",
"description" : "ARN of the external IAM role"
}
},
"description" : "External IAM role credentials",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CloudStorageCredentialsPatch" : {
"required" : [ "credentialsType" ],
"properties" : {
"credentialsType" : {
"type" : "string"
}
},
"description" : "New cloud storage credentials for the source",
"discriminator" : {
"propertyName" : "credentialsType",
"mapping" : {
"basicAwsCredentials" : "#/components/schemas/CloudStorageCredentialsPatchBasicAwsCredentialsPatch",
"externalIamRole" : "#/components/schemas/CloudStorageCredentialsPatchExternalIamRolePatch"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CloudStorageCredentialsPatchBasicAwsCredentialsPatch" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CloudStorageCredentialsPatch"
}, {
"properties" : {
"accessKeyId" : {
"type" : "string",
"description" : "AWS access key ID"
},
"secretAccessKey" : {
"type" : "string",
"description" : "AWS secret access key"
}
},
"description" : "AWS access key and secret credentials",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CloudStorageCredentialsPatchExternalIamRolePatch" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CloudStorageCredentialsPatch"
}, {
"properties" : {
"externalRoleArn" : {
"type" : "string",
"description" : "ARN of the external IAM role"
}
},
"description" : "External IAM role credentials",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"Cluster" : {
"required" : [ "batchCluster", "catalogRefs", "cloudRegionId", "clusterId", "maxWorkers", "minWorkers", "name", "syncToken", "warpSpeedCluster" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"clusterId" : {
"type" : "string",
"description" : "Cluster ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Cluster name (read only)"
},
"cloudRegionId" : {
"type" : "string",
"description" : "Cloud region ID (read only)"
},
"catalogRefs" : {
"type" : "array",
"description" : "Cluster attached catalog IDs (read only)",
"items" : {
"type" : "string",
"description" : "Cluster attached catalog IDs (read only)"
}
},
"idleStopMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "Idle stop duration (in minutes) (read only)",
"nullable" : false
},
"batchCluster" : {
"type" : "boolean",
"description" : "Supports resource intensive query processing mode (read only)",
"nullable" : false
},
"warpSpeedCluster" : {
"type" : "boolean",
"description" : "Supports warp speed mode (read only)",
"nullable" : false
},
"minWorkers" : {
"format" : "int32",
"type" : "integer",
"description" : "Minimum worker count (read only)",
"nullable" : false
},
"maxWorkers" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum worker count (read only)",
"nullable" : false
},
"replicas" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of replicas (read only)",
"nullable" : false
},
"clusterState" : {
"type" : "string",
"description" : "Cluster state (read only)"
},
"trinoUri" : {
"type" : "string",
"description" : "Connection URL (read only)"
},
"processingMode" : {
"type" : "string",
"description" : "Cluster query processing mode (extended field) (read only)",
"enum" : [ "Batch", "WarpSpeed" ]
},
"privateLinkCluster" : {
"type" : "boolean",
"description" : "Private Link enabled (extended field) (read only)",
"nullable" : false
},
"resultCacheEnabled" : {
"type" : "boolean",
"description" : "Result cache enabled (extended field) (read only)",
"nullable" : false
},
"resultCacheDefaultVisibilitySeconds" : {
"format" : "int64",
"type" : "integer",
"description" : "Default visibility for result cache in seconds (extended field) (read only)",
"nullable" : false
},
"enabled" : {
"type" : "boolean",
"description" : "Cluster enabled state (extended field) (read only)",
"nullable" : false
}
},
"description" : "A Trino cluster",
"x-tags" : [ "Model Definitions" ]
},
"Column" : {
"required" : [ "columnId", "nullable", "tags" ],
"properties" : {
"columnId" : {
"type" : "string",
"description" : "Column ID (read only)"
},
"dataType" : {
"type" : "string",
"description" : "Any data type returned from the data source (read only)"
},
"columnDefault" : {
"type" : "string",
"description" : "Any column default returned from the data source (read only)"
},
"nullable" : {
"type" : "boolean",
"description" : "Whether the column is nullable or not (read only)",
"nullable" : false
},
"description" : {
"type" : "string",
"description" : "Any description set for this column (read only)"
},
"tags" : {
"type" : "array",
"description" : "Any tags set for this column (read only)",
"items" : {
"$ref" : "#/components/schemas/TagName"
}
}
},
"description" : "A column from a catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"ColumnMask" : {
"required" : [ "columnMaskId", "columnMaskType", "created", "description", "expression", "modified", "name", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"columnMaskId" : {
"type" : "string",
"description" : "Column Mask ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Column Mask name (read only)"
},
"expression" : {
"type" : "string",
"description" : "Column Mask expression (read only)"
},
"columnMaskType" : {
"type" : "string",
"description" : "Column Mask type (read only)",
"enum" : [ "Any", "Integer", "Boolean", "Date", "Decimal", "Real", "Double", "Timestamp", "TimestampWithTimeZone", "Time", "TimeWithTimeZone", "Varbinary", "Varchar" ]
},
"description" : {
"type" : "string",
"description" : "Description (read only)"
},
"created" : {
"format" : "date-time",
"type" : "string",
"description" : "Created on (read only)"
},
"modified" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified on (read only)"
}
},
"description" : "A column mask",
"x-tags" : [ "Model Definitions" ]
},
"CreateBigQueryCatalogRequest" : {
"required" : [ "credentialsKey", "name", "readOnly" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"credentialsKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text BigQuery JSON key"
},
"projectId" : {
"type" : "string",
"description" : "The Google Cloud Project ID. Mutually required with parentProjectId"
},
"parentProjectId" : {
"type" : "string",
"description" : "The Google Cloud Project ID to bill for the export. Mutually required with projectId"
}
},
"description" : "Create a new BigQuery catalog",
"x-tags" : [ "Model Definitions" ]
},
"CreateCassandraCatalogRequest" : {
"required" : [ "deploymentType", "name", "readOnly" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "Cassandra cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"deploymentType" : {
"type" : "string"
}
},
"description" : "Create a new Cassandra catalog, with options to also allow configuring AstraDB connectivity",
"discriminator" : {
"propertyName" : "deploymentType",
"mapping" : {
"apacheCassandra" : "#/components/schemas/CreateCassandraCatalogRequestApacheCassandraConnection",
"astraDB" : "#/components/schemas/CreateCassandraCatalogRequestAstraDBConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateCassandraCatalogRequestApacheCassandraConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateCassandraCatalogRequest"
}, {
"required" : [ "contactPoints", "localDatacenter", "password", "username" ],
"properties" : {
"contactPoints" : {
"type" : "string",
"description" : "Cassandra hosts"
},
"localDatacenter" : {
"type" : "string",
"description" : "Local datacenter"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "Cassandra port. Defaults to 9042.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "Cassandra username"
},
"password" : {
"type" : "string",
"description" : "Cassandra password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Connect to Cassandra instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateCassandraCatalogRequestAstraDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateCassandraCatalogRequest"
}, {
"required" : [ "databaseId", "region", "token" ],
"properties" : {
"databaseId" : {
"type" : "string",
"description" : "AstraDB database ID"
},
"region" : {
"type" : "string",
"description" : "AstraDB region"
},
"token" : {
"type" : "string",
"description" : "AstraDB token"
}
},
"description" : "Connect to AstraDB instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateCluster" : {
"required" : [ "catalogRefs", "cloudRegionId", "maxWorkers", "minWorkers", "name", "privateLinkCluster", "resultCacheEnabled", "warpResiliencyEnabled" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the cluster being created"
},
"cloudRegionId" : {
"type" : "string",
"description" : "Cloud region ID of where the cluster will be created"
},
"catalogRefs" : {
"type" : "array",
"description" : "Catalog IDs to attach to the cluster",
"items" : {
"type" : "string",
"description" : "Catalog IDs to attach to the cluster"
}
},
"idleStopMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "Idle suspend duration (in minutes)",
"nullable" : false
},
"processingMode" : {
"type" : "string",
"description" : "Cluster query processing mode",
"enum" : [ "Batch", "WarpSpeed" ]
},
"minWorkers" : {
"format" : "int32",
"type" : "integer",
"description" : "Minimum worker count",
"nullable" : false
},
"maxWorkers" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum worker count",
"nullable" : false
},
"warpResiliencyEnabled" : {
"type" : "boolean",
"description" : "Enable/Disable warp resiliency",
"nullable" : false
},
"resultCacheEnabled" : {
"type" : "boolean",
"description" : "Enable/Disable resultset caching",
"nullable" : false
},
"resultCacheDefaultVisibilitySeconds" : {
"format" : "int64",
"type" : "integer",
"description" : "Default visibility for resultset caching (in seconds)",
"nullable" : false
},
"privateLinkCluster" : {
"type" : "boolean",
"description" : "Private Link Enabled",
"nullable" : false
},
"replicas" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of replicas",
"nullable" : false
}
},
"description" : "Create a Trino cluster",
"x-tags" : [ "Model Definitions" ]
},
"CreateColumnMask" : {
"required" : [ "columnMaskType", "description", "expression", "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Column mask name (read only)"
},
"expression" : {
"type" : "string",
"description" : "Column mask expression (read only)"
},
"columnMaskType" : {
"type" : "string",
"description" : "Column mask type (read only)",
"enum" : [ "Any", "Integer", "Boolean", "Date", "Decimal", "Real", "Double", "Timestamp", "TimestampWithTimeZone", "Time", "TimeWithTimeZone", "Varbinary", "Varchar" ]
},
"description" : {
"type" : "string",
"description" : "Description (read only)"
}
},
"description" : "A new column mask",
"x-tags" : [ "Model Definitions" ]
},
"CreateCrossAccountIamRole" : {
"required" : [ "aliasName", "awsIamArn" ],
"properties" : {
"awsIamArn" : {
"type" : "string",
"description" : "AWS IAM role ARN (read only)"
},
"aliasName" : {
"type" : "string",
"description" : "AWS IAM role alias name (read only)"
}
},
"description" : "An AWS cross account IAM role",
"x-tags" : [ "Model Definitions" ]
},
"CreateDataDomain" : {
"required" : [ "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Data Domain name"
},
"description" : {
"type" : "string",
"description" : "Long form description of the Data Domain"
},
"contactUserId" : {
"type" : "string",
"description" : "Data Domain contact"
},
"roleId" : {
"type" : "string",
"description" : "Owning role ID"
}
},
"description" : "Create a Galaxy Data Domain",
"x-tags" : [ "Model Definitions" ]
},
"CreateDataProduct" : {
"required" : [ "catalogId", "contacts", "name", "schemaName", "summary" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Data Product name"
},
"summary" : {
"type" : "string",
"description" : "Short summary of Data Product"
},
"description" : {
"type" : "string",
"description" : "Long form description of Data Product"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID"
},
"schemaName" : {
"type" : "string",
"description" : "Name of the data product schema"
},
"contacts" : {
"type" : "array",
"description" : "Data Product contacts",
"items" : {
"$ref" : "#/components/schemas/UserAndEmail"
}
},
"links" : {
"type" : "array",
"description" : "Any links for this Data Product",
"items" : {
"$ref" : "#/components/schemas/Link"
}
},
"defaultClusterId" : {
"type" : "string",
"description" : "Default cluster ID for Data Product"
},
"businessContext" : {
"type" : "string",
"description" : "Business context for the Data Product, used to guide AI agents"
}
},
"description" : "Create a Galaxy Data Product",
"x-tags" : [ "Model Definitions" ]
},
"CreateDataQualityCheck" : {
"required" : [ "catalogId", "category", "kind", "name", "query", "schemaId", "severity", "tableId" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the data quality check"
},
"description" : {
"type" : "string",
"description" : "Description of what this check validates"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID"
},
"schemaId" : {
"type" : "string",
"description" : "Schema ID"
},
"tableId" : {
"type" : "string",
"description" : "Table ID"
},
"query" : {
"type" : "string",
"description" : "Either expression or SQL query that implements the data quality check logic."
},
"severity" : {
"type" : "string",
"description" : "Severity level of check failures",
"enum" : [ "Low", "Medium", "High", "Critical" ]
},
"category" : {
"type" : "string",
"description" : "Category of data quality check",
"enum" : [ "Validity", "Completeness", "Consistency", "Accuracy", "None" ]
},
"kind" : {
"type" : "string",
"description" : "Kind of data quality check",
"enum" : [ "QualityExpression", "SqlQuery" ]
},
"clusterId" : {
"type" : "string",
"description" : "ClusterId to validate expression on. Required for 'SqlQuery' kind quality checks. If missing, attempt will be made to use cluster that was already configured for the schedule."
}
},
"description" : "Create data quality check request",
"x-tags" : [ "Model Definitions" ]
},
"CreateDataQualitySchedule" : {
"required" : [ "clusterId", "cronExpression", "roleId" ],
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Role used when checks are executed"
},
"clusterId" : {
"type" : "string",
"description" : "Cluster in which checks are executed"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated. Defaults to UTC"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines SQL job execution interval"
}
},
"description" : "Create data quality schedule for a table",
"x-tags" : [ "Model Definitions" ]
},
"CreateGcsCatalogRequest" : {
"required" : [ "credentialsKey", "metastoreType", "name", "readOnly" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"credentialsKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text GCS JSON key"
},
"metastoreType" : {
"type" : "string"
},
"defaultTableFormat" : {
"type" : "string",
"description" : "Default table format for new tables: ICEBERG, DELTA, or HIVE. Defaults to ICEBERG."
},
"externalTableCreationEnabled" : {
"type" : "boolean",
"description" : "Allow creating external tables. Defaults to false.",
"nullable" : false
},
"externalTableWritesEnabled" : {
"type" : "boolean",
"description" : "Allow writing to external tables. Defaults to false.",
"nullable" : false
},
"metadataMaxStalenessSeconds" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum metadata staleness in seconds (30, 60, 90, or 120)",
"nullable" : false
}
},
"description" : "Create a new GCS catalog",
"discriminator" : {
"propertyName" : "metastoreType",
"mapping" : {
"galaxy" : "#/components/schemas/CreateGcsCatalogRequestGcsGalaxyMetastore",
"hive" : "#/components/schemas/CreateGcsCatalogRequestGcsHiveMetastore"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateGcsCatalogRequestGcsGalaxyMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateGcsCatalogRequest"
}, {
"required" : [ "defaultBucket", "defaultDataLocation" ],
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "GCS bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateGcsCatalogRequestGcsHiveMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateGcsCatalogRequest"
}, {
"required" : [ "hiveMetastoreHost" ],
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateMongoDBCatalogRequest" : {
"required" : [ "connectionType", "name", "password", "readOnly", "regions", "username" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "MongoDB cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"connectionType" : {
"type" : "string"
},
"regions" : {
"type" : "array",
"description" : "MongoDB regions",
"items" : {
"type" : "string",
"description" : "MongoDB regions"
}
},
"username" : {
"type" : "string",
"description" : "MongoDB username"
},
"password" : {
"type" : "string",
"description" : "MongoDB password"
},
"dnsSeedListEnabled" : {
"type" : "boolean",
"description" : "Use DNS seed list (SRV). Defaults to false.",
"nullable" : false
},
"tlsEnabled" : {
"type" : "boolean",
"description" : "Use TLS for connections. Defaults to true.",
"nullable" : false
},
"federatedDatabaseEnabled" : {
"type" : "boolean",
"description" : "Is federated database. Defaults to false.",
"nullable" : false
}
},
"description" : "Create a new MongoDB catalog",
"discriminator" : {
"propertyName" : "connectionType",
"mapping" : {
"direct" : "#/components/schemas/CreateMongoDBCatalogRequestDirectMongoDBConnection",
"sshTunnel" : "#/components/schemas/CreateMongoDBCatalogRequestSshTunnelMongoDBConnection",
"privateLink" : "#/components/schemas/CreateMongoDBCatalogRequestPrivateLinkMongoDBConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateMongoDBCatalogRequestDirectMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateMongoDBCatalogRequest"
}, {
"required" : [ "hosts" ],
"properties" : {
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect directly to MongoDB instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateMongoDBCatalogRequestPrivateLinkMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateMongoDBCatalogRequest"
}, {
"required" : [ "privateLinkId" ],
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MongoDB via PrivateLink",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateMongoDBCatalogRequestSshTunnelMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateMongoDBCatalogRequest"
}, {
"required" : [ "hosts", "sshTunnelId" ],
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect to MongoDB via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateMySQLCatalogRequest" : {
"required" : [ "connectionType", "name", "password", "readOnly", "username" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "MySQL cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"connectionType" : {
"type" : "string"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "MySQL database port. Defaults to 3306.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "MySQL database username"
},
"password" : {
"type" : "string",
"description" : "MySQL database password"
}
},
"description" : "Create a new MySQL catalog",
"discriminator" : {
"propertyName" : "connectionType",
"mapping" : {
"direct" : "#/components/schemas/CreateMySQLCatalogRequestDirectMySQLConnection",
"sshTunnel" : "#/components/schemas/CreateMySQLCatalogRequestSshTunnelMySQLConnection",
"privateLink" : "#/components/schemas/CreateMySQLCatalogRequestPrivateLinkMySQLConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateMySQLCatalogRequestDirectMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateMySQLCatalogRequest"
}, {
"required" : [ "host" ],
"properties" : {
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect directly to MySQL instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateMySQLCatalogRequestPrivateLinkMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateMySQLCatalogRequest"
}, {
"required" : [ "privateLinkId" ],
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MySQL via PrivateLink",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateMySQLCatalogRequestSshTunnelMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateMySQLCatalogRequest"
}, {
"required" : [ "host", "sshTunnelId" ],
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect to MySQL via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateOpenSearchCatalogRequest" : {
"required" : [ "authType", "endpoint", "name", "readOnly" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"authType" : {
"type" : "string"
},
"endpoint" : {
"type" : "string",
"description" : "OpenSearch cluster endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "OpenSearch cluster port. Defaults to 443.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Create a new OpenSearch catalog",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"basic" : "#/components/schemas/CreateOpenSearchCatalogRequestOpenSearchBasicAuth",
"accessKey" : "#/components/schemas/CreateOpenSearchCatalogRequestOpenSearchAccessKeyAuth",
"role" : "#/components/schemas/CreateOpenSearchCatalogRequestOpenSearchCrossAccountRoleAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateOpenSearchCatalogRequestOpenSearchAccessKeyAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateOpenSearchCatalogRequest"
}, {
"required" : [ "accessKey", "region", "secretKey" ],
"properties" : {
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateOpenSearchCatalogRequestOpenSearchBasicAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateOpenSearchCatalogRequest"
}, {
"required" : [ "password", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateOpenSearchCatalogRequestOpenSearchCrossAccountRoleAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateOpenSearchCatalogRequest"
}, {
"required" : [ "region", "roleArn" ],
"properties" : {
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreatePolicy" : {
"required" : [ "description", "name", "predicate", "roleId", "scopes" ],
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Enabling role id (read only)"
},
"name" : {
"type" : "string",
"description" : "Policy name (read only)"
},
"predicate" : {
"type" : "string",
"description" : "Policy predicate (read only)"
},
"description" : {
"type" : "string",
"description" : "Policy description (read only)"
},
"expiration" : {
"format" : "date-time",
"type" : "string",
"description" : "Policy expiration (read only)"
},
"scopes" : {
"type" : "array",
"description" : "Policy scopes (read only)",
"items" : {
"$ref" : "#/components/schemas/PolicyScope"
}
}
},
"description" : "A new policy",
"x-tags" : [ "Model Definitions" ]
},
"CreatePostgresqlCatalogRequest" : {
"required" : [ "databaseName", "name", "password", "readOnly", "username" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "PostgreSQL cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"endpoint" : {
"type" : "string",
"description" : "PostgreSQL database endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "PostgreSQL database port. Defaults to 5432.",
"nullable" : false
},
"databaseName" : {
"type" : "string",
"description" : "PostgreSQL database name"
},
"username" : {
"type" : "string",
"description" : "PostgreSQL database username"
},
"password" : {
"type" : "string",
"description" : "PostgreSQL database password"
},
"tlsEnabled" : {
"type" : "boolean",
"description" : "Use TLS for PostgreSQL connections. Defaults to true.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink identifier"
}
},
"description" : "Create a new PostgreSQL catalog",
"x-tags" : [ "Model Definitions" ]
},
"CreateRedshiftCatalogRequest" : {
"required" : [ "authType", "endpoint", "name", "readOnly" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"endpoint" : {
"type" : "string",
"description" : "Redshift cluster endpoint"
},
"authType" : {
"type" : "string"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Create a new Redshift catalog",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"basic" : "#/components/schemas/CreateRedshiftCatalogRequestBasic",
"accessKey" : "#/components/schemas/CreateRedshiftCatalogRequestAccessKey",
"role" : "#/components/schemas/CreateRedshiftCatalogRequestRedshiftCrossAccountRoleAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateRedshiftCatalogRequestAccessKey" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateRedshiftCatalogRequest"
}, {
"required" : [ "accessKey", "region", "secretKey", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateRedshiftCatalogRequestBasic" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateRedshiftCatalogRequest"
}, {
"required" : [ "password", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateRedshiftCatalogRequestRedshiftCrossAccountRoleAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateRedshiftCatalogRequest"
}, {
"required" : [ "region", "roleArn", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateRole" : {
"required" : [ "grantToCreatingRole", "roleName" ],
"properties" : {
"roleName" : {
"type" : "string",
"description" : "Role name (read only)"
},
"roleDescription" : {
"type" : "string",
"description" : "Role description (read only)"
},
"grantToCreatingRole" : {
"type" : "boolean",
"description" : "Grant to creating role (read only)",
"nullable" : false
}
},
"description" : "A role",
"x-tags" : [ "Model Definitions" ]
},
"CreateRowFilter" : {
"required" : [ "description", "expression", "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Row filter name (read only)"
},
"expression" : {
"type" : "string",
"description" : "Row filter expression (read only)"
},
"description" : {
"type" : "string",
"description" : "Description (read only)"
}
},
"description" : "A new row filter",
"x-tags" : [ "Model Definitions" ]
},
"CreateS3CatalogRequest" : {
"required" : [ "metastoreType", "name", "readOnly" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"metastoreType" : {
"type" : "string"
},
"defaultTableFormat" : {
"type" : "string",
"description" : "Default table format for new tables: ICEBERG, DELTA, or HIVE. Defaults to ICEBERG."
},
"externalTableCreationEnabled" : {
"type" : "boolean",
"description" : "Allow creating external tables. Defaults to false.",
"nullable" : false
},
"externalTableWritesEnabled" : {
"type" : "boolean",
"description" : "Allow writing to external tables. Defaults to false.",
"nullable" : false
},
"metadataMaxStalenessSeconds" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum metadata staleness in seconds (30, 60, 90, or 120)",
"nullable" : false
}
},
"description" : "Create a new S3 catalog",
"discriminator" : {
"propertyName" : "metastoreType",
"mapping" : {
"galaxy" : "#/components/schemas/CreateS3CatalogRequestGalaxyMetastore",
"glue" : "#/components/schemas/CreateS3CatalogRequestGlueMetastore",
"hive" : "#/components/schemas/CreateS3CatalogRequestHiveMetastore"
}
},
"x-tags" : [ "Model Definitions" ]
},
"CreateS3CatalogRequestGalaxyMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateS3CatalogRequest"
}, {
"required" : [ "defaultBucket", "defaultDataLocation" ],
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateS3CatalogRequestGlueMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateS3CatalogRequest"
}, {
"required" : [ "defaultBucket", "defaultDataLocation", "region" ],
"properties" : {
"region" : {
"type" : "string",
"description" : "AWS region"
},
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
},
"glueAccessKey" : {
"type" : "string",
"description" : "AWS access key for AWS Glue access"
},
"glueSecretKey" : {
"type" : "string",
"description" : "AWS secret key for AWS Glue access"
},
"glueRoleArn" : {
"type" : "string",
"description" : "AWS cross account role for AWS Glue access"
}
},
"description" : "Store metadata in AWS Glue",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateS3CatalogRequestHiveMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/CreateS3CatalogRequest"
}, {
"required" : [ "hiveMetastoreHost" ],
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"CreateServiceAccount" : {
"required" : [ "additionalRoleIds", "username", "withInitialPassword" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Service account name (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Default role ID (read only)"
},
"additionalRoleIds" : {
"type" : "array",
"description" : "Additional role IDs (read only)",
"items" : {
"type" : "string",
"description" : "Additional role IDs (read only)"
}
},
"withInitialPassword" : {
"type" : "boolean",
"description" : "Whether to create an initial password (read only)",
"nullable" : false
}
},
"description" : "A service account",
"x-tags" : [ "Model Definitions" ]
},
"CreateServiceAccountPassword" : {
"properties" : {
"description" : {
"type" : "string",
"description" : "Service account password description (read only)"
}
},
"description" : "A service account password",
"x-tags" : [ "Model Definitions" ]
},
"CreateSnowflakeCatalogRequest" : {
"required" : [ "accountIdentifier", "databaseName", "name", "readOnly", "username" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "Snowflake cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"accountIdentifier" : {
"type" : "string",
"description" : "Snowflake account identifier"
},
"databaseName" : {
"type" : "string",
"description" : "Snowflake database name"
},
"username" : {
"type" : "string",
"description" : "Snowflake username"
},
"password" : {
"type" : "string",
"description" : "Snowflake password"
},
"privateKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text PEM Snowflake private key"
},
"privateKeyPassphrase" : {
"type" : "string",
"description" : "Snowflake private key passphrase"
},
"authenticationType" : {
"type" : "string",
"description" : "Snowflake authentication type"
},
"warehouse" : {
"type" : "string",
"description" : "Snowflake warehouse name"
},
"role" : {
"type" : "string",
"description" : "Snowflake role"
}
},
"description" : "Create a new Snowflake catalog",
"x-tags" : [ "Model Definitions" ]
},
"CreateSqlJob" : {
"required" : [ "clusterId", "cronExpression", "name", "queries", "roleId" ],
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Role used when SQL job is executed (read only)"
},
"name" : {
"type" : "string",
"description" : "SQL job name (read only)"
},
"description" : {
"type" : "string",
"description" : "SQL job description (read only)"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated. Defaults to UTC (read only)"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines SQL job execution interval (read only)"
},
"clusterId" : {
"type" : "string",
"description" : "ID of cluster in which SQL job gets executed (read only)"
},
"queries" : {
"type" : "array",
"description" : "SQL queries to execute. (read only)",
"items" : {
"type" : "string",
"description" : "SQL queries to execute. (read only)"
}
}
},
"description" : "Create SQL job",
"x-tags" : [ "Model Definitions" ]
},
"CreateSqlServerCatalogRequest" : {
"required" : [ "databaseName", "name", "password", "readOnly", "username" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "SQL Server cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"endpoint" : {
"type" : "string",
"description" : "SQL Server database endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "SQL Server database port. Defaults to 1433.",
"nullable" : false
},
"databaseName" : {
"type" : "string",
"description" : "SQL Server database name"
},
"username" : {
"type" : "string",
"description" : "SQL Server database username"
},
"password" : {
"type" : "string",
"description" : "SQL Server database password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink identifier"
}
},
"description" : "Create a new SQL Server catalog",
"x-tags" : [ "Model Definitions" ]
},
"CreateTag" : {
"required" : [ "color", "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Tag name (read only)"
},
"color" : {
"type" : "string",
"description" : "Tag color (read only)"
},
"description" : {
"type" : "string",
"description" : "comment (read only)"
}
},
"description" : "A tag",
"x-tags" : [ "Model Definitions" ]
},
"CreateUsageExample" : {
"required" : [ "code", "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Usage Example name"
},
"description" : {
"type" : "string",
"description" : "Optional description of the usage example"
},
"code" : {
"type" : "string",
"description" : "SQL code for the usage example"
},
"suggestedPrompt" : {
"type" : "string",
"description" : "Optional suggested natural-language prompt for the usage example"
}
},
"description" : "Create a usage example for a Galaxy Data Product",
"x-tags" : [ "Model Definitions" ]
},
"CreateUser" : {
"required" : [ "email", "roleId", "roleIds" ],
"properties" : {
"email" : {
"type" : "string",
"description" : "Email (read only)"
},
"roleIds" : {
"type" : "array",
"description" : "Role IDs (read only)",
"items" : {
"type" : "string",
"description" : "Role IDs (read only)"
}
},
"roleId" : {
"type" : "string",
"description" : "Default role (read only)"
}
},
"description" : "A new user",
"x-tags" : [ "Model Definitions" ]
},
"CrossAccountIamRole" : {
"required" : [ "aliasName", "awsIamArn", "dependants" ],
"properties" : {
"awsIamArn" : {
"type" : "string",
"description" : "AWS IAM role ARN (read only)"
},
"aliasName" : {
"type" : "string",
"description" : "AWS IAM role alias name (read only)"
},
"dependants" : {
"type" : "array",
"description" : "List of catalogs or ingest sources attached to the role (read only)",
"items" : {
"type" : "string",
"description" : "List of catalogs or ingest sources attached to the role (read only)"
}
}
},
"description" : "An AWS cross account IAM role (read only)",
"x-tags" : [ "Model Definitions" ]
},
"CrossAccountIamRoleMetadata" : {
"required" : [ "externalId", "starburstAwsAccountId" ],
"properties" : {
"externalId" : {
"type" : "string",
"description" : "External id (read only)"
},
"starburstAwsAccountId" : {
"type" : "string",
"description" : "Starburst AWS account id (read only)"
}
},
"description" : "An AWS cross account IAM role metadata (read only)",
"x-tags" : [ "Model Definitions" ]
},
"CsvParameters" : {
"required" : [ "delimiter", "escapeChar", "numHeaderLinesToExclude", "quoteChar" ],
"properties" : {
"delimiter" : {
"type" : "string",
"description" : "CSV delimiter character",
"enum" : [ "Comma", "Tab", "Pipe", "Semicolon" ]
},
"quoteChar" : {
"type" : "string",
"description" : "CSV quote character",
"enum" : [ "DoubleQuote", "SingleQuote" ]
},
"escapeChar" : {
"type" : "string",
"description" : "CSV escape character",
"enum" : [ "DoubleQuote", "Backslash" ]
},
"numHeaderLinesToExclude" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of CSV header lines to exclude",
"nullable" : false
}
},
"description" : "CSV format parameters. Required for CSV format, must be absent for other formats",
"x-tags" : [ "Model Definitions" ]
},
"DailyQualityEvaluationSummary" : {
"required" : [ "day", "failedEvaluations", "successfulEvaluations", "totalEvaluations" ],
"properties" : {
"day" : {
"format" : "date",
"type" : "string",
"description" : "Summarization day"
},
"totalEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of total evaluations conducted on the specified day",
"nullable" : false
},
"successfulEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of successful evaluations conducted on the specified day",
"nullable" : false
},
"failedEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of failed evaluations conducted on the specified day",
"nullable" : false
}
},
"description" : "Summaries for each day (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataDomain" : {
"required" : [ "assignedDataProducts", "createdOn", "dataDomainId", "isDefault", "modifiedOn", "name", "owningRole", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"dataDomainId" : {
"type" : "string",
"description" : "Data Domain ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Domain name (read only)"
},
"description" : {
"type" : "string",
"description" : "Description of the Data Domain (read only)"
},
"contact" : {
"$ref" : "#/components/schemas/UserAndEmail2"
},
"isDefault" : {
"type" : "boolean",
"description" : "True if this is the account's default domain (read only)",
"nullable" : false
},
"assignedDataProducts" : {
"type" : "array",
"description" : "Data products assigned to this domain (read only)",
"items" : {
"$ref" : "#/components/schemas/DataProductIdAndName"
}
},
"owningRole" : {
"$ref" : "#/components/schemas/RoleWithName"
},
"createdOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation date (read only)"
},
"modifiedOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified date (read only)"
},
"createdBy" : {
"$ref" : "#/components/schemas/UserAndEmail2"
},
"modifiedBy" : {
"$ref" : "#/components/schemas/UserAndEmail2"
}
},
"description" : "A Galaxy Data Domain",
"x-tags" : [ "Model Definitions" ]
},
"DataDomainIdAndName" : {
"required" : [ "dataDomainId", "name" ],
"properties" : {
"dataDomainId" : {
"type" : "string",
"description" : "Data Domain ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Domain name (read only)"
}
},
"description" : "A data domain id and name",
"x-tags" : [ "Model Definitions" ]
},
"DataProduct" : {
"required" : [ "contacts", "createdOn", "dataProductId", "links", "modifiedOn", "name", "summary", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"dataProductId" : {
"type" : "string",
"description" : "Data Product ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Product name (read only)"
},
"summary" : {
"type" : "string",
"description" : "Short summary of Data Product (read only)"
},
"description" : {
"type" : "string",
"description" : "Long form description of Data Product (read only)"
},
"catalog" : {
"$ref" : "#/components/schemas/DataProductCatalogDetails"
},
"schemaName" : {
"type" : "string",
"description" : "Name of the data product schema (read only)"
},
"contacts" : {
"type" : "array",
"description" : "Data Product contacts (read only)",
"items" : {
"$ref" : "#/components/schemas/UserAndEmail"
}
},
"links" : {
"type" : "array",
"description" : "Any links for this Data Product (read only)",
"items" : {
"$ref" : "#/components/schemas/Link"
}
},
"defaultClusterId" : {
"type" : "string",
"description" : "Default cluster ID for Data Product (read only)"
},
"createdOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation date (read only)"
},
"modifiedOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified date (read only)"
},
"createdBy" : {
"$ref" : "#/components/schemas/UserAndEmail2"
},
"modifiedBy" : {
"$ref" : "#/components/schemas/UserAndEmail2"
},
"businessContext" : {
"type" : "string",
"description" : "Business context for the Data Product, used to guide AI agents (read only)"
}
},
"description" : "A Galaxy Data Product",
"x-tags" : [ "Model Definitions" ]
},
"DataProductCatalogDetails" : {
"required" : [ "catalogId", "catalogKind", "catalogName", "localRegions" ],
"properties" : {
"catalogId" : {
"type" : "string",
"description" : "Catalog Id (read only)"
},
"catalogName" : {
"type" : "string",
"description" : "Name of the catalog (read only)"
},
"catalogKind" : {
"type" : "string",
"description" : "Kind of catalog (read only)"
},
"localRegions" : {
"type" : "array",
"description" : "Set of local regions for the catalog (read only)",
"items" : {
"type" : "string",
"description" : "Set of local regions for the catalog (read only)"
}
}
},
"description" : "Catalog details (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataProductIdAndName" : {
"required" : [ "dataProductId", "name" ],
"properties" : {
"dataProductId" : {
"type" : "string",
"description" : "Data Product ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Product name (read only)"
}
},
"description" : "Data products assigned to this domain (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataProductsReassignmentPatch" : {
"properties" : {
"dataProductIds" : {
"type" : "array",
"description" : "Data product IDs to reassign",
"items" : {
"type" : "string",
"description" : "Data product IDs to reassign"
}
}
},
"description" : "Data products to reassign into a data domain",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityAccountSummary" : {
"required" : [ "catalogSummaries", "categoryCounts", "dailySummaries", "severityCounts" ],
"properties" : {
"dailySummaries" : {
"type" : "array",
"description" : "Summaries for each day (read only)",
"items" : {
"$ref" : "#/components/schemas/DailyQualityEvaluationSummary"
}
},
"catalogSummaries" : {
"type" : "array",
"description" : "Summaries per catalog (read only)",
"items" : {
"$ref" : "#/components/schemas/CatalogDataQualityChecksRollup"
}
},
"severityCounts" : {
"type" : "array",
"description" : "Counts grouped by severities (read only)",
"items" : {
"$ref" : "#/components/schemas/SeverityEvaluationCounts"
}
},
"categoryCounts" : {
"type" : "array",
"description" : "Counts grouped by category (read only)",
"items" : {
"$ref" : "#/components/schemas/CategoryEvaluationCounts"
}
}
},
"description" : "Data quality account summary (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCatalogSummary" : {
"required" : [ "categoryCounts", "dailySummaries", "schemaSummaries", "severityCounts" ],
"properties" : {
"dailySummaries" : {
"type" : "array",
"description" : "Summaries for each day (read only)",
"items" : {
"$ref" : "#/components/schemas/DailyQualityEvaluationSummary"
}
},
"schemaSummaries" : {
"type" : "array",
"description" : "Summaries per schema (read only)",
"items" : {
"$ref" : "#/components/schemas/SchemaDataQualityChecksRollup"
}
},
"severityCounts" : {
"type" : "array",
"description" : "Counts grouped by severities (read only)",
"items" : {
"$ref" : "#/components/schemas/SeverityEvaluationCounts"
}
},
"categoryCounts" : {
"type" : "array",
"description" : "Counts grouped by category (read only)",
"items" : {
"$ref" : "#/components/schemas/CategoryEvaluationCounts"
}
}
},
"description" : "Data quality catalog summary (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheck" : {
"required" : [ "dataQualityCheckId", "name" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Quality check name"
}
},
"description" : "List of data quality checks (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckDetails" : {
"required" : [ "catalogId", "category", "dataQualityCheckId", "kind", "name", "query", "schemaId", "severity", "syncToken", "tableId" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Quality check name"
},
"description" : {
"type" : "string",
"description" : "Description of what this check validates"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID"
},
"schemaId" : {
"type" : "string",
"description" : "Schema ID"
},
"tableId" : {
"type" : "string",
"description" : "Table ID"
},
"query" : {
"type" : "string",
"description" : "Either expression or SQL query that implements the data quality check logic."
},
"kind" : {
"type" : "string",
"description" : "Kind of data quality check.",
"enum" : [ "QualityExpression", "SqlQuery" ]
},
"severity" : {
"type" : "string",
"description" : "Severity level of check failures",
"enum" : [ "Low", "Medium", "High", "Critical" ]
},
"category" : {
"type" : "string",
"description" : "Category of data quality check",
"enum" : [ "Validity", "Completeness", "Consistency", "Accuracy", "None" ]
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
}
},
"description" : "Data quality check definition",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckEvaluation" : {
"required" : [ "evaluatedAt", "predicate", "status" ],
"properties" : {
"evaluatedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "Time of evaluation (read only)"
},
"basedOnStatsAt" : {
"format" : "date-time",
"type" : "string",
"description" : "For 'QualityExpression' kind quality checks - time of stats that were used to evaluate. (read only)"
},
"status" : {
"type" : "string",
"description" : "Evaluation Status (read only)",
"enum" : [ "Failure", "Success" ]
},
"predicate" : {
"type" : "string",
"description" : "Predicate used for evaluation (read only)"
}
},
"description" : "List of evaluations",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckEvaluation2" : {
"required" : [ "evaluatedAt", "predicate", "status" ],
"properties" : {
"evaluatedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "Time of evaluation (read only)"
},
"basedOnStatsAt" : {
"format" : "date-time",
"type" : "string",
"description" : "For 'QualityExpression' kind quality checks - time of stats that were used to evaluate. (read only)"
},
"status" : {
"type" : "string",
"description" : "Evaluation Status (read only)",
"enum" : [ "Failure", "Success" ]
},
"predicate" : {
"type" : "string",
"description" : "Predicate used for evaluation (read only)"
}
},
"description" : "Latest evaluation (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckListItem" : {
"required" : [ "catalogId", "dataQualityCheckId", "name", "schemaId", "syncToken", "tableId" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Quality check name"
},
"description" : {
"type" : "string",
"description" : "Description of what this check validates"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID"
},
"schemaId" : {
"type" : "string",
"description" : "Schema ID"
},
"tableId" : {
"type" : "string",
"description" : "Table ID"
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
}
},
"description" : "Summary of a data quality check for list operations (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckRollup" : {
"required" : [ "dataQualityCheckId", "evaluatedChecks", "failedChecks", "name", "notYetEvaluatedChecks", "numberOfChecks", "successfulChecks" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Quality check name"
},
"numberOfChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Total number of quality checks",
"nullable" : false
},
"evaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of evaluated quality checks",
"nullable" : false
},
"failedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of failed quality checks",
"nullable" : false
},
"successfulChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of successful quality checks",
"nullable" : false
},
"notYetEvaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of not yet evaluated quality checks",
"nullable" : false
}
},
"description" : "Summaries per quality check (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckWithEvaluation" : {
"required" : [ "catalogId", "category", "dataQualityCheckId", "kind", "name", "query", "schemaId", "severity", "syncToken", "tableId" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Quality check name"
},
"description" : {
"type" : "string",
"description" : "Description of what this check validates"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID"
},
"schemaId" : {
"type" : "string",
"description" : "Schema ID"
},
"tableId" : {
"type" : "string",
"description" : "Table ID"
},
"query" : {
"type" : "string",
"description" : "Either expression or SQL query that implements the data quality check logic."
},
"kind" : {
"type" : "string",
"description" : "Kind of data quality check.",
"enum" : [ "QualityExpression", "SqlQuery" ]
},
"severity" : {
"type" : "string",
"description" : "Severity level of check failures",
"enum" : [ "Low", "Medium", "High", "Critical" ]
},
"category" : {
"type" : "string",
"description" : "Category of data quality check",
"enum" : [ "Validity", "Completeness", "Consistency", "Accuracy", "None" ]
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"latestEvaluation" : {
"$ref" : "#/components/schemas/DataQualityCheckEvaluation2"
}
},
"description" : "Data quality with latest evaluation",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityCheckWithEvaluations" : {
"required" : [ "catalogId", "category", "dataQualityCheckId", "evaluations", "kind", "name", "query", "schemaId", "severity", "syncToken", "tableId" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Data Quality check name"
},
"description" : {
"type" : "string",
"description" : "Description of what this check validates"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID"
},
"schemaId" : {
"type" : "string",
"description" : "Schema ID"
},
"tableId" : {
"type" : "string",
"description" : "Table ID"
},
"query" : {
"type" : "string",
"description" : "Either expression or SQL query that implements the data quality check logic."
},
"kind" : {
"type" : "string",
"description" : "Kind of data quality check.",
"enum" : [ "QualityExpression", "SqlQuery" ]
},
"severity" : {
"type" : "string",
"description" : "Severity level of check failures",
"enum" : [ "Low", "Medium", "High", "Critical" ]
},
"category" : {
"type" : "string",
"description" : "Category of data quality check",
"enum" : [ "Validity", "Completeness", "Consistency", "Accuracy", "None" ]
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"evaluations" : {
"type" : "array",
"description" : "List of evaluations",
"items" : {
"$ref" : "#/components/schemas/DataQualityCheckEvaluation"
}
}
},
"description" : "Data quality check with evaluation list",
"x-tags" : [ "Model Definitions" ]
},
"DataQualitySchedule" : {
"required" : [ "clusterId", "cronExpression", "dataQualityScheduleId", "enabled", "nextExecution", "roleId", "syncToken", "timezone" ],
"properties" : {
"dataQualityScheduleId" : {
"type" : "string",
"description" : "Data Quality Schedule ID (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Role used when checks are executed"
},
"clusterId" : {
"type" : "string",
"description" : "Cluster in which checks are executed"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines execution interval"
},
"nextExecution" : {
"format" : "date-time",
"type" : "string",
"description" : "Date and time of the next scheduled execution"
},
"enabled" : {
"type" : "boolean",
"description" : "Is schedule enabled",
"nullable" : false
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
}
},
"description" : "Data quality schedule for a table (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityScheduleWithQualityChecks" : {
"required" : [ "clusterId", "cronExpression", "dataQualityChecks", "dataQualityScheduleId", "enabled", "nextExecution", "roleId", "syncToken", "timezone" ],
"properties" : {
"dataQualityScheduleId" : {
"type" : "string",
"description" : "Data Quality Schedule ID (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Role used when checks are executed"
},
"clusterId" : {
"type" : "string",
"description" : "Cluster in which checks are executed"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines execution interval"
},
"nextExecution" : {
"format" : "date-time",
"type" : "string",
"description" : "Date and time of the next scheduled execution"
},
"enabled" : {
"type" : "boolean",
"description" : "Is schedule enabled",
"nullable" : false
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"dataQualityChecks" : {
"type" : "array",
"description" : "List of data quality checks (read only)",
"items" : {
"$ref" : "#/components/schemas/DataQualityCheck"
}
}
},
"description" : "Data quality schedule for a table (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualitySchemaSummary" : {
"required" : [ "categoryCounts", "dailySummaries", "severityCounts", "tableSummaries" ],
"properties" : {
"dailySummaries" : {
"type" : "array",
"description" : "Summaries for each day (read only)",
"items" : {
"$ref" : "#/components/schemas/DailyQualityEvaluationSummary"
}
},
"tableSummaries" : {
"type" : "array",
"description" : "Summaries per table (read only)",
"items" : {
"$ref" : "#/components/schemas/TableDataQualityChecksRollup"
}
},
"severityCounts" : {
"type" : "array",
"description" : "Counts grouped by severities (read only)",
"items" : {
"$ref" : "#/components/schemas/SeverityEvaluationCounts"
}
},
"categoryCounts" : {
"type" : "array",
"description" : "Counts grouped by category (read only)",
"items" : {
"$ref" : "#/components/schemas/CategoryEvaluationCounts"
}
}
},
"description" : "Data quality schema summary (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DataQualityTableSummary" : {
"required" : [ "categoryCounts", "dailySummaries", "qualityCheckSummaries", "severityCounts" ],
"properties" : {
"dailySummaries" : {
"type" : "array",
"description" : "Summaries for each day (read only)",
"items" : {
"$ref" : "#/components/schemas/DailyQualityEvaluationSummary"
}
},
"qualityCheckSummaries" : {
"type" : "array",
"description" : "Summaries per quality check (read only)",
"items" : {
"$ref" : "#/components/schemas/DataQualityCheckRollup"
}
},
"severityCounts" : {
"type" : "array",
"description" : "Counts grouped by severities (read only)",
"items" : {
"$ref" : "#/components/schemas/SeverityEvaluationCounts"
}
},
"categoryCounts" : {
"type" : "array",
"description" : "Counts grouped by category (read only)",
"items" : {
"$ref" : "#/components/schemas/CategoryEvaluationCounts"
}
}
},
"description" : "Data quality summary (read only)",
"x-tags" : [ "Model Definitions" ]
},
"DirectMongoDBConnection" : {
"properties" : {
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect directly to MongoDB instance",
"x-tags" : [ "Model Definitions" ]
},
"DirectMySQLConnection" : {
"properties" : {
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect directly to MySQL instance",
"x-tags" : [ "Model Definitions" ]
},
"DiscoveredSqlStatement" : {
"required" : [ "sql", "status" ],
"properties" : {
"sql" : {
"type" : "string",
"description" : "Raw generated SQL (read only)"
},
"status" : {
"type" : "string",
"description" : "Status of the statement (read only)",
"enum" : [ "Waiting", "Applying", "Success", "Errored", "Canceled" ]
},
"message" : {
"type" : "string",
"description" : "Message describing statement or error message in case of execution failure (read only)"
}
},
"description" : "Generated SQL statements (read only)",
"x-tags" : [ "Model Definitions" ]
},
"Errorinfo" : {
"required" : [ "metadata", "reason" ],
"properties" : {
"reason" : {
"type" : "string",
"description" : "Error reason/detail (read only)"
},
"metadata" : {
"type" : "object",
"description" : "Any additional details (read only)",
"additionalProperties" : {
"type" : "string",
"description" : "Any additional details (read only)"
}
}
},
"description" : "Error details (read only)",
"x-tags" : [ "Responses" ]
},
"EvaluateDataQualityCheck" : {
"required" : [ "dataQualityCheckId" ],
"properties" : {
"dataQualityCheckId" : {
"type" : "string",
"description" : "Data Quality check ID (read only)"
},
"clusterId" : {
"type" : "string",
"description" : "Cluster ID where data quality check is executed (SQL quality checks only)"
}
},
"description" : "Data quality check",
"x-tags" : [ "Model Definitions" ]
},
"ExistingJsonIngestColumn" : {
"required" : [ "columnId", "fieldParserConfig", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newJsonIngestColumnInSchemaUpdate" : "#/components/schemas/UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate2",
"existingJsonIngestColumn" : "#/components/schemas/UpdatedJsonIngestColumnExistingJsonIngestColumn"
}
},
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "An existing column; same ID but other properties may differ",
"x-tags" : [ "Model Definitions" ]
},
"Exists" : {
"properties" : {
"message" : {
"type" : "string",
"description" : ""
}
},
"description" : "Already exists",
"x-tags" : [ "Responses" ]
},
"ExternalIamRole" : {
"properties" : {
"externalRoleArn" : {
"type" : "string",
"description" : "ARN of the external IAM role"
}
},
"description" : "External IAM role credentials",
"x-tags" : [ "Model Definitions" ]
},
"FailedPrecondition" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Preconditionfailure"
}
},
"description" : "Request can not be executed in the current system state, such as deleting a non-empty directory.",
"x-tags" : [ "Responses" ]
},
"FanoutColumn" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
},
"Fieldviolation" : {
"required" : [ "description", "field" ],
"properties" : {
"field" : {
"type" : "string",
"description" : "Field name"
},
"description" : {
"type" : "string",
"description" : "Description of the violation"
}
},
"description" : "Field violations (read only)",
"x-tags" : [ "Responses" ]
},
"FileIngestProperties" : {
"required" : [ "fileFormat", "fileIngestSourceId", "pollingIntervalInMinutes" ],
"properties" : {
"fileIngestSourceId" : {
"type" : "string",
"description" : "ID of the file ingest source obtained from the /fileIngestSource endpoint"
},
"pathSuffix" : {
"type" : "string",
"description" : "Suffix to append to the name from ingest source"
},
"fileFormat" : {
"type" : "string",
"description" : "File format",
"enum" : [ "Json", "Csv" ]
},
"pollingIntervalInMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "List files in object storage every polling interval",
"nullable" : false
},
"csvParameters" : {
"required" : [ "delimiter", "escapeChar", "numHeaderLinesToExclude", "quoteChar" ],
"properties" : {
"delimiter" : {
"type" : "string",
"description" : "CSV delimiter character",
"enum" : [ "Comma", "Tab", "Pipe", "Semicolon" ]
},
"quoteChar" : {
"type" : "string",
"description" : "CSV quote character",
"enum" : [ "DoubleQuote", "SingleQuote" ]
},
"escapeChar" : {
"type" : "string",
"description" : "CSV escape character",
"enum" : [ "DoubleQuote", "Backslash" ]
},
"numHeaderLinesToExclude" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of CSV header lines to exclude",
"nullable" : false
}
},
"description" : "CSV format parameters. Required for CSV format, must be absent for other formats",
"x-tags" : [ "Model Definitions" ]
}
},
"description" : "Properties for a live table ingesting from a file",
"x-tags" : [ "Model Definitions" ]
},
"FileIngestSource" : {
"required" : [ "bucket", "fileIngestSourceId", "name", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"fileIngestSourceId" : {
"type" : "string",
"description" : "ID"
},
"name" : {
"type" : "string",
"description" : "Name"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"bucket" : {
"type" : "string",
"description" : "Storage bucket"
},
"prefix" : {
"type" : "string",
"description" : "File name prefix or path"
}
},
"description" : "A file source from which ingest tables can be populated",
"x-tags" : [ "Model Definitions" ]
},
"FileIngestSourceUpdatePatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "New source name"
},
"description" : {
"type" : "string",
"description" : "New source description"
},
"cloudStorageCredentials" : {
"$ref" : "#/components/schemas/CloudStorageCredentialsPatch"
}
},
"description" : "Info for updating a file ingest source",
"x-tags" : [ "Model Definitions" ]
},
"FilterAndProjectTransformColumn" : {
"required" : [ "columnId", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Column name"
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"expression" : {
"type" : "string",
"description" : "Trino SQL expression producing this column's value; present only for top-level columns"
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array)",
"items" : {
"$ref" : "#/components/schemas/FilterAndProjectTransformColumn"
}
}
},
"description" : "Output columns and the expressions that produce their values",
"x-tags" : [ "Model Definitions" ]
},
"FilterAndProjectTransformProperties" : {
"required" : [ "columns", "filterExpressions", "liveTableId" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source transform table"
},
"columns" : {
"type" : "array",
"description" : "Output columns and the expressions that produce their values",
"items" : {
"required" : [ "columnId", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Column name"
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"expression" : {
"type" : "string",
"description" : "Trino SQL expression producing this column's value; present only for top-level columns"
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array)",
"items" : {
"$ref" : "#/components/schemas/FilterAndProjectTransformColumn"
}
}
},
"description" : "Output columns and the expressions that produce their values",
"x-tags" : [ "Model Definitions" ]
}
},
"filterExpressions" : {
"type" : "array",
"description" : "Filter predicates over the input table's columns; at most one is supported",
"items" : {
"type" : "string",
"description" : "Filter predicates over the input table's columns; at most one is supported"
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
}
},
"description" : "Properties for a filter and project transform live table",
"x-tags" : [ "Model Definitions" ]
},
"Forbidden" : {
"properties" : {
"message" : {
"type" : "string",
"description" : ""
}
},
"description" : "Authorization failed",
"x-tags" : [ "Responses" ]
},
"GalaxyMetastore" : {
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
},
"GcsCatalog" : {
"required" : [ "catalogId", "credentialsKey", "metastoreType", "name", "readOnly", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "GCS catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"credentialsKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text GCS JSON key"
},
"metastoreType" : {
"type" : "string"
},
"defaultTableFormat" : {
"type" : "string",
"description" : "Default table format for new tables: ICEBERG, DELTA, or HIVE. Defaults to ICEBERG."
},
"externalTableCreationEnabled" : {
"type" : "boolean",
"description" : "Allow creating external tables. Defaults to false.",
"nullable" : false
},
"externalTableWritesEnabled" : {
"type" : "boolean",
"description" : "Allow writing to external tables. Defaults to false.",
"nullable" : false
},
"metadataMaxStalenessSeconds" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum metadata staleness in seconds (30, 60, 90, or 120)",
"nullable" : false
}
},
"description" : "A catalog connecting to GCS",
"discriminator" : {
"propertyName" : "metastoreType",
"mapping" : {
"galaxy" : "#/components/schemas/GcsCatalogGcsGalaxyMetastore",
"hive" : "#/components/schemas/GcsCatalogGcsHiveMetastore"
}
},
"x-tags" : [ "Model Definitions" ]
},
"GcsCatalogGcsGalaxyMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/GcsCatalog"
}, {
"required" : [ "defaultBucket", "defaultDataLocation" ],
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "GCS bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"GcsCatalogGcsHiveMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/GcsCatalog"
}, {
"required" : [ "hiveMetastoreHost" ],
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"GcsCatalogPatch" : {
"required" : [ "metastoreType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"credentialsKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text GCS JSON key"
},
"metastoreType" : {
"type" : "string"
},
"defaultTableFormat" : {
"type" : "string",
"description" : "Default table format for new tables: ICEBERG, DELTA, or HIVE. Defaults to ICEBERG."
},
"externalTableCreationEnabled" : {
"type" : "boolean",
"description" : "Allow creating external tables. Defaults to false.",
"nullable" : false
},
"externalTableWritesEnabled" : {
"type" : "boolean",
"description" : "Allow writing to external tables. Defaults to false.",
"nullable" : false
},
"metadataMaxStalenessSeconds" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum metadata staleness in seconds (30, 60, 90, or 120)",
"nullable" : false
}
},
"description" : "A catalog connecting to GCS",
"discriminator" : {
"propertyName" : "metastoreType",
"mapping" : {
"galaxy" : "#/components/schemas/GcsCatalogPatchGcsGalaxyMetastore",
"hive" : "#/components/schemas/GcsCatalogPatchGcsHiveMetastore"
}
},
"x-tags" : [ "Model Definitions" ]
},
"GcsCatalogPatchGcsGalaxyMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/GcsCatalogPatch"
}, {
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "GCS bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"GcsCatalogPatchGcsHiveMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/GcsCatalogPatch"
}, {
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"GcsGalaxyMetastore" : {
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "GCS bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
},
"GcsHiveMetastore" : {
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
},
"GlueMetastore" : {
"properties" : {
"region" : {
"type" : "string",
"description" : "AWS region"
},
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
},
"glueAccessKey" : {
"type" : "string",
"description" : "AWS access key for AWS Glue access"
},
"glueSecretKey" : {
"type" : "string",
"description" : "AWS secret key for AWS Glue access"
},
"glueRoleArn" : {
"type" : "string",
"description" : "AWS cross account role for AWS Glue access"
}
},
"description" : "Store metadata in AWS Glue",
"x-tags" : [ "Model Definitions" ]
},
"GrantKindAndPrivileges" : {
"required" : [ "grantKind", "privilege" ],
"properties" : {
"grantKind" : {
"type" : "string",
"description" : "Grant kind (read only)",
"enum" : [ "Allow", "Deny" ]
},
"privilege" : {
"type" : "array",
"description" : "Privileges (read only)",
"items" : {
"type" : "string",
"description" : "Privileges (read only)",
"enum" : [ "ManageSecurity", "CreateRole", "CreateUser", "CreateCluster", "CreateCatalog", "CreateAiModel", "UseAiModel", "ViewAuditLog", "ManageBilling", "ManageNotifications", "ViewAllQueryHistory", "ManageSso", "SsoUserPasswordLogin", "ViewAllDataLineage", "UseCluster", "EnableDisableCluster", "MonitorCluster", "TroubleshootQuery", "CreateSchema", "CreateTable", "CreateBranch", "Insert", "Delete", "Select", "Update", "ManageDataObservability", "CreateSql", "Execute", "ManageServiceAccount", "ManageServiceAccountToken", "ManageOauthClient", "ViewPublicOauthClient", "ManageAccountWork", "CreateTag", "ApplyTag", "GenerativeAiFeatures", "ManageIngestStreams", "CreateFunction", "CancelQuery", "ViewDataProduct", "ManageCertification", "DownloadQueryResults", "ManageQueryRoutingRules", "ManageIcehouseOps", "CreateDataDomain", "ViewAllQueryProfilerResults" ]
}
}
},
"description" : "Privileges (read only)",
"x-tags" : [ "Model Definitions" ]
},
"GrantedPrivilege" : {
"required" : [ "entityId", "entityKind", "grantKind", "grantOption", "privilege" ],
"properties" : {
"grantKind" : {
"type" : "string",
"description" : "Grant kind",
"enum" : [ "Allow", "Deny" ]
},
"entityId" : {
"type" : "string",
"description" : "Entity ID"
},
"entityKind" : {
"type" : "string",
"description" : "Entity kind",
"enum" : [ "Account", "AiModel", "Cluster", "Catalog", "Schema", "Table", "Column", "Location", "Function", "Tag", "TableBranch", "Policy", "RowFilter", "DataProduct", "DataDomain" ]
},
"grantOption" : {
"type" : "boolean",
"description" : "Grant option",
"nullable" : false
},
"privilege" : {
"type" : "string",
"description" : "Privilege",
"enum" : [ "ManageSecurity", "CreateRole", "CreateUser", "CreateCluster", "CreateCatalog", "CreateAiModel", "UseAiModel", "ViewAuditLog", "ManageBilling", "ManageNotifications", "ViewAllQueryHistory", "ManageSso", "SsoUserPasswordLogin", "ViewAllDataLineage", "UseCluster", "EnableDisableCluster", "MonitorCluster", "TroubleshootQuery", "CreateSchema", "CreateTable", "CreateBranch", "Insert", "Delete", "Select", "Update", "ManageDataObservability", "CreateSql", "Execute", "ManageServiceAccount", "ManageServiceAccountToken", "ManageOauthClient", "ViewPublicOauthClient", "ManageAccountWork", "CreateTag", "ApplyTag", "GenerativeAiFeatures", "ManageIngestStreams", "CreateFunction", "CancelQuery", "ViewDataProduct", "ManageCertification", "DownloadQueryResults", "ManageQueryRoutingRules", "ManageIcehouseOps", "CreateDataDomain", "ViewAllQueryProfilerResults" ]
},
"schemaName" : {
"type" : "string",
"description" : "Schema name"
},
"tableName" : {
"type" : "string",
"description" : "Table name"
},
"columnName" : {
"type" : "string",
"description" : "Column name"
}
},
"description" : "A role privilege (read only)",
"x-tags" : [ "Model Definitions" ]
},
"Group" : {
"required" : [ "createdOn", "externalId", "groupId", "groupName", "modifiedOn", "roles", "syncToken", "users" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"groupId" : {
"type" : "string",
"description" : "Group ID (read only)"
},
"groupName" : {
"type" : "string",
"description" : "Group name (read only)"
},
"externalId" : {
"type" : "string",
"description" : "SCIM external ID (read only)"
},
"roles" : {
"type" : "array",
"description" : "Roles assigned to this group (read only)",
"items" : {
"$ref" : "#/components/schemas/RoleWithName"
}
},
"users" : {
"type" : "array",
"description" : "Users directly assigned to this group (read only)",
"items" : {
"$ref" : "#/components/schemas/UserAndEmail"
}
},
"createdOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation date (read only)"
},
"modifiedOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified date (read only)"
}
},
"description" : "A group",
"x-tags" : [ "Model Definitions" ]
},
"HiveMetastore" : {
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
},
"IamAuth" : {
"properties" : {
"awsRoleArn" : {
"type" : "string",
"description" : "ARN of the AWS IAM role"
}
},
"description" : "AWS IAM role authentication",
"x-tags" : [ "Model Definitions" ]
},
"IngestColumn" : {
"required" : [ "columnId", "fieldParserConfig", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/IngestColumn"
}
}
},
"description" : "Schema of the transformed table",
"x-tags" : [ "Model Definitions" ]
},
"IngestJsonTransformProperties" : {
"required" : [ "liveTableId", "userDefinedSchema" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"userDefinedSchema" : {
"type" : "array",
"description" : "Schema of the transformed table",
"items" : {
"required" : [ "columnId", "fieldParserConfig", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/IngestColumn"
}
}
},
"description" : "Schema of the transformed table",
"x-tags" : [ "Model Definitions" ]
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties for a JSON transform live table",
"x-tags" : [ "Model Definitions" ]
},
"IngestSchemaRegistryAvroTransformProperties" : {
"required" : [ "liveTableId", "schemaRegistryId", "subjectName" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"schemaRegistryId" : {
"type" : "string",
"description" : "Schema registry id associated with the live table"
},
"subjectName" : {
"type" : "string",
"description" : "Subject name in the schema registry"
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties for a schema registry Avro transform live table",
"x-tags" : [ "Model Definitions" ]
},
"InvalidArgument" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Badrequest"
}
},
"description" : "Client specified an invalid argument. Check error message and error details for more information.",
"x-tags" : [ "Responses" ]
},
"JsonParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuth" : {
"required" : [ "authType" ],
"properties" : {
"authType" : {
"type" : "string"
}
},
"description" : "Kafka authentication configuration",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"noAuth" : "#/components/schemas/KafkaAuthNoAuth",
"saslPlainAuth" : "#/components/schemas/KafkaAuthSaslPlainAuth",
"saslScramAuth" : "#/components/schemas/KafkaAuthSaslScramAuth",
"iamAuth" : "#/components/schemas/KafkaAuthIamAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthIamAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuth"
}, {
"required" : [ "awsRoleArn" ],
"properties" : {
"awsRoleArn" : {
"type" : "string",
"description" : "ARN of the AWS IAM role"
}
},
"description" : "AWS IAM role authentication",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthNoAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuth"
}, {
"description" : "No authentication",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthPatch" : {
"required" : [ "authType" ],
"properties" : {
"authType" : {
"type" : "string"
}
},
"description" : "New Kafka auth for the source",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"noAuth" : "#/components/schemas/KafkaAuthPatchNoAuthPatch",
"saslPlainAuth" : "#/components/schemas/KafkaAuthPatchSaslPlainAuthPatch",
"saslScramAuth" : "#/components/schemas/KafkaAuthPatchSaslScramAuthPatch",
"iamAuth" : "#/components/schemas/KafkaAuthPatchIamAuthPatch"
}
},
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthPatchIamAuthPatch" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuthPatch"
}, {
"properties" : {
"awsRoleArn" : {
"type" : "string",
"description" : "ARN of the AWS IAM role"
}
},
"description" : "AWS IAM role authentication",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthPatchNoAuthPatch" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuthPatch"
}, {
"description" : "No authentication",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthPatchSaslPlainAuthPatch" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuthPatch"
}, {
"properties" : {
"username" : {
"type" : "string",
"description" : "SASL username"
},
"password" : {
"type" : "string",
"description" : "SASL password"
}
},
"description" : "SASL/PLAIN authentication over TLS",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthPatchSaslScramAuthPatch" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuthPatch"
}, {
"properties" : {
"username" : {
"type" : "string",
"description" : "SASL username"
},
"password" : {
"type" : "string",
"description" : "SASL password"
},
"scramType" : {
"type" : "string",
"description" : "SCRAM hash algorithm",
"enum" : [ "Sha256", "Sha512" ]
}
},
"description" : "SASL/SCRAM authentication over TLS",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthSaslPlainAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuth"
}, {
"required" : [ "password", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "SASL username"
},
"password" : {
"type" : "string",
"description" : "SASL password"
}
},
"description" : "SASL/PLAIN authentication over TLS",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaAuthSaslScramAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/KafkaAuth"
}, {
"required" : [ "password", "scramType", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "SASL username"
},
"password" : {
"type" : "string",
"description" : "SASL password"
},
"scramType" : {
"type" : "string",
"description" : "SCRAM hash algorithm",
"enum" : [ "Sha256", "Sha512" ]
}
},
"description" : "SASL/SCRAM authentication over TLS",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"KafkaIngestProperties" : {
"required" : [ "kafkaIngestSourceId", "kafkaTopicName", "latencyMode", "partitionMaxBytesPerSec", "startStrategy" ],
"properties" : {
"kafkaIngestSourceId" : {
"type" : "string",
"description" : "ID of the Kafka ingest source obtained from the /kafkaIngestSource endpoint"
},
"kafkaTopicName" : {
"type" : "string",
"description" : "Kafka topic name"
},
"startStrategy" : {
"type" : "string",
"description" : "Stream start strategy",
"enum" : [ "Earliest", "Latest" ]
},
"partitionMaxBytesPerSec" : {
"format" : "int64",
"type" : "integer",
"description" : "Throughput limit per partition",
"nullable" : false
},
"latencyMode" : {
"type" : "string",
"description" : "Latency mode for commits",
"enum" : [ "BalancedMode", "LowLatencyMode" ]
}
},
"description" : "Properties for a live table ingesting from Kafka",
"x-tags" : [ "Model Definitions" ]
},
"KafkaIngestSource" : {
"required" : [ "kafkaBrokers", "kafkaIngestSourceId", "name", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"kafkaIngestSourceId" : {
"type" : "string",
"description" : "Ingest source ID"
},
"name" : {
"type" : "string",
"description" : "Ingest source name"
},
"description" : {
"type" : "string",
"description" : "Ingest source description"
},
"kafkaBrokers" : {
"type" : "array",
"description" : "Kafka brokers for this source",
"items" : {
"type" : "string",
"description" : "Kafka brokers for this source"
}
}
},
"description" : "A Kafka source from which ingest tables can be populated",
"x-tags" : [ "Model Definitions" ]
},
"KafkaIngestSourceUpdatePatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "New source name"
},
"description" : {
"type" : "string",
"description" : "New source description"
},
"kafkaAuth" : {
"$ref" : "#/components/schemas/KafkaAuthPatch"
}
},
"description" : "Info for updating a Kafka ingest source",
"x-tags" : [ "Model Definitions" ]
},
"Link" : {
"required" : [ "name", "uri" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the link"
},
"uri" : {
"type" : "string",
"description" : "The link URI"
}
},
"description" : "Any links set for this schema (read only)",
"x-tags" : [ "Model Definitions" ]
},
"LinkPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the link"
},
"uri" : {
"type" : "string",
"description" : "The link URI"
}
},
"description" : "Schema links",
"x-tags" : [ "Model Definitions" ]
},
"LiveTable" : {
"required" : [ "catalogId", "catalogName", "cloudRegionId", "errorNotificationCount", "failureMode", "liveTableId", "liveTableState", "schemaName", "snapshotRetentionDays", "syncToken", "tableName", "typeProperties", "warnNotificationCount" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"liveTableId" : {
"type" : "string",
"description" : "Table ID"
},
"description" : {
"type" : "string",
"description" : "Table description"
},
"cloudRegionId" : {
"type" : "string",
"description" : "Region in which the table is stored"
},
"catalogId" : {
"type" : "string",
"description" : "ID of the table's catalog"
},
"catalogName" : {
"type" : "string",
"description" : "Name of the table's catalog"
},
"schemaName" : {
"type" : "string",
"description" : "Name of the table's schema"
},
"tableName" : {
"type" : "string",
"description" : "Table name"
},
"liveTableState" : {
"type" : "string",
"description" : "Table state",
"enum" : [ "Stopped", "Stopping", "Running" ]
},
"dataRetentionDays" : {
"format" : "int64",
"type" : "integer",
"description" : "If configured, data older than dataRetentionDays is deleted from Iceberg; otherwise, data is kept forever",
"nullable" : false
},
"snapshotRetentionDays" : {
"format" : "int64",
"type" : "integer",
"description" : "Number of days to retain table snapshots; older snapshots are automatically removed during maintenance",
"nullable" : false
},
"failureMode" : {
"type" : "string",
"description" : "Failure mode.",
"enum" : [ "Continue", "FailFast" ]
},
"errorNotificationCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of undismissed error notifications in the last five days",
"nullable" : false
},
"warnNotificationCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of undismissed warning notifications in the last five days",
"nullable" : false
},
"stopType" : {
"type" : "string",
"description" : "Type of stop event if table is stopped"
},
"stopMessage" : {
"type" : "string",
"description" : "Message explaining why the table was stopped"
},
"typeProperties" : {
"$ref" : "#/components/schemas/TypeProperties"
}
},
"description" : "A managed live table",
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalog" : {
"required" : [ "catalogId", "connectionType", "name", "password", "readOnly", "regions", "syncToken", "username" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "MongoDB catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "MongoDB cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"connectionType" : {
"type" : "string"
},
"regions" : {
"type" : "array",
"description" : "MongoDB regions",
"items" : {
"type" : "string",
"description" : "MongoDB regions"
}
},
"username" : {
"type" : "string",
"description" : "MongoDB username"
},
"password" : {
"type" : "string",
"description" : "MongoDB password"
},
"dnsSeedListEnabled" : {
"type" : "boolean",
"description" : "Use DNS seed list (SRV). Defaults to false.",
"nullable" : false
},
"tlsEnabled" : {
"type" : "boolean",
"description" : "Use TLS for connections. Defaults to true.",
"nullable" : false
},
"federatedDatabaseEnabled" : {
"type" : "boolean",
"description" : "Is federated database. Defaults to false.",
"nullable" : false
}
},
"description" : "A catalog connecting to MongoDB",
"discriminator" : {
"propertyName" : "connectionType",
"mapping" : {
"direct" : "#/components/schemas/MongoDBCatalogDirectMongoDBConnection",
"sshTunnel" : "#/components/schemas/MongoDBCatalogSshTunnelMongoDBConnection",
"privateLink" : "#/components/schemas/MongoDBCatalogPrivateLinkMongoDBConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogDirectMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MongoDBCatalog"
}, {
"required" : [ "hosts" ],
"properties" : {
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect directly to MongoDB instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogPatch" : {
"required" : [ "connectionType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "MongoDB cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"connectionType" : {
"type" : "string"
},
"regions" : {
"type" : "array",
"description" : "MongoDB regions",
"items" : {
"type" : "string",
"description" : "MongoDB regions"
}
},
"username" : {
"type" : "string",
"description" : "MongoDB username"
},
"password" : {
"type" : "string",
"description" : "MongoDB password"
},
"dnsSeedListEnabled" : {
"type" : "boolean",
"description" : "Use DNS seed list (SRV). Defaults to false.",
"nullable" : false
},
"tlsEnabled" : {
"type" : "boolean",
"description" : "Use TLS for connections. Defaults to true.",
"nullable" : false
},
"federatedDatabaseEnabled" : {
"type" : "boolean",
"description" : "Is federated database. Defaults to false.",
"nullable" : false
}
},
"description" : "A catalog connecting to MongoDB",
"discriminator" : {
"propertyName" : "connectionType",
"mapping" : {
"direct" : "#/components/schemas/MongoDBCatalogPatchDirectMongoDBConnection",
"sshTunnel" : "#/components/schemas/MongoDBCatalogPatchSshTunnelMongoDBConnection",
"privateLink" : "#/components/schemas/MongoDBCatalogPatchPrivateLinkMongoDBConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogPatchDirectMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MongoDBCatalogPatch"
}, {
"properties" : {
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect directly to MongoDB instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogPatchPrivateLinkMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MongoDBCatalogPatch"
}, {
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MongoDB via PrivateLink",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogPatchSshTunnelMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MongoDBCatalogPatch"
}, {
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect to MongoDB via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogPrivateLinkMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MongoDBCatalog"
}, {
"required" : [ "privateLinkId" ],
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MongoDB via PrivateLink",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MongoDBCatalogSshTunnelMongoDBConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MongoDBCatalog"
}, {
"required" : [ "hosts", "sshTunnelId" ],
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect to MongoDB via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalog" : {
"required" : [ "catalogId", "connectionType", "name", "password", "readOnly", "syncToken", "username" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "MySQL catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "MySQL cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"connectionType" : {
"type" : "string"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "MySQL database port. Defaults to 3306.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "MySQL database username"
},
"password" : {
"type" : "string",
"description" : "MySQL database password"
}
},
"description" : "A catalog connecting to MySQL",
"discriminator" : {
"propertyName" : "connectionType",
"mapping" : {
"direct" : "#/components/schemas/MySQLCatalogDirectMySQLConnection",
"sshTunnel" : "#/components/schemas/MySQLCatalogSshTunnelMySQLConnection",
"privateLink" : "#/components/schemas/MySQLCatalogPrivateLinkMySQLConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogDirectMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MySQLCatalog"
}, {
"required" : [ "host" ],
"properties" : {
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect directly to MySQL instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogPatch" : {
"required" : [ "connectionType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "MySQL cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"connectionType" : {
"type" : "string"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "MySQL database port. Defaults to 3306.",
"nullable" : false
},
"username" : {
"type" : "string",
"description" : "MySQL database username"
},
"password" : {
"type" : "string",
"description" : "MySQL database password"
}
},
"description" : "A catalog connecting to MySQL",
"discriminator" : {
"propertyName" : "connectionType",
"mapping" : {
"direct" : "#/components/schemas/MySQLCatalogPatchDirectMySQLConnection",
"sshTunnel" : "#/components/schemas/MySQLCatalogPatchSshTunnelMySQLConnection",
"privateLink" : "#/components/schemas/MySQLCatalogPatchPrivateLinkMySQLConnection"
}
},
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogPatchDirectMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MySQLCatalogPatch"
}, {
"properties" : {
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect directly to MySQL instance",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogPatchPrivateLinkMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MySQLCatalogPatch"
}, {
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MySQL via PrivateLink",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogPatchSshTunnelMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MySQLCatalogPatch"
}, {
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect to MySQL via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogPrivateLinkMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MySQLCatalog"
}, {
"required" : [ "privateLinkId" ],
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MySQL via PrivateLink",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"MySQLCatalogSshTunnelMySQLConnection" : {
"allOf" : [ {
"$ref" : "#/components/schemas/MySQLCatalog"
}, {
"required" : [ "host", "sshTunnelId" ],
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect to MySQL via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NewFileIngestProperties" : {
"required" : [ "fileFormat", "fileIngestSourceId", "pollingIntervalInMinutes" ],
"properties" : {
"fileIngestSourceId" : {
"type" : "string",
"description" : "ID of the file ingest source obtained from the /fileIngestSource endpoint"
},
"pathSuffix" : {
"type" : "string",
"description" : "Suffix to append to the name from ingest source"
},
"fileFormat" : {
"type" : "string",
"description" : "File format",
"enum" : [ "Json", "Csv" ]
},
"pollingIntervalInMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "List files in object storage every polling interval",
"nullable" : false
},
"csvParameters" : {
"required" : [ "delimiter", "escapeChar", "numHeaderLinesToExclude", "quoteChar" ],
"properties" : {
"delimiter" : {
"type" : "string",
"description" : "CSV delimiter character",
"enum" : [ "Comma", "Tab", "Pipe", "Semicolon" ]
},
"quoteChar" : {
"type" : "string",
"description" : "CSV quote character",
"enum" : [ "DoubleQuote", "SingleQuote" ]
},
"escapeChar" : {
"type" : "string",
"description" : "CSV escape character",
"enum" : [ "DoubleQuote", "Backslash" ]
},
"numHeaderLinesToExclude" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of CSV header lines to exclude",
"nullable" : false
}
},
"description" : "CSV format parameters. Required for CSV format, must be absent for other formats",
"x-tags" : [ "Model Definitions" ]
}
},
"description" : "Properties required for creating a new live table ingesting from a file",
"x-tags" : [ "Model Definitions" ]
},
"NewFileIngestSource" : {
"required" : [ "bucket", "bucketCloudRegionId", "cloudStorageCredentials", "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"sourceCloudRegionId" : {
"type" : "string",
"description" : "Cloud region ID where icehouse ingest work is scheduled"
},
"bucketCloudRegionId" : {
"type" : "string",
"description" : "Cloud region ID where the storage bucket lives"
},
"bucket" : {
"type" : "string",
"description" : "Storage bucket"
},
"pathPrefix" : {
"type" : "string",
"description" : "File name prefix or path"
},
"cloudStorageCredentials" : {
"$ref" : "#/components/schemas/CloudStorageCredentials"
}
},
"description" : "Info for creating a new file ingest source",
"x-tags" : [ "Model Definitions" ]
},
"NewFilterAndProjectTransformColumn" : {
"required" : [ "expression", "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the output column; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"expression" : {
"type" : "string",
"description" : "Trino SQL scalar expression over the input table's columns that produces this column's value"
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"required" : [ "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the nested field; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewFilterAndProjectTransformNestedColumn"
}
}
},
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Output columns of the transform; each carries its name, type, and the Trino SQL scalar expression over the input table's columns that produces its value",
"x-tags" : [ "Model Definitions" ]
},
"NewFilterAndProjectTransformNestedColumn" : {
"required" : [ "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the nested field; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewFilterAndProjectTransformNestedColumn"
}
}
},
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"x-tags" : [ "Model Definitions" ]
},
"NewFilterAndProjectTransformProperties" : {
"required" : [ "columns", "filterExpressions", "liveTableId" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source transform table"
},
"columns" : {
"type" : "array",
"description" : "Output columns of the transform; each carries its name, type, and the Trino SQL scalar expression over the input table's columns that produces its value",
"items" : {
"required" : [ "expression", "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the output column; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"expression" : {
"type" : "string",
"description" : "Trino SQL scalar expression over the input table's columns that produces this column's value"
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"required" : [ "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the nested field; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewFilterAndProjectTransformNestedColumn"
}
}
},
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Output columns of the transform; each carries its name, type, and the Trino SQL scalar expression over the input table's columns that produces its value",
"x-tags" : [ "Model Definitions" ]
}
},
"filterExpressions" : {
"type" : "array",
"description" : "Trino SQL boolean predicates over the input table's columns that select which rows are emitted; at most one is supported",
"items" : {
"type" : "string",
"description" : "Trino SQL boolean predicates over the input table's columns that select which rows are emitted; at most one is supported"
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
}
},
"description" : "Properties required for creating a new filter and project transform live table",
"x-tags" : [ "Model Definitions" ]
},
"NewIngestJsonTransformProperties" : {
"required" : [ "liveTableId", "userDefinedSchema" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"userDefinedSchema" : {
"type" : "array",
"description" : "Schema of the transformed table",
"items" : {
"required" : [ "fieldParserConfig", "trinoColumnName", "trinoType" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewJsonIngestColumn"
}
}
},
"description" : "Schema of the transformed table",
"x-tags" : [ "Model Definitions" ]
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties required for creating a new JSON transform live table",
"x-tags" : [ "Model Definitions" ]
},
"NewIngestSchemaRegistryAvroTransformProperties" : {
"required" : [ "liveTableId", "schemaRegistryId", "subjectName" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"schemaRegistryId" : {
"type" : "string",
"description" : "Schema registry ID associated with the live table"
},
"subjectName" : {
"type" : "string",
"description" : "Subject name in the schema registry"
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties required for creating a new schema registry Avro transform live table",
"x-tags" : [ "Model Definitions" ]
},
"NewJsonIngestColumn" : {
"required" : [ "fieldParserConfig", "trinoColumnName", "trinoType" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewJsonIngestColumn"
}
}
},
"description" : "Schema of the transformed table",
"x-tags" : [ "Model Definitions" ]
},
"NewJsonIngestColumnInSchemaUpdate" : {
"required" : [ "fieldParserConfig", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewJsonIngestColumnInSchemaUpdate"
}
}
},
"description" : "An added column",
"x-tags" : [ "Model Definitions" ]
},
"NewJsonSchema" : {
"required" : [ "columns" ],
"properties" : {
"columns" : {
"type" : "array",
"description" : "A new set of columns for this table (replaces the old one)",
"items" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "A new set of columns for this table (replaces the old one)",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newJsonIngestColumnInSchemaUpdate" : "#/components/schemas/UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate",
"existingJsonIngestColumn" : "#/components/schemas/UpdatedJsonIngestColumnExistingJsonIngestColumn2"
}
},
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "If present, table storage will be sorted by this"
}
},
"description" : "New schema for a JSON transform live table",
"x-tags" : [ "Model Definitions" ]
},
"NewKafkaIngestProperties" : {
"required" : [ "kafkaIngestSourceId", "kafkaTopicName", "latencyMode", "partitionMaxBytesPerSec", "startStrategy" ],
"properties" : {
"kafkaIngestSourceId" : {
"type" : "string",
"description" : "ID of the Kafka ingest source obtained from the /kafkaIngestSource endpoint"
},
"kafkaTopicName" : {
"type" : "string",
"description" : "Kafka topic name"
},
"startStrategy" : {
"type" : "string",
"description" : "Stream start strategy",
"enum" : [ "Earliest", "Latest" ]
},
"partitionMaxBytesPerSec" : {
"format" : "int64",
"type" : "integer",
"description" : "Throughput limit per partition",
"nullable" : false
},
"latencyMode" : {
"type" : "string",
"description" : "Latency mode for commits",
"enum" : [ "BalancedMode", "LowLatencyMode" ]
}
},
"description" : "Properties required for creating a new live table ingesting from Kafka",
"x-tags" : [ "Model Definitions" ]
},
"NewKafkaIngestSource" : {
"required" : [ "kafkaAuth", "kafkaBrokers", "name" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name"
},
"description" : {
"type" : "string",
"description" : "Description"
},
"kafkaBrokers" : {
"type" : "array",
"description" : "Kafka broker addresses",
"items" : {
"type" : "string",
"description" : "Kafka broker addresses"
}
},
"kafkaAuth" : {
"$ref" : "#/components/schemas/KafkaAuth"
},
"cloudRegionId" : {
"type" : "string",
"description" : "Cloud region ID where icehouse ingest work is scheduled"
}
},
"description" : "Info for creating a new Kafka ingest source",
"x-tags" : [ "Model Definitions" ]
},
"NewLiveTable" : {
"required" : [ "catalogId", "failureMode", "schemaName", "tableName", "typeProperties" ],
"properties" : {
"description" : {
"type" : "string",
"description" : "Table description"
},
"catalogId" : {
"type" : "string",
"description" : "ID of the table's catalog"
},
"schemaName" : {
"type" : "string",
"description" : "Name of the table's schema"
},
"tableName" : {
"type" : "string",
"description" : "Table name"
},
"dataRetentionDays" : {
"format" : "int64",
"type" : "integer",
"description" : "If configured, data older than dataRetentionDays is deleted from Iceberg; otherwise, data is kept forever",
"nullable" : false
},
"snapshotRetentionDays" : {
"format" : "int64",
"type" : "integer",
"description" : "Number of days to retain table snapshots; older snapshots are automatically removed during maintenance",
"nullable" : false
},
"failureMode" : {
"type" : "string",
"description" : "Failure mode",
"enum" : [ "Continue", "FailFast" ]
},
"typeProperties" : {
"$ref" : "#/components/schemas/NewTypeProperties"
}
},
"description" : "Info for creating a new live table",
"x-tags" : [ "Model Definitions" ]
},
"NewSchema" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "New schema for a transform live table",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newJsonSchema" : "#/components/schemas/NewSchemaNewJsonSchema"
}
},
"x-tags" : [ "Model Definitions" ]
},
"NewSchemaNewJsonSchema" : {
"allOf" : [ {
"$ref" : "#/components/schemas/NewSchema"
}, {
"required" : [ "columns" ],
"properties" : {
"columns" : {
"type" : "array",
"description" : "A new set of columns for this table (replaces the old one)",
"items" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "A new set of columns for this table (replaces the old one)",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newJsonIngestColumnInSchemaUpdate" : "#/components/schemas/UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate",
"existingJsonIngestColumn" : "#/components/schemas/UpdatedJsonIngestColumnExistingJsonIngestColumn2"
}
},
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "If present, table storage will be sorted by this"
}
},
"description" : "New schema for a JSON transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NewTypeProperties" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "Type-specific properties for the new live table",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newKafkaIngestProperties" : "#/components/schemas/NewTypePropertiesNewKafkaIngestProperties",
"newFileIngestProperties" : "#/components/schemas/NewTypePropertiesNewFileIngestProperties",
"newIngestJsonTransformProperties" : "#/components/schemas/NewTypePropertiesNewIngestJsonTransformProperties",
"newIngestSchemaRegistryAvroTransformProperties" : "#/components/schemas/NewTypePropertiesNewIngestSchemaRegistryAvroTransformProperties",
"newFilterAndProjectTransformProperties" : "#/components/schemas/NewTypePropertiesNewFilterAndProjectTransformProperties"
}
},
"x-tags" : [ "Model Definitions" ]
},
"NewTypePropertiesNewFileIngestProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/NewTypeProperties"
}, {
"required" : [ "fileFormat", "fileIngestSourceId", "pollingIntervalInMinutes" ],
"properties" : {
"fileIngestSourceId" : {
"type" : "string",
"description" : "ID of the file ingest source obtained from the /fileIngestSource endpoint"
},
"pathSuffix" : {
"type" : "string",
"description" : "Suffix to append to the name from ingest source"
},
"fileFormat" : {
"type" : "string",
"description" : "File format",
"enum" : [ "Json", "Csv" ]
},
"pollingIntervalInMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "List files in object storage every polling interval",
"nullable" : false
},
"csvParameters" : {
"required" : [ "delimiter", "escapeChar", "numHeaderLinesToExclude", "quoteChar" ],
"properties" : {
"delimiter" : {
"type" : "string",
"description" : "CSV delimiter character",
"enum" : [ "Comma", "Tab", "Pipe", "Semicolon" ]
},
"quoteChar" : {
"type" : "string",
"description" : "CSV quote character",
"enum" : [ "DoubleQuote", "SingleQuote" ]
},
"escapeChar" : {
"type" : "string",
"description" : "CSV escape character",
"enum" : [ "DoubleQuote", "Backslash" ]
},
"numHeaderLinesToExclude" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of CSV header lines to exclude",
"nullable" : false
}
},
"description" : "CSV format parameters. Required for CSV format, must be absent for other formats",
"x-tags" : [ "Model Definitions" ]
}
},
"description" : "Properties required for creating a new live table ingesting from a file",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NewTypePropertiesNewFilterAndProjectTransformProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/NewTypeProperties"
}, {
"required" : [ "columns", "filterExpressions", "liveTableId" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source transform table"
},
"columns" : {
"type" : "array",
"description" : "Output columns of the transform; each carries its name, type, and the Trino SQL scalar expression over the input table's columns that produces its value",
"items" : {
"required" : [ "expression", "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the output column; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"expression" : {
"type" : "string",
"description" : "Trino SQL scalar expression over the input table's columns that produces this column's value"
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"required" : [ "name", "type" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the nested field; adheres to Trino conventions"
},
"type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewFilterAndProjectTransformNestedColumn"
}
}
},
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Output columns of the transform; each carries its name, type, and the Trino SQL scalar expression over the input table's columns that produces its value",
"x-tags" : [ "Model Definitions" ]
}
},
"filterExpressions" : {
"type" : "array",
"description" : "Trino SQL boolean predicates over the input table's columns that select which rows are emitted; at most one is supported",
"items" : {
"type" : "string",
"description" : "Trino SQL boolean predicates over the input table's columns that select which rows are emitted; at most one is supported"
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
}
},
"description" : "Properties required for creating a new filter and project transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NewTypePropertiesNewIngestJsonTransformProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/NewTypeProperties"
}, {
"required" : [ "liveTableId", "userDefinedSchema" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"userDefinedSchema" : {
"type" : "array",
"description" : "Schema of the transformed table",
"items" : {
"required" : [ "fieldParserConfig", "trinoColumnName", "trinoType" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewJsonIngestColumn"
}
}
},
"description" : "Schema of the transformed table",
"x-tags" : [ "Model Definitions" ]
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties required for creating a new JSON transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NewTypePropertiesNewIngestSchemaRegistryAvroTransformProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/NewTypeProperties"
}, {
"required" : [ "liveTableId", "schemaRegistryId", "subjectName" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"schemaRegistryId" : {
"type" : "string",
"description" : "Schema registry ID associated with the live table"
},
"subjectName" : {
"type" : "string",
"description" : "Subject name in the schema registry"
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties required for creating a new schema registry Avro transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NewTypePropertiesNewKafkaIngestProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/NewTypeProperties"
}, {
"required" : [ "kafkaIngestSourceId", "kafkaTopicName", "latencyMode", "partitionMaxBytesPerSec", "startStrategy" ],
"properties" : {
"kafkaIngestSourceId" : {
"type" : "string",
"description" : "ID of the Kafka ingest source obtained from the /kafkaIngestSource endpoint"
},
"kafkaTopicName" : {
"type" : "string",
"description" : "Kafka topic name"
},
"startStrategy" : {
"type" : "string",
"description" : "Stream start strategy",
"enum" : [ "Earliest", "Latest" ]
},
"partitionMaxBytesPerSec" : {
"format" : "int64",
"type" : "integer",
"description" : "Throughput limit per partition",
"nullable" : false
},
"latencyMode" : {
"type" : "string",
"description" : "Latency mode for commits",
"enum" : [ "BalancedMode", "LowLatencyMode" ]
}
},
"description" : "Properties required for creating a new live table ingesting from Kafka",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"NoAuth" : {
"description" : "No authentication",
"x-tags" : [ "Model Definitions" ]
},
"NoLongerAvailable" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Resourceinfo"
}
},
"description" : "Invalid or expired ID or token",
"x-tags" : [ "Responses" ]
},
"NotFound" : {
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Name of the resource"
},
"description" : {
"type" : "string",
"description" : "Violation description"
},
"fields" : {
"type" : "array",
"description" : "Any fields/values that weren't found",
"items" : {
"type" : "string",
"description" : "Any fields/values that weren't found"
}
}
},
"description" : "A resource or required component was not found",
"x-tags" : [ "Responses" ]
},
"NotFoundError" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Resourceinfo"
}
},
"description" : "A specified resource is not found.",
"x-tags" : [ "Responses" ]
},
"OpenSearchAccessKeyAuth" : {
"properties" : {
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchBasicAuth" : {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalog" : {
"required" : [ "authType", "catalogId", "endpoint", "name", "readOnly", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "OpenSearch catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"authType" : {
"type" : "string"
},
"endpoint" : {
"type" : "string",
"description" : "OpenSearch cluster endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "OpenSearch cluster port. Defaults to 443.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "A catalog connecting to OpenSearch",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"basic" : "#/components/schemas/OpenSearchCatalogOpenSearchBasicAuth",
"accessKey" : "#/components/schemas/OpenSearchCatalogOpenSearchAccessKeyAuth",
"role" : "#/components/schemas/OpenSearchCatalogOpenSearchCrossAccountRoleAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogOpenSearchAccessKeyAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}, {
"required" : [ "accessKey", "region", "secretKey" ],
"properties" : {
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogOpenSearchBasicAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}, {
"required" : [ "password", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogOpenSearchCrossAccountRoleAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}, {
"required" : [ "region", "roleArn" ],
"properties" : {
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogPatch" : {
"required" : [ "authType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"authType" : {
"type" : "string"
},
"endpoint" : {
"type" : "string",
"description" : "OpenSearch cluster endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "OpenSearch cluster port. Defaults to 443.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "A catalog connecting to OpenSearch",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"basic" : "#/components/schemas/OpenSearchCatalogPatchOpenSearchBasicAuth",
"accessKey" : "#/components/schemas/OpenSearchCatalogPatchOpenSearchAccessKeyAuth",
"role" : "#/components/schemas/OpenSearchCatalogPatchOpenSearchCrossAccountRoleAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogPatchOpenSearchAccessKeyAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/OpenSearchCatalogPatch"
}, {
"properties" : {
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogPatchOpenSearchBasicAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/OpenSearchCatalogPatch"
}, {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCatalogPatchOpenSearchCrossAccountRoleAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/OpenSearchCatalogPatch"
}, {
"properties" : {
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"OpenSearchCrossAccountRoleAuth" : {
"properties" : {
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
},
"PaginatedBigQueryCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/BigQueryCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedCassandraCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/CassandraCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Catalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedCluster" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Cluster"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedColumn" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Column"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedColumnMask" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/ColumnMask"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedCrossAccountIamRole" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/CrossAccountIamRole"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedDataDomain" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/DataDomain"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedDataProduct" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/DataProduct"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedDataQualityCheckListItem" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/DataQualityCheckListItem"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedFileIngestSource" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/FileIngestSource"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedGcsCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/GcsCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedGrantedPrivilege" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/GrantedPrivilege"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedGroup" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Group"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedKafkaIngestSource" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/KafkaIngestSource"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedLiveTable" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/LiveTable"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedMongoDBCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/MongoDBCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedMySQLCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/MySQLCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedOpenSearchCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/OpenSearchCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedPolicy" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Policy"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedPostgresqlCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/PostgresqlCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedPrivatelink" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Privatelink"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedRedshiftCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/RedshiftCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedRole" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Role"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedRolegrant" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Rolegrant"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedRowFilter" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/RowFilter"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedS3Catalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/S3Catalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedSchema" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Schema"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedSchemaDiscovery" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/SchemaDiscovery"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedServiceAccount" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/ServiceAccount"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedSnowflakeCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/SnowflakeCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedSqlJobHistory" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/SqlJobHistory"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedSqlJobListItem" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/SqlJobListItem"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedSqlServerCatalog" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/SqlServerCatalog"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedTable" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Table"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedTag" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/Tag"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedUsageExample" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/UsageExample"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PaginatedUser" : {
"properties" : {
"nextPageToken" : {
"type" : "string",
"description" : "The next page token to use or \"\" if there are no more pages."
},
"result" : {
"type" : "array",
"description" : "A page of results.",
"items" : {
"$ref" : "#/components/schemas/User"
}
}
},
"x-tags" : [ "Model Definitions" ]
},
"PartitionColumn" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
},
"PermissionDenied" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Errorinfo"
}
},
"description" : "Client does not have sufficient permission. This can happen because the OAuth token does not have the right scopes, the client doesn't have permission, or the API has not been enabled.",
"x-tags" : [ "Responses" ]
},
"Policy" : {
"required" : [ "created", "description", "modified", "name", "policyId", "predicate", "roleId", "scopes", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"policyId" : {
"type" : "string",
"description" : "Policy ID (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Enabling role ID"
},
"name" : {
"type" : "string",
"description" : "Policy name"
},
"predicate" : {
"type" : "string",
"description" : "Policy predicate"
},
"description" : {
"type" : "string",
"description" : "Policy description"
},
"expiration" : {
"format" : "date-time",
"type" : "string",
"description" : "Policy expiration"
},
"scopes" : {
"type" : "array",
"description" : "Policy scopes (read only)",
"items" : {
"$ref" : "#/components/schemas/PolicyScope"
}
},
"created" : {
"format" : "date-time",
"type" : "string",
"description" : "Created on (read only)"
},
"modified" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified on (read only)"
}
},
"description" : "A policy",
"x-tags" : [ "Model Definitions" ]
},
"PolicyScope" : {
"required" : [ "columnMaskIds", "entityId", "entityKind", "rowFilterIds" ],
"properties" : {
"entityId" : {
"type" : "string",
"description" : "Entity ID"
},
"entityKind" : {
"type" : "string",
"description" : "Entity kind",
"enum" : [ "Account", "AiModel", "Cluster", "Catalog", "Schema", "Table", "Column", "Location", "Function", "Tag", "TableBranch", "Policy", "RowFilter", "DataProduct", "DataDomain" ]
},
"schemaName" : {
"type" : "string",
"description" : "Schema name"
},
"tableName" : {
"type" : "string",
"description" : "Table name"
},
"columnName" : {
"type" : "string",
"description" : "Column name"
},
"privileges" : {
"$ref" : "#/components/schemas/GrantKindAndPrivileges"
},
"rowFilterIds" : {
"type" : "array",
"description" : "Row filters",
"items" : {
"type" : "string",
"description" : "Row filters"
}
},
"columnMaskIds" : {
"type" : "array",
"description" : "The column masks which apply to this policy scope.",
"items" : {
"type" : "string",
"description" : "The column masks which apply to this policy scope."
}
}
},
"description" : "Policy scopes (read only)",
"x-tags" : [ "Model Definitions" ]
},
"PostgresqlCatalog" : {
"required" : [ "catalogId", "databaseName", "name", "password", "readOnly", "syncToken", "username" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "PostgreSQL catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "PostgreSQL cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"endpoint" : {
"type" : "string",
"description" : "PostgreSQL database endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "PostgreSQL database port. Defaults to 5432.",
"nullable" : false
},
"databaseName" : {
"type" : "string",
"description" : "PostgreSQL database name"
},
"username" : {
"type" : "string",
"description" : "PostgreSQL database username"
},
"password" : {
"type" : "string",
"description" : "PostgreSQL database password"
},
"tlsEnabled" : {
"type" : "boolean",
"description" : "Use TLS for PostgreSQL connections. Defaults to true.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink identifier"
}
},
"description" : "A catalog connecting to PostgreSQL",
"x-tags" : [ "Model Definitions" ]
},
"PostgresqlCatalogPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "PostgreSQL cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"endpoint" : {
"type" : "string",
"description" : "PostgreSQL database endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "PostgreSQL database port. Defaults to 5432.",
"nullable" : false
},
"databaseName" : {
"type" : "string",
"description" : "PostgreSQL database name"
},
"username" : {
"type" : "string",
"description" : "PostgreSQL database username"
},
"password" : {
"type" : "string",
"description" : "PostgreSQL database password"
},
"tlsEnabled" : {
"type" : "boolean",
"description" : "Use TLS for PostgreSQL connections. Defaults to true.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink identifier"
}
},
"description" : "A catalog connecting to PostgreSQL",
"x-tags" : [ "Model Definitions" ]
},
"Preconditionfailure" : {
"required" : [ "violations" ],
"properties" : {
"violations" : {
"type" : "array",
"description" : "Field violations (read only)",
"items" : {
"$ref" : "#/components/schemas/Violation"
}
}
},
"description" : "Error details (read only)",
"x-tags" : [ "Responses" ]
},
"Principal" : {
"required" : [ "id", "type" ],
"properties" : {
"id" : {
"type" : "string",
"description" : "Principal ID"
},
"type" : {
"type" : "string",
"description" : "Principal type",
"enum" : [ "User", "Role", "Group" ]
}
},
"description" : "Principal (read only)",
"x-tags" : [ "Model Definitions" ]
},
"PrivateLinkMongoDBConnection" : {
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MongoDB via PrivateLink",
"x-tags" : [ "Model Definitions" ]
},
"PrivateLinkMySQLConnection" : {
"properties" : {
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink Identifier"
}
},
"description" : "Connect to MySQL via PrivateLink",
"x-tags" : [ "Model Definitions" ]
},
"Privatelink" : {
"required" : [ "cloudRegionId", "name", "privatelinkId" ],
"properties" : {
"privatelinkId" : {
"type" : "string",
"description" : "Private link ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Name (read only)"
},
"cloudRegionId" : {
"type" : "string",
"description" : "Cloud region ID (read only)"
}
},
"description" : "A private link (read only)",
"x-tags" : [ "Model Definitions" ]
},
"Privilege" : {
"required" : [ "entityId", "entityKind", "grantKind", "grantOption", "privilege" ],
"properties" : {
"grantKind" : {
"type" : "string",
"description" : "Grant kind",
"enum" : [ "Allow", "Deny" ]
},
"entityId" : {
"type" : "string",
"description" : "Entity ID"
},
"entityKind" : {
"type" : "string",
"description" : "Entity kind",
"enum" : [ "Account", "AiModel", "Cluster", "Catalog", "Schema", "Table", "Column", "Location", "Function", "Tag", "TableBranch", "Policy", "RowFilter", "DataProduct", "DataDomain" ]
},
"grantOption" : {
"type" : "boolean",
"description" : "Grant option",
"nullable" : false
},
"privilege" : {
"type" : "string",
"description" : "Privilege",
"enum" : [ "ManageSecurity", "CreateRole", "CreateUser", "CreateCluster", "CreateCatalog", "CreateAiModel", "UseAiModel", "ViewAuditLog", "ManageBilling", "ManageNotifications", "ViewAllQueryHistory", "ManageSso", "SsoUserPasswordLogin", "ViewAllDataLineage", "UseCluster", "EnableDisableCluster", "MonitorCluster", "TroubleshootQuery", "CreateSchema", "CreateTable", "CreateBranch", "Insert", "Delete", "Select", "Update", "ManageDataObservability", "CreateSql", "Execute", "ManageServiceAccount", "ManageServiceAccountToken", "ManageOauthClient", "ViewPublicOauthClient", "ManageAccountWork", "CreateTag", "ApplyTag", "GenerativeAiFeatures", "ManageIngestStreams", "CreateFunction", "CancelQuery", "ViewDataProduct", "ManageCertification", "DownloadQueryResults", "ManageQueryRoutingRules", "ManageIcehouseOps", "CreateDataDomain", "ViewAllQueryProfilerResults" ]
},
"schemaName" : {
"type" : "string",
"description" : "Schema name"
},
"tableName" : {
"type" : "string",
"description" : "Table name"
},
"columnName" : {
"type" : "string",
"description" : "Column name"
}
},
"description" : "A role privilege to grant",
"x-tags" : [ "Model Definitions" ]
},
"Quotafailure" : {
"required" : [ "fieldViolations" ],
"properties" : {
"fieldViolations" : {
"type" : "array",
"description" : "Field violations (read only)",
"items" : {
"$ref" : "#/components/schemas/Fieldviolation"
}
}
},
"description" : "Error details (read only)",
"x-tags" : [ "Responses" ]
},
"RedshiftCatalog" : {
"required" : [ "authType", "catalogId", "endpoint", "name", "readOnly", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "Redshift catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"endpoint" : {
"type" : "string",
"description" : "Redshift cluster endpoint"
},
"authType" : {
"type" : "string"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "A catalog connecting to AWS Redshift",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"basic" : "#/components/schemas/RedshiftCatalogBasic",
"accessKey" : "#/components/schemas/RedshiftCatalogAccessKey",
"role" : "#/components/schemas/RedshiftCatalogRedshiftCrossAccountRoleAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogAccessKey" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RedshiftCatalog"
}, {
"required" : [ "accessKey", "region", "secretKey", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogBasic" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RedshiftCatalog"
}, {
"required" : [ "password", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogPatch" : {
"required" : [ "authType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"endpoint" : {
"type" : "string",
"description" : "Redshift cluster endpoint"
},
"authType" : {
"type" : "string"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "A catalog connecting to AWS Redshift",
"discriminator" : {
"propertyName" : "authType",
"mapping" : {
"basic" : "#/components/schemas/RedshiftCatalogPatchBasic",
"accessKey" : "#/components/schemas/RedshiftCatalogPatchAccessKey",
"role" : "#/components/schemas/RedshiftCatalogPatchRedshiftCrossAccountRoleAuth"
}
},
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogPatchAccessKey" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RedshiftCatalogPatch"
}, {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS access key and secret key pair",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogPatchBasic" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RedshiftCatalogPatch"
}, {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"password" : {
"type" : "string",
"description" : "Password"
}
},
"description" : "Authenticate with a username and password",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogPatchRedshiftCrossAccountRoleAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RedshiftCatalogPatch"
}, {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCatalogRedshiftCrossAccountRoleAuth" : {
"allOf" : [ {
"$ref" : "#/components/schemas/RedshiftCatalog"
}, {
"required" : [ "region", "roleArn", "username" ],
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"RedshiftCrossAccountRoleAuth" : {
"properties" : {
"username" : {
"type" : "string",
"description" : "Username"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"region" : {
"type" : "string",
"description" : "AWS region"
}
},
"description" : "Authenticate with an AWS cross account role",
"x-tags" : [ "Model Definitions" ]
},
"ResourceExhausted" : {
"required" : [ "detail", "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Description of the error"
},
"detail" : {
"$ref" : "#/components/schemas/Quotafailure"
}
},
"description" : "Either out of resource quota or reaching rate limiting. The client should look for QuotaFailure error detail for more information.",
"x-tags" : [ "Responses" ]
},
"Resourceinfo" : {
"required" : [ "description", "resourceName" ],
"properties" : {
"resourceName" : {
"type" : "string",
"description" : "Name of the resource (read only)"
},
"description" : {
"type" : "string",
"description" : "Violation description (read only)"
}
},
"description" : "Error details (read only)",
"x-tags" : [ "Responses" ]
},
"RevokePrivilege" : {
"required" : [ "entityId", "entityKind", "privilege", "revokeAction" ],
"properties" : {
"entityId" : {
"type" : "string",
"description" : "Entity ID"
},
"entityKind" : {
"type" : "string",
"description" : "Entity kind",
"enum" : [ "Account", "AiModel", "Cluster", "Catalog", "Schema", "Table", "Column", "Location", "Function", "Tag", "TableBranch", "Policy", "RowFilter", "DataProduct", "DataDomain" ]
},
"privilege" : {
"type" : "string",
"description" : "Privilege",
"enum" : [ "ManageSecurity", "CreateRole", "CreateUser", "CreateCluster", "CreateCatalog", "CreateAiModel", "UseAiModel", "ViewAuditLog", "ManageBilling", "ManageNotifications", "ViewAllQueryHistory", "ManageSso", "SsoUserPasswordLogin", "ViewAllDataLineage", "UseCluster", "EnableDisableCluster", "MonitorCluster", "TroubleshootQuery", "CreateSchema", "CreateTable", "CreateBranch", "Insert", "Delete", "Select", "Update", "ManageDataObservability", "CreateSql", "Execute", "ManageServiceAccount", "ManageServiceAccountToken", "ManageOauthClient", "ViewPublicOauthClient", "ManageAccountWork", "CreateTag", "ApplyTag", "GenerativeAiFeatures", "ManageIngestStreams", "CreateFunction", "CancelQuery", "ViewDataProduct", "ManageCertification", "DownloadQueryResults", "ManageQueryRoutingRules", "ManageIcehouseOps", "CreateDataDomain", "ViewAllQueryProfilerResults" ]
},
"schemaName" : {
"type" : "string",
"description" : "Schema name"
},
"tableName" : {
"type" : "string",
"description" : "Table name"
},
"columnName" : {
"type" : "string",
"description" : "Column name"
},
"revokeAction" : {
"type" : "string",
"description" : "Revoke grant option or remove role privilege",
"enum" : [ "RevokeGrantOption", "RemoveRoleGrant" ]
}
},
"description" : "A role privilege to revoke",
"x-tags" : [ "Model Definitions" ]
},
"Role" : {
"required" : [ "allRoles", "createdOn", "directlyGrantedRoles", "modifiedOn", "roleId", "roleName", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Role ID (read only)"
},
"roleName" : {
"type" : "string",
"description" : "Role name (read only)"
},
"roleDescription" : {
"type" : "string",
"description" : "Role description (read only)"
},
"owningRoleId" : {
"type" : "string",
"description" : "Owning role (read only)"
},
"directlyGrantedRoles" : {
"type" : "array",
"description" : "Directly granted roles (read only)",
"items" : {
"$ref" : "#/components/schemas/Rolegrant"
}
},
"allRoles" : {
"type" : "array",
"description" : "All directly granted and inherited roles (read only)",
"items" : {
"$ref" : "#/components/schemas/Rolegrant"
}
},
"createdOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation date (read only)"
},
"modifiedOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified date (read only)"
}
},
"description" : "A role",
"x-tags" : [ "Model Definitions" ]
},
"RoleWithName" : {
"required" : [ "roleId", "roleName" ],
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Role ID (read only)"
},
"roleName" : {
"type" : "string",
"description" : "Role name (read only)"
}
},
"description" : "Roles assigned to this group (read only)",
"x-tags" : [ "Model Definitions" ]
},
"RoleWithName2" : {
"required" : [ "roleId", "roleName" ],
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Role ID (read only)"
},
"roleName" : {
"type" : "string",
"description" : "Role name (read only)"
}
},
"description" : "The role that owns this resource (read only)",
"x-tags" : [ "Model Definitions" ]
},
"RoleWithNamePatch" : {
"description" : "Roles assigned to this group",
"x-tags" : [ "Model Definitions" ]
},
"Rolegrant" : {
"required" : [ "adminOption", "principal", "roleId", "roleName" ],
"properties" : {
"roleName" : {
"type" : "string",
"description" : "Role name"
},
"roleId" : {
"type" : "string",
"description" : "Role ID"
},
"principal" : {
"$ref" : "#/components/schemas/Principal"
},
"adminOption" : {
"type" : "boolean",
"description" : "Admin option",
"nullable" : false
}
},
"description" : "Directly granted roles (read only)",
"x-tags" : [ "Model Definitions" ]
},
"RowFilter" : {
"required" : [ "created", "description", "expression", "modified", "name", "rowFilterId", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"rowFilterId" : {
"type" : "string",
"description" : "Row Filter ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Row Filter name (read only)"
},
"expression" : {
"type" : "string",
"description" : "Row Filter expression (read only)"
},
"description" : {
"type" : "string",
"description" : "Description (read only)"
},
"created" : {
"format" : "date-time",
"type" : "string",
"description" : "Created on (read only)"
},
"modified" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified on (read only)"
}
},
"description" : "A row filter",
"x-tags" : [ "Model Definitions" ]
},
"RowFilterForUpdatePatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Row filter name"
},
"expression" : {
"type" : "string",
"description" : "Row filter expression"
},
"description" : {
"type" : "string",
"description" : "Description"
}
},
"description" : "Update a row filter",
"x-tags" : [ "Model Definitions" ]
},
"RunSchemaDiscovery" : {
"required" : [ "forceFullDiscovery", "options", "skipApplying", "uri" ],
"properties" : {
"uri" : {
"type" : "string",
"description" : "Root uri, that schema discovery will start from. Current role must have location security correctly set up. (read only)"
},
"defaultSchemaName" : {
"type" : "string",
"description" : "Schema name that will be used for top-level tables, which aren't under any schema (read only)"
},
"options" : {
"type" : "object",
"description" : "Configuration options for schema discovery (read only)",
"additionalProperties" : {
"type" : "string",
"description" : "Configuration options for schema discovery (read only)"
}
},
"skipApplying" : {
"type" : "boolean",
"description" : "Do not apply schema discovery results to catalog, useful if tables needs to be inspected manually before running SQLs (read only)",
"nullable" : false
},
"forceFullDiscovery" : {
"type" : "boolean",
"description" : "Always run full discovery, disregarding any previous discoveries under same `uri` (read only)",
"nullable" : false
}
},
"description" : "Run schema discovery",
"x-tags" : [ "Model Definitions" ]
},
"S3Catalog" : {
"required" : [ "catalogId", "metastoreType", "name", "readOnly", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "S3 catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"metastoreType" : {
"type" : "string"
},
"defaultTableFormat" : {
"type" : "string",
"description" : "Default table format for new tables: ICEBERG, DELTA, or HIVE. Defaults to ICEBERG."
},
"externalTableCreationEnabled" : {
"type" : "boolean",
"description" : "Allow creating external tables. Defaults to false.",
"nullable" : false
},
"externalTableWritesEnabled" : {
"type" : "boolean",
"description" : "Allow writing to external tables. Defaults to false.",
"nullable" : false
},
"metadataMaxStalenessSeconds" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum metadata staleness in seconds (30, 60, 90, or 120)",
"nullable" : false
}
},
"description" : "A catalog connecting to S3",
"discriminator" : {
"propertyName" : "metastoreType",
"mapping" : {
"galaxy" : "#/components/schemas/S3CatalogGalaxyMetastore",
"glue" : "#/components/schemas/S3CatalogGlueMetastore",
"hive" : "#/components/schemas/S3CatalogHiveMetastore"
}
},
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogGalaxyMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/S3Catalog"
}, {
"required" : [ "defaultBucket", "defaultDataLocation" ],
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogGlueMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/S3Catalog"
}, {
"required" : [ "defaultBucket", "defaultDataLocation", "region" ],
"properties" : {
"region" : {
"type" : "string",
"description" : "AWS region"
},
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
},
"glueAccessKey" : {
"type" : "string",
"description" : "AWS access key for AWS Glue access"
},
"glueSecretKey" : {
"type" : "string",
"description" : "AWS secret key for AWS Glue access"
},
"glueRoleArn" : {
"type" : "string",
"description" : "AWS cross account role for AWS Glue access"
}
},
"description" : "Store metadata in AWS Glue",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogHiveMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/S3Catalog"
}, {
"required" : [ "hiveMetastoreHost" ],
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogPatch" : {
"required" : [ "metastoreType" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"accessKey" : {
"type" : "string",
"description" : "AWS access key"
},
"secretKey" : {
"type" : "string",
"description" : "AWS secret key"
},
"roleArn" : {
"type" : "string",
"description" : "AWS cross account role ARN"
},
"metastoreType" : {
"type" : "string"
},
"defaultTableFormat" : {
"type" : "string",
"description" : "Default table format for new tables: ICEBERG, DELTA, or HIVE. Defaults to ICEBERG."
},
"externalTableCreationEnabled" : {
"type" : "boolean",
"description" : "Allow creating external tables. Defaults to false.",
"nullable" : false
},
"externalTableWritesEnabled" : {
"type" : "boolean",
"description" : "Allow writing to external tables. Defaults to false.",
"nullable" : false
},
"metadataMaxStalenessSeconds" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum metadata staleness in seconds (30, 60, 90, or 120)",
"nullable" : false
}
},
"description" : "A catalog connecting to S3",
"discriminator" : {
"propertyName" : "metastoreType",
"mapping" : {
"galaxy" : "#/components/schemas/S3CatalogPatchGalaxyMetastore",
"glue" : "#/components/schemas/S3CatalogPatchGlueMetastore",
"hive" : "#/components/schemas/S3CatalogPatchHiveMetastore"
}
},
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogPatchGalaxyMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/S3CatalogPatch"
}, {
"properties" : {
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
}
},
"description" : "Store metadata in the Galaxy metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogPatchGlueMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/S3CatalogPatch"
}, {
"properties" : {
"region" : {
"type" : "string",
"description" : "AWS region"
},
"defaultBucket" : {
"type" : "string",
"description" : "S3 bucket to use when storing data for new schemas"
},
"defaultDataLocation" : {
"type" : "string",
"description" : "Default location to store data for new schemas"
},
"glueAccessKey" : {
"type" : "string",
"description" : "AWS access key for AWS Glue access"
},
"glueSecretKey" : {
"type" : "string",
"description" : "AWS secret key for AWS Glue access"
},
"glueRoleArn" : {
"type" : "string",
"description" : "AWS cross account role for AWS Glue access"
}
},
"description" : "Store metadata in AWS Glue",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"S3CatalogPatchHiveMetastore" : {
"allOf" : [ {
"$ref" : "#/components/schemas/S3CatalogPatch"
}, {
"properties" : {
"hiveMetastoreHost" : {
"type" : "string",
"description" : "Hive metastore host url"
},
"hiveMetastorePort" : {
"format" : "int32",
"type" : "integer",
"description" : "Hive metastore host port. Defaults to 9083.",
"nullable" : false
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
}
},
"description" : "Store metadata in a Hive metastore",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"SaslPlainAuth" : {
"properties" : {
"username" : {
"type" : "string",
"description" : "SASL username"
},
"password" : {
"type" : "string",
"description" : "SASL password"
}
},
"description" : "SASL/PLAIN authentication over TLS",
"x-tags" : [ "Model Definitions" ]
},
"SaslScramAuth" : {
"properties" : {
"username" : {
"type" : "string",
"description" : "SASL username"
},
"password" : {
"type" : "string",
"description" : "SASL password"
},
"scramType" : {
"type" : "string",
"description" : "SCRAM hash algorithm",
"enum" : [ "Sha256", "Sha512" ]
}
},
"description" : "SASL/SCRAM authentication over TLS",
"x-tags" : [ "Model Definitions" ]
},
"Schema" : {
"required" : [ "contacts", "links", "schemaId", "tags" ],
"properties" : {
"schemaId" : {
"type" : "string",
"description" : "Schema ID (read only)"
},
"description" : {
"type" : "string",
"description" : "Any description set for this schema (read only)"
},
"owner" : {
"$ref" : "#/components/schemas/RoleWithName2"
},
"tags" : {
"type" : "array",
"description" : "Any tags set for this schema (read only)",
"items" : {
"$ref" : "#/components/schemas/TagName"
}
},
"contacts" : {
"type" : "array",
"description" : "Any contacts set for this schema (read only)",
"items" : {
"$ref" : "#/components/schemas/UserAndEmail"
}
},
"links" : {
"type" : "array",
"description" : "Any links set for this schema (read only)",
"items" : {
"$ref" : "#/components/schemas/Link"
}
}
},
"description" : "A schema from a catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"SchemaDataQualityChecksRollup" : {
"required" : [ "evaluatedChecks", "failedChecks", "notYetEvaluatedChecks", "numberOfChecks", "schemaId", "successfulChecks" ],
"properties" : {
"schemaId" : {
"type" : "string",
"description" : "Schema ID"
},
"numberOfChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Total number of quality checks",
"nullable" : false
},
"evaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of evaluated quality checks",
"nullable" : false
},
"failedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of failed quality checks",
"nullable" : false
},
"successfulChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of successful quality checks",
"nullable" : false
},
"notYetEvaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of not yet evaluated quality checks",
"nullable" : false
}
},
"description" : "Summaries per schema (read only)",
"x-tags" : [ "Model Definitions" ]
},
"SchemaDiscovery" : {
"required" : [ "catalogId", "createdAt", "createdTablesCount", "defaultSchemaName", "deletedTablesCount", "errors", "options", "schemaDiscoveryId", "sqlStatements", "status", "syncToken", "updatedTablesCount", "uri" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"schemaDiscoveryId" : {
"type" : "string",
"description" : "Schema discovery ID (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "Catalog ID (read only)"
},
"createdAt" : {
"format" : "date-time",
"type" : "string",
"description" : "Time when schema discovery was created (read only)"
},
"startedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "Time when schema discovery has started (read only)"
},
"finishedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "Time when schema discovery has finished (read only)"
},
"uri" : {
"type" : "string",
"description" : "Root location for schema discovery (read only)"
},
"defaultSchemaName" : {
"type" : "string",
"description" : "Default schema name, used when tables without schemas were discovered (read only)"
},
"status" : {
"type" : "string",
"description" : "Status of schema discovery (read only)",
"enum" : [ "Scheduled", "Running", "Errored", "Success", "RescanScheduled", "RescanRunning", "ApplyScheduled", "ApplyRunning", "ApplyErrored", "ApplySuccess", "Deprecated" ]
},
"basedOnSchemaDiscoveryId" : {
"type" : "string",
"description" : "ID of schema discovery which this one is based on, in case of diff runs (read only)"
},
"errors" : {
"type" : "array",
"description" : "Errors that prevented schema discovery to finish (read only)",
"items" : {
"type" : "string",
"description" : "Errors that prevented schema discovery to finish (read only)"
}
},
"options" : {
"type" : "object",
"description" : "Configuration options (read only)",
"additionalProperties" : {
"type" : "string",
"description" : "Configuration options (read only)"
}
},
"sqlStatements" : {
"type" : "array",
"description" : "Generated SQL statements (read only)",
"items" : {
"$ref" : "#/components/schemas/DiscoveredSqlStatement"
}
},
"createdTablesCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of tables to create (read only)",
"nullable" : false
},
"updatedTablesCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of tables to update (read only)",
"nullable" : false
},
"deletedTablesCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of tables to delete (read only)",
"nullable" : false
}
},
"description" : "A schema discovery run",
"x-tags" : [ "Model Definitions" ]
},
"ScopesPatch" : {
"description" : "Policy scopes",
"x-tags" : [ "Model Definitions" ]
},
"ServiceAccount" : {
"required" : [ "additionalRoleIds", "passwords", "roleId", "serviceAccountId", "syncToken", "userName" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"serviceAccountId" : {
"type" : "string",
"description" : "Service account ID (read only)"
},
"userName" : {
"type" : "string",
"description" : "Service account user name (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Default role (read only)"
},
"additionalRoleIds" : {
"type" : "array",
"description" : "Additional roles (read only)",
"items" : {
"type" : "string",
"description" : "Additional roles (read only)"
}
},
"passwords" : {
"type" : "array",
"description" : "Passwords (read only)",
"items" : {
"$ref" : "#/components/schemas/ServiceAccountPassword"
}
}
},
"description" : "A service account",
"x-tags" : [ "Model Definitions" ]
},
"ServiceAccountPassword" : {
"required" : [ "created", "passwordPrefix", "serviceAccountPasswordId", "syncToken" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"serviceAccountPasswordId" : {
"type" : "string",
"description" : "Service account password ID (read only)"
},
"passwordPrefix" : {
"type" : "string",
"description" : "Service account password prefix (read only)"
},
"password" : {
"type" : "string",
"description" : "Service account password (read only)"
},
"description" : {
"type" : "string",
"description" : "Description (read only)"
},
"created" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation time (read only)"
},
"lastLogin" : {
"format" : "date-time",
"type" : "string",
"description" : "Last login time (read only)"
}
},
"description" : "Passwords (read only)",
"x-tags" : [ "Model Definitions" ]
},
"SeverityEvaluationCounts" : {
"required" : [ "failedEvaluations", "severity", "successfulEvaluations", "totalEvaluations" ],
"properties" : {
"severity" : {
"type" : "string",
"description" : "Data quality check severity",
"enum" : [ "Low", "Medium", "High", "Critical" ]
},
"totalEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Total evaluations",
"nullable" : false
},
"successfulEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Successful evaluations",
"nullable" : false
},
"failedEvaluations" : {
"format" : "int32",
"type" : "integer",
"description" : "Failed evaluations",
"nullable" : false
}
},
"description" : "Counts grouped by severities (read only)",
"x-tags" : [ "Model Definitions" ]
},
"SnowflakeCatalog" : {
"required" : [ "accountIdentifier", "catalogId", "databaseName", "name", "readOnly", "syncToken", "username" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "Snowflake catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "Snowflake cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"accountIdentifier" : {
"type" : "string",
"description" : "Snowflake account identifier"
},
"databaseName" : {
"type" : "string",
"description" : "Snowflake database name"
},
"username" : {
"type" : "string",
"description" : "Snowflake username"
},
"password" : {
"type" : "string",
"description" : "Snowflake password"
},
"privateKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text PEM Snowflake private key"
},
"privateKeyPassphrase" : {
"type" : "string",
"description" : "Snowflake private key passphrase"
},
"authenticationType" : {
"type" : "string",
"description" : "Snowflake authentication type"
},
"warehouse" : {
"type" : "string",
"description" : "Snowflake warehouse name"
},
"role" : {
"type" : "string",
"description" : "Snowflake role"
}
},
"description" : "A catalog connecting to Snowflake",
"x-tags" : [ "Model Definitions" ]
},
"SnowflakeCatalogPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "Snowflake cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"accountIdentifier" : {
"type" : "string",
"description" : "Snowflake account identifier"
},
"databaseName" : {
"type" : "string",
"description" : "Snowflake database name"
},
"username" : {
"type" : "string",
"description" : "Snowflake username"
},
"password" : {
"type" : "string",
"description" : "Snowflake password"
},
"privateKey" : {
"type" : "string",
"description" : "Base64 encoded or plain text PEM Snowflake private key"
},
"privateKeyPassphrase" : {
"type" : "string",
"description" : "Snowflake private key passphrase"
},
"authenticationType" : {
"type" : "string",
"description" : "Snowflake authentication type"
},
"warehouse" : {
"type" : "string",
"description" : "Snowflake warehouse name"
},
"role" : {
"type" : "string",
"description" : "Snowflake role"
}
},
"description" : "A catalog connecting to Snowflake",
"x-tags" : [ "Model Definitions" ]
},
"SqlJob" : {
"required" : [ "clusterId", "cronExpression", "name", "nextExecution", "queries", "roleId", "sqlJobId", "syncToken", "timezone" ],
"properties" : {
"sqlJobId" : {
"type" : "string",
"description" : "ID of a SQL job (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Role used when SQL job is executed"
},
"name" : {
"type" : "string",
"description" : "SQL job name"
},
"description" : {
"type" : "string",
"description" : "SQL job description"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated. Defaults to UTC"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines SQL job execution interval"
},
"clusterId" : {
"type" : "string",
"description" : "ID of cluster in which SQL job gets executed"
},
"nextExecution" : {
"format" : "date-time",
"type" : "string",
"description" : "Timestamp of SQL job next execution (read only)"
},
"queries" : {
"type" : "array",
"description" : "SQL queries to execute.",
"items" : {
"type" : "string",
"description" : "SQL queries to execute."
}
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
}
},
"description" : "SQL query scheduled job",
"x-tags" : [ "Model Definitions" ]
},
"SqlJobHistory" : {
"required" : [ "progressPercentage", "queries", "queryIds", "status", "updatedAt" ],
"properties" : {
"status" : {
"type" : "string",
"description" : "SQL job status (read only)",
"enum" : [ "Scheduled", "Queued", "InProgress", "Completed", "Failed" ]
},
"startedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "SQL job start time (read only)"
},
"updatedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "SQL job last update time (read only)"
},
"progressPercentage" : {
"format" : "double",
"type" : "number",
"description" : "Percentage progress of SQL job execution (read only)",
"nullable" : false
},
"queryIds" : {
"type" : "array",
"description" : "IDs of SQL queries that were run. (read only)",
"items" : {
"type" : "string",
"description" : "IDs of SQL queries that were run. (read only)"
}
},
"queries" : {
"type" : "array",
"description" : "SQL queries that were run. (read only)",
"items" : {
"type" : "string",
"description" : "SQL queries that were run. (read only)"
}
},
"errorMessage" : {
"type" : "string",
"description" : "Error encountered when SQL query was run (read only)"
}
},
"description" : "History of a SQL query job (read only)",
"x-tags" : [ "Model Definitions" ]
},
"SqlJobListItem" : {
"required" : [ "cronExpression", "name", "roleId", "sqlJobId", "syncToken", "timezone" ],
"properties" : {
"sqlJobId" : {
"type" : "string",
"description" : "ID of a SQL job (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Role used when SQL job is executed"
},
"name" : {
"type" : "string",
"description" : "SQL job name"
},
"description" : {
"type" : "string",
"description" : "SQL job description"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated. Defaults to UTC"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines SQL job execution interval"
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
}
},
"description" : "SQL query scheduled job",
"x-tags" : [ "Model Definitions" ]
},
"SqlJobStatus" : {
"required" : [ "progressPercentage", "queryIds", "sqlJobId", "status", "updatedAt" ],
"properties" : {
"sqlJobId" : {
"type" : "string",
"description" : "ID of a SQL job (read only)"
},
"status" : {
"type" : "string",
"description" : "SQL job status (read only)",
"enum" : [ "Scheduled", "Queued", "InProgress", "Completed", "Failed" ]
},
"updatedAt" : {
"format" : "date-time",
"type" : "string",
"description" : "Status last update time (read only)"
},
"progressPercentage" : {
"format" : "double",
"type" : "number",
"description" : "Percentage progress of SQL job execution (read only)",
"nullable" : false
},
"queryIds" : {
"type" : "array",
"description" : "IDs of SQL queries. (read only)",
"items" : {
"type" : "string",
"description" : "IDs of SQL queries. (read only)"
}
},
"errorMessage" : {
"type" : "string",
"description" : "Error encountered when SQL query was run (read only)"
}
},
"description" : "Current status of a SQL query job (read only)",
"x-tags" : [ "Model Definitions" ]
},
"SqlServerCatalog" : {
"required" : [ "catalogId", "databaseName", "name", "password", "readOnly", "syncToken", "username" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"catalogId" : {
"type" : "string",
"description" : "SQL Server catalog identifier (read only)"
},
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "SQL Server cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"endpoint" : {
"type" : "string",
"description" : "SQL Server database endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "SQL Server database port. Defaults to 1433.",
"nullable" : false
},
"databaseName" : {
"type" : "string",
"description" : "SQL Server database name"
},
"username" : {
"type" : "string",
"description" : "SQL Server database username"
},
"password" : {
"type" : "string",
"description" : "SQL Server database password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink identifier"
}
},
"description" : "A catalog connecting to SQL Server",
"x-tags" : [ "Model Definitions" ]
},
"SqlServerCatalogPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Catalog name"
},
"description" : {
"type" : "string",
"description" : "Catalog description"
},
"readOnly" : {
"type" : "boolean",
"description" : "Is catalog read only",
"nullable" : false
},
"validate" : {
"type" : "boolean",
"description" : "Validate catalog configuration before creation",
"nullable" : false
},
"cloudKind" : {
"type" : "string",
"description" : "SQL Server cloud kind. Defaults to AWS.",
"enum" : [ "AWS", "AZURE", "GCP" ]
},
"endpoint" : {
"type" : "string",
"description" : "SQL Server database endpoint"
},
"port" : {
"format" : "int32",
"type" : "integer",
"description" : "SQL Server database port. Defaults to 1433.",
"nullable" : false
},
"databaseName" : {
"type" : "string",
"description" : "SQL Server database name"
},
"username" : {
"type" : "string",
"description" : "SQL Server database username"
},
"password" : {
"type" : "string",
"description" : "SQL Server database password"
},
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"privateLinkId" : {
"type" : "string",
"description" : "PrivateLink identifier"
}
},
"description" : "A catalog connecting to SQL Server",
"x-tags" : [ "Model Definitions" ]
},
"SshTunnelMongoDBConnection" : {
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"hosts" : {
"type" : "string",
"description" : "MongoDB hosts"
}
},
"description" : "Connect to MongoDB via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
},
"SshTunnelMySQLConnection" : {
"properties" : {
"sshTunnelId" : {
"type" : "string",
"description" : "SSH tunnel identifier"
},
"host" : {
"type" : "string",
"description" : "MySQL host"
}
},
"description" : "Connect to MySQL via SSH Tunnel",
"x-tags" : [ "Model Definitions" ]
},
"Table" : {
"required" : [ "contacts", "tableId", "tags" ],
"properties" : {
"tableId" : {
"type" : "string",
"description" : "Table ID (read only)"
},
"tableType" : {
"type" : "string",
"description" : "Any table type returned from the data source (read only)"
},
"description" : {
"type" : "string",
"description" : "Any description set for this table (read only)"
},
"owner" : {
"$ref" : "#/components/schemas/RoleWithName2"
},
"tags" : {
"type" : "array",
"description" : "Any tags set for this table (read only)",
"items" : {
"$ref" : "#/components/schemas/TagName"
}
},
"contacts" : {
"type" : "array",
"description" : "Any contacts set for this table (read only)",
"items" : {
"$ref" : "#/components/schemas/UserAndEmail"
}
}
},
"description" : "A table from a catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"TableDataQualityChecksRollup" : {
"required" : [ "evaluatedChecks", "failedChecks", "notYetEvaluatedChecks", "numberOfChecks", "successfulChecks", "tableId" ],
"properties" : {
"tableId" : {
"type" : "string",
"description" : "Table ID"
},
"numberOfChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Total number of quality checks",
"nullable" : false
},
"evaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of evaluated quality checks",
"nullable" : false
},
"failedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of failed quality checks",
"nullable" : false
},
"successfulChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of successful quality checks",
"nullable" : false
},
"notYetEvaluatedChecks" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of not yet evaluated quality checks",
"nullable" : false
}
},
"description" : "Summaries per table (read only)",
"x-tags" : [ "Model Definitions" ]
},
"Tag" : {
"required" : [ "color", "name", "syncToken", "tagId" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"tagId" : {
"type" : "string",
"description" : "Tag ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Tag name (read only)"
},
"color" : {
"type" : "string",
"description" : "Tag color (read only)"
},
"description" : {
"type" : "string",
"description" : "Comment (read only)"
}
},
"description" : "A tag",
"x-tags" : [ "Model Definitions" ]
},
"TagName" : {
"required" : [ "name", "tagId" ],
"properties" : {
"tagId" : {
"type" : "string",
"description" : "Tag ID (read only)"
},
"name" : {
"type" : "string",
"description" : "Tag name (read only)"
}
},
"description" : "Any tags set for this catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"TransformLiveTableSchemaUpdate" : {
"required" : [ "newSchema", "syncToken", "transformLiveTableSchemaUpdateId" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"transformLiveTableSchemaUpdateId" : {
"type" : "string",
"description" : "ID of live table whose schema is being updated"
},
"newSchema" : {
"$ref" : "#/components/schemas/NewSchema"
}
},
"description" : "New schema for a transform live table",
"x-tags" : [ "Model Definitions" ]
},
"Type" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"TypeProperties" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "Type-specific live table properties",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"kafkaIngestProperties" : "#/components/schemas/TypePropertiesKafkaIngestProperties",
"fileIngestProperties" : "#/components/schemas/TypePropertiesFileIngestProperties",
"ingestJsonTransformProperties" : "#/components/schemas/TypePropertiesIngestJsonTransformProperties",
"ingestSchemaRegistryAvroTransformProperties" : "#/components/schemas/TypePropertiesIngestSchemaRegistryAvroTransformProperties",
"filterAndProjectTransformProperties" : "#/components/schemas/TypePropertiesFilterAndProjectTransformProperties"
}
},
"x-tags" : [ "Model Definitions" ]
},
"TypePropertiesFileIngestProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/TypeProperties"
}, {
"required" : [ "fileFormat", "fileIngestSourceId", "pollingIntervalInMinutes" ],
"properties" : {
"fileIngestSourceId" : {
"type" : "string",
"description" : "ID of the file ingest source obtained from the /fileIngestSource endpoint"
},
"pathSuffix" : {
"type" : "string",
"description" : "Suffix to append to the name from ingest source"
},
"fileFormat" : {
"type" : "string",
"description" : "File format",
"enum" : [ "Json", "Csv" ]
},
"pollingIntervalInMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "List files in object storage every polling interval",
"nullable" : false
},
"csvParameters" : {
"required" : [ "delimiter", "escapeChar", "numHeaderLinesToExclude", "quoteChar" ],
"properties" : {
"delimiter" : {
"type" : "string",
"description" : "CSV delimiter character",
"enum" : [ "Comma", "Tab", "Pipe", "Semicolon" ]
},
"quoteChar" : {
"type" : "string",
"description" : "CSV quote character",
"enum" : [ "DoubleQuote", "SingleQuote" ]
},
"escapeChar" : {
"type" : "string",
"description" : "CSV escape character",
"enum" : [ "DoubleQuote", "Backslash" ]
},
"numHeaderLinesToExclude" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of CSV header lines to exclude",
"nullable" : false
}
},
"description" : "CSV format parameters. Required for CSV format, must be absent for other formats",
"x-tags" : [ "Model Definitions" ]
}
},
"description" : "Properties for a live table ingesting from a file",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"TypePropertiesFilterAndProjectTransformProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/TypeProperties"
}, {
"required" : [ "columns", "filterExpressions", "liveTableId" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source transform table"
},
"columns" : {
"type" : "array",
"description" : "Output columns and the expressions that produce their values",
"items" : {
"required" : [ "columnId", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Column name"
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"expression" : {
"type" : "string",
"description" : "Trino SQL expression producing this column's value; present only for top-level columns"
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array)",
"items" : {
"$ref" : "#/components/schemas/FilterAndProjectTransformColumn"
}
}
},
"description" : "Output columns and the expressions that produce their values",
"x-tags" : [ "Model Definitions" ]
}
},
"filterExpressions" : {
"type" : "array",
"description" : "Filter predicates over the input table's columns; at most one is supported",
"items" : {
"type" : "string",
"description" : "Filter predicates over the input table's columns; at most one is supported"
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
}
},
"description" : "Properties for a filter and project transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"TypePropertiesIngestJsonTransformProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/TypeProperties"
}, {
"required" : [ "liveTableId", "userDefinedSchema" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"userDefinedSchema" : {
"type" : "array",
"description" : "Schema of the transformed table",
"items" : {
"required" : [ "columnId", "fieldParserConfig", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/IngestColumn"
}
}
},
"description" : "Schema of the transformed table",
"x-tags" : [ "Model Definitions" ]
}
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties for a JSON transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"TypePropertiesIngestSchemaRegistryAvroTransformProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/TypeProperties"
}, {
"required" : [ "liveTableId", "schemaRegistryId", "subjectName" ],
"properties" : {
"liveTableId" : {
"type" : "string",
"description" : "ID of the source table"
},
"schemaRegistryId" : {
"type" : "string",
"description" : "Schema registry id associated with the live table"
},
"subjectName" : {
"type" : "string",
"description" : "Subject name in the schema registry"
},
"userDefinedPartitionSpec" : {
"type" : "array",
"description" : "Custom partition spec for transform live tables",
"items" : {
"required" : [ "transformType", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Column name from IngestColumn or NewIngestColumn"
},
"transformType" : {
"type" : "string",
"description" : "One of {identity, year, month, day, hour, bucket, truncate, void}"
},
"bucketCount" : {
"format" : "int32",
"type" : "integer",
"description" : "Bucket count when transformType=bucket",
"nullable" : false
},
"truncateWidth" : {
"format" : "int32",
"type" : "integer",
"description" : "Width when transformType=truncate",
"nullable" : false
}
},
"description" : "Custom partition spec for transform live tables",
"x-tags" : [ "Model Definitions" ]
}
},
"sortColumnName" : {
"type" : "string",
"description" : "Sort column"
},
"fanoutColumns" : {
"type" : "array",
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"items" : {
"required" : [ "transform", "trinoColumnName" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the column to route on, from IngestColumn or NewIngestColumn"
},
"transform" : {
"type" : "string",
"description" : "Transform applied to the column value to form the route",
"enum" : [ "Identity" ]
}
},
"description" : "Fans the table's output out into one sink table per distinct combination of these column values, instead of a single output table. Order is part of the route's identity, and the columns cannot be changed once the table exists",
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "Properties for a schema registry Avro transform live table",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"TypePropertiesKafkaIngestProperties" : {
"allOf" : [ {
"$ref" : "#/components/schemas/TypeProperties"
}, {
"required" : [ "kafkaIngestSourceId", "kafkaTopicName", "latencyMode", "partitionMaxBytesPerSec", "startStrategy" ],
"properties" : {
"kafkaIngestSourceId" : {
"type" : "string",
"description" : "ID of the Kafka ingest source obtained from the /kafkaIngestSource endpoint"
},
"kafkaTopicName" : {
"type" : "string",
"description" : "Kafka topic name"
},
"startStrategy" : {
"type" : "string",
"description" : "Stream start strategy",
"enum" : [ "Earliest", "Latest" ]
},
"partitionMaxBytesPerSec" : {
"format" : "int64",
"type" : "integer",
"description" : "Throughput limit per partition",
"nullable" : false
},
"latencyMode" : {
"type" : "string",
"description" : "Latency mode for commits",
"enum" : [ "BalancedMode", "LowLatencyMode" ]
}
},
"description" : "Properties for a live table ingesting from Kafka",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"Unauthorized" : {
"properties" : {
"message" : {
"type" : "string",
"description" : ""
}
},
"description" : "Authorization failed",
"x-tags" : [ "Responses" ]
},
"UpdateCatalogMetadataPatch" : {
"properties" : {
"contacts" : {
"type" : "array",
"description" : "Catalog contacts",
"items" : {
"$ref" : "#/components/schemas/UserAndEmailPatch"
}
}
},
"description" : "Update catalog metadata",
"x-tags" : [ "Model Definitions" ]
},
"UpdateClusterPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Updated name of the cluster"
},
"cloudRegionId" : {
"type" : "string",
"description" : "Updated cloud region ID of the cluster"
},
"catalogRefs" : {
"type" : "array",
"description" : "Catalog IDs to attach to the cluster",
"items" : {
"type" : "string",
"description" : "Catalog IDs to attach to the cluster"
}
},
"idleStopMinutes" : {
"format" : "int32",
"type" : "integer",
"description" : "Idle suspend duration (in minutes)",
"nullable" : false
},
"processingMode" : {
"type" : "string",
"description" : "Cluster query processing mode",
"enum" : [ "Batch", "WarpSpeed" ]
},
"minWorkers" : {
"format" : "int32",
"type" : "integer",
"description" : "Minimum worker count",
"nullable" : false
},
"maxWorkers" : {
"format" : "int32",
"type" : "integer",
"description" : "Maximum worker count",
"nullable" : false
},
"enabled" : {
"type" : "boolean",
"description" : "Enable/Disable a cluster",
"nullable" : false
},
"resultCacheEnabled" : {
"type" : "boolean",
"description" : "Enable/Disable resultset caching",
"nullable" : false
},
"resultCacheDefaultVisibilitySeconds" : {
"format" : "int64",
"type" : "integer",
"description" : "Default visibility for resultset caching (in seconds)",
"nullable" : false
},
"privateLinkCluster" : {
"type" : "boolean",
"description" : "Enable/Disable Private Link",
"nullable" : false
},
"replicas" : {
"format" : "int32",
"type" : "integer",
"description" : "Number of replicas",
"nullable" : false
}
},
"description" : "Update a Trino cluster",
"x-tags" : [ "Model Definitions" ]
},
"UpdateColumnMaskPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Column mask name"
},
"expression" : {
"type" : "string",
"description" : "Column mask expression"
},
"columnMaskType" : {
"type" : "string",
"description" : "Column mask type",
"enum" : [ "Any", "Integer", "Boolean", "Date", "Decimal", "Real", "Double", "Timestamp", "TimestampWithTimeZone", "Time", "TimeWithTimeZone", "Varbinary", "Varchar" ]
},
"description" : {
"type" : "string",
"description" : "Description"
}
},
"description" : "Update a column mask",
"x-tags" : [ "Model Definitions" ]
},
"UpdateColumnPatch" : {
"properties" : {
"description" : {
"type" : "string",
"description" : "Column description"
}
},
"description" : "Update column metadata",
"x-tags" : [ "Model Definitions" ]
},
"UpdateColumnsPatch" : {
"properties" : {
"descriptions" : {
"type" : "object",
"description" : "Map of column ID to new description",
"additionalProperties" : {
"type" : "string",
"description" : "Map of column ID to new description"
}
}
},
"description" : "Update descriptions for multiple columns in a table",
"x-tags" : [ "Model Definitions" ]
},
"UpdateDataDomainPatch" : {
"properties" : {
"description" : {
"type" : "string",
"description" : "Long form description of the Data Domain"
},
"contactUserId" : {
"type" : "string",
"description" : "Data Domain contact"
},
"roleId" : {
"type" : "string",
"description" : "Owning role ID"
}
},
"description" : "Update a Galaxy Data Domain",
"x-tags" : [ "Model Definitions" ]
},
"UpdateDataProductPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Data Product name"
},
"summary" : {
"type" : "string",
"description" : "Short summary of Data Product"
},
"description" : {
"type" : "string",
"description" : "Long form description of Data Product"
},
"contacts" : {
"type" : "array",
"description" : "Data Product contacts",
"items" : {
"$ref" : "#/components/schemas/UserAndEmailPatch"
}
},
"links" : {
"type" : "array",
"description" : "Any links for this Data Product",
"items" : {
"$ref" : "#/components/schemas/LinkPatch"
}
},
"defaultClusterId" : {
"type" : "string",
"description" : "Default cluster ID for Data Product"
},
"businessContext" : {
"type" : "string",
"description" : "Business context for the Data Product, used to guide AI agents"
}
},
"description" : "Update a Galaxy Data Product",
"x-tags" : [ "Model Definitions" ]
},
"UpdateDataQualityCheckPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Data Quality check name"
},
"description" : {
"type" : "string",
"description" : "Description of what this check validates"
},
"query" : {
"type" : "string",
"description" : "Either expression or SQL query that implements the data quality check logic."
},
"severity" : {
"type" : "string",
"description" : "Severity level of check failures",
"enum" : [ "Low", "Medium", "High", "Critical" ]
},
"category" : {
"type" : "string",
"description" : "Category of data quality check",
"enum" : [ "Validity", "Completeness", "Consistency", "Accuracy", "None" ]
},
"clusterId" : {
"type" : "string",
"description" : "ClusterId to validate expression on. Required for 'SqlQuery' kind quality checks."
}
},
"description" : "Update data quality check request",
"x-tags" : [ "Model Definitions" ]
},
"UpdateDataQualitySchedulePatch" : {
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Role used when checks are executed"
},
"clusterId" : {
"type" : "string",
"description" : "Cluster in which checks are executed"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated. Defaults to UTC"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines SQL job execution interval"
}
},
"description" : "Update data quality schedule for a table",
"x-tags" : [ "Model Definitions" ]
},
"UpdateGroupRoleGrantsPatch" : {
"properties" : {
"roles" : {
"type" : "array",
"description" : "Roles assigned to this group",
"items" : {
"$ref" : "#/components/schemas/RoleWithNamePatch"
}
}
},
"description" : "Grant or revoke group roles",
"x-tags" : [ "Model Definitions" ]
},
"UpdatePolicyPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Policy name"
},
"predicate" : {
"type" : "string",
"description" : "Policy predicate"
},
"description" : {
"type" : "string",
"description" : "Policy description"
},
"expiration" : {
"format" : "date-time",
"type" : "string",
"description" : "Policy expiration"
},
"scopes" : {
"type" : "array",
"description" : "Policy scopes",
"items" : {
"$ref" : "#/components/schemas/ScopesPatch"
}
}
},
"description" : "A new policy",
"x-tags" : [ "Model Definitions" ]
},
"UpdateRoleGrantPatch" : {
"properties" : {
"roleName" : {
"type" : "string",
"description" : "Role name"
},
"roleId" : {
"type" : "string",
"description" : "Role ID"
},
"adminOption" : {
"type" : "boolean",
"description" : "Admin option",
"nullable" : false
}
},
"description" : "Directly granted roles",
"x-tags" : [ "Model Definitions" ]
},
"UpdateRolePatch" : {
"properties" : {
"roleName" : {
"type" : "string",
"description" : "Role name"
},
"roleDescription" : {
"type" : "string",
"description" : "Role description"
},
"owningRoleId" : {
"type" : "string",
"description" : "Owning role"
},
"directlyGrantedRoles" : {
"type" : "array",
"description" : "Directly granted roles",
"items" : {
"$ref" : "#/components/schemas/UpdateRoleGrantPatch"
}
}
},
"description" : "Update a role",
"x-tags" : [ "Model Definitions" ]
},
"UpdateSchemaPatch" : {
"properties" : {
"description" : {
"type" : "string",
"description" : "Schema description"
},
"contacts" : {
"type" : "array",
"description" : "Schema contacts",
"items" : {
"$ref" : "#/components/schemas/UserAndEmailPatch"
}
},
"links" : {
"type" : "array",
"description" : "Schema links",
"items" : {
"$ref" : "#/components/schemas/LinkPatch"
}
}
},
"description" : "Update schema metadata",
"x-tags" : [ "Model Definitions" ]
},
"UpdateServiceAccountPatch" : {
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Default role ID"
},
"additionalRoleIds" : {
"type" : "array",
"description" : "Additional roles",
"items" : {
"type" : "string",
"description" : "Additional roles"
}
}
},
"description" : "Update a service account",
"x-tags" : [ "Model Definitions" ]
},
"UpdateSqlJob" : {
"required" : [ "queries", "sqlJobId", "syncToken" ],
"properties" : {
"sqlJobId" : {
"type" : "string",
"description" : "ID of a SQL job (read only)"
},
"roleId" : {
"type" : "string",
"description" : "Role used when SQL job is executed"
},
"name" : {
"type" : "string",
"description" : "SQL job name"
},
"description" : {
"type" : "string",
"description" : "SQL job description"
},
"timezone" : {
"type" : "string",
"description" : "Timezone in which CRON is evaluated. Defaults to UTC"
},
"cronExpression" : {
"type" : "string",
"description" : "Cron expression which determines SQL job execution interval"
},
"clusterId" : {
"type" : "string",
"description" : "ID of cluster in which SQL job gets executed"
},
"queries" : {
"type" : "array",
"description" : "SQL queries to execute.",
"items" : {
"type" : "string",
"description" : "SQL queries to execute."
}
},
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
}
},
"description" : "Update sql job",
"x-tags" : [ "Model Definitions" ]
},
"UpdateTablePatch" : {
"properties" : {
"description" : {
"type" : "string",
"description" : "Table description"
},
"contacts" : {
"type" : "array",
"description" : "Table contacts",
"items" : {
"$ref" : "#/components/schemas/UserAndEmailPatch"
}
}
},
"description" : "Update table metadata",
"x-tags" : [ "Model Definitions" ]
},
"UpdateTagPatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Tag name"
},
"color" : {
"type" : "string",
"description" : "Tag color"
},
"description" : {
"type" : "string",
"description" : "comment"
}
},
"description" : "Update a tag",
"x-tags" : [ "Model Definitions" ]
},
"UpdateUsageExamplePatch" : {
"properties" : {
"name" : {
"type" : "string",
"description" : "Usage Example name"
},
"description" : {
"type" : "string",
"description" : "Optional description of the usage example"
},
"code" : {
"type" : "string",
"description" : "SQL code for the usage example"
},
"suggestedPrompt" : {
"type" : "string",
"description" : "Optional suggested natural-language prompt for the usage example"
}
},
"description" : "Update a usage example for a Galaxy Data Product",
"x-tags" : [ "Model Definitions" ]
},
"UpdateUserPatch" : {
"properties" : {
"roleId" : {
"type" : "string",
"description" : "Default role id"
},
"directlyGrantedRoles" : {
"type" : "array",
"description" : "Directly granted roles",
"items" : {
"$ref" : "#/components/schemas/UpdateRoleGrantPatch"
}
}
},
"description" : "Update user role grants and default role",
"x-tags" : [ "Model Definitions" ]
},
"UpdatedJsonIngestColumn" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "A new set of columns for this table (replaces the old one)",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newJsonIngestColumnInSchemaUpdate" : "#/components/schemas/UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate",
"existingJsonIngestColumn" : "#/components/schemas/UpdatedJsonIngestColumnExistingJsonIngestColumn2"
}
},
"x-tags" : [ "Model Definitions" ]
},
"UpdatedJsonIngestColumnExistingJsonIngestColumn" : {
"allOf" : [ {
"$ref" : "#/components/schemas/UpdatedJsonIngestColumn"
}, {
"description" : "An existing column; same ID but other properties may differ",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"UpdatedJsonIngestColumnExistingJsonIngestColumn2" : {
"allOf" : [ {
"$ref" : "#/components/schemas/UpdatedJsonIngestColumn"
}, {
"required" : [ "columnId", "fieldParserConfig", "trinoColumnName", "trinoType" ],
"properties" : {
"columnId" : {
"format" : "int32",
"type" : "integer",
"description" : "ID of the transform column",
"nullable" : false
},
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"required" : [ "typeKey" ],
"properties" : {
"typeKey" : {
"type" : "string"
}
},
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"discriminator" : {
"propertyName" : "typeKey",
"mapping" : {
"newJsonIngestColumnInSchemaUpdate" : "#/components/schemas/UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate2",
"existingJsonIngestColumn" : "#/components/schemas/UpdatedJsonIngestColumnExistingJsonIngestColumn"
}
},
"x-tags" : [ "Model Definitions" ]
}
}
},
"description" : "An existing column; same ID but other properties may differ",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate" : {
"allOf" : [ {
"$ref" : "#/components/schemas/UpdatedJsonIngestColumn"
}, {
"required" : [ "fieldParserConfig", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewJsonIngestColumnInSchemaUpdate"
}
}
},
"description" : "An added column",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"UpdatedJsonIngestColumnNewJsonIngestColumnInSchemaUpdate2" : {
"allOf" : [ {
"$ref" : "#/components/schemas/UpdatedJsonIngestColumn"
}, {
"required" : [ "fieldParserConfig", "nestedColumns", "trinoColumnName", "trinoType" ],
"properties" : {
"trinoColumnName" : {
"type" : "string",
"description" : "Name of the transform column; adheres to Trino conventions"
},
"fieldParserConfig" : {
"required" : [ "pointer" ],
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON pointer (IETF RFC 6901)"
},
"parseParameters" : {
"type" : "object",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for parsing Varchar and time types.\nFor Varchar, the only allowed parameter is \"varchar.type\", with valid values \"scalar\" or \"json\".\nFor Timestamp and TimestampTz, the only allowed parameters are:\n - \"timestamp.converter\", with valid values \"unixtime\" or \"iso8601\".\n - \"timestamp.unit\", with valid values \"nanos\", \"micros\", \"millis\", \"secs\", \"mins\", \"hours\", or \"days\".\n"
}
}
},
"description" : "JSON pointer (and parsing parameters) to the raw-table field transformed into this column value",
"x-tags" : [ "Model Definitions" ]
},
"trinoType" : {
"required" : [ "typeId" ],
"properties" : {
"typeId" : {
"type" : "string",
"description" : "Trino type enum",
"enum" : [ "Boolean", "Integer", "Bigint", "Real", "Double", "Decimal", "Date", "Time", "Timestamp", "TimestampTz", "Varchar", "Uuid", "Varbinary", "Row", "Array", "Map" ]
},
"typeParameters" : {
"type" : "object",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n",
"additionalProperties" : {
"type" : "string",
"description" : "Parameters for completing the type specification.\nTypes Decimal, Time, Timestamp, and TimestampTz require a parameter named `precision`, which is the number of digits.\nType Decimal also requires a parameter named `scale`, which is the number of digits to the right of the decimal point.\n"
}
}
},
"description" : "Column type; adheres to Trino conventions",
"x-tags" : [ "Model Definitions" ]
},
"nestedColumns" : {
"type" : "array",
"description" : "Nested columns for complex types (Row, Map, Array).\nFor primitive types, this list is empty.\nFor the Row type, this contains the fields of the row.\nFor the Map type, this contains the key and value types.\nFor the Array type, this contains the single element type.\n",
"items" : {
"$ref" : "#/components/schemas/NewJsonIngestColumnInSchemaUpdate"
}
}
},
"description" : "An added column",
"x-tags" : [ "Model Definitions" ]
} ],
"x-tags" : [ "Model Definitions" ]
},
"UsageExample" : {
"required" : [ "code", "createdOn", "dataProductId", "modifiedOn", "name", "syncToken", "usageExampleId" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"usageExampleId" : {
"type" : "string",
"description" : "Usage Example ID (read only)"
},
"dataProductId" : {
"type" : "string",
"description" : "ID of the owning Data Product (read only)"
},
"name" : {
"type" : "string",
"description" : "Usage Example name (read only)"
},
"description" : {
"type" : "string",
"description" : "Optional description of the usage example (read only)"
},
"code" : {
"type" : "string",
"description" : "SQL code for the usage example (read only)"
},
"suggestedPrompt" : {
"type" : "string",
"description" : "Optional suggested natural-language prompt for the usage example (read only)"
},
"createdOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation date (read only)"
},
"modifiedOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Modified date (read only)"
}
},
"description" : "A usage example for a Galaxy Data Product",
"x-tags" : [ "Model Definitions" ]
},
"User" : {
"required" : [ "allRoles", "createdOn", "directlyGrantedRoles", "email", "scimManaged", "syncToken", "userId" ],
"properties" : {
"syncToken" : {
"type" : "string",
"description" : "Used to ensure consistency for resource updates. A syncToken that is returned\nfrom the server is valid until the resource is updated when a new syncToken will\nbe generated. Only the latest version of the object is maintained.\n (read only)"
},
"userId" : {
"type" : "string",
"description" : "User ID (read only)"
},
"email" : {
"type" : "string",
"description" : "User email (read only)"
},
"defaultRoleId" : {
"type" : "string",
"description" : "Default role id (read only)"
},
"createdOn" : {
"format" : "date-time",
"type" : "string",
"description" : "Creation date (read only)"
},
"scimManaged" : {
"type" : "boolean",
"description" : "SCIM managed (read only)",
"nullable" : false
},
"directlyGrantedRoles" : {
"type" : "array",
"description" : "Directly granted roles (read only)",
"items" : {
"$ref" : "#/components/schemas/Rolegrant"
}
},
"allRoles" : {
"type" : "array",
"description" : "All directly granted, inherited and group roles (read only)",
"items" : {
"$ref" : "#/components/schemas/Rolegrant"
}
}
},
"description" : "A user",
"x-tags" : [ "Model Definitions" ]
},
"UserAndEmail" : {
"required" : [ "email", "userId" ],
"properties" : {
"userId" : {
"type" : "string",
"description" : "User ID"
},
"email" : {
"type" : "string",
"description" : "User email"
}
},
"description" : "Users directly assigned to this group (read only)",
"x-tags" : [ "Model Definitions" ]
},
"UserAndEmail2" : {
"required" : [ "email", "userId" ],
"properties" : {
"userId" : {
"type" : "string",
"description" : "User ID"
},
"email" : {
"type" : "string",
"description" : "User email"
}
},
"description" : "Created by user. If empty then the user is inactive/deleted. (read only)",
"x-tags" : [ "Model Definitions" ]
},
"UserAndEmailPatch" : {
"properties" : {
"userId" : {
"type" : "string",
"description" : "User ID"
},
"email" : {
"type" : "string",
"description" : "User email"
}
},
"description" : "Catalog contacts",
"x-tags" : [ "Model Definitions" ]
},
"Validate" : {
"required" : [ "errorMessages", "infoMessages", "validationSuccessful", "warningMessages" ],
"properties" : {
"validationSuccessful" : {
"type" : "boolean",
"description" : "Is the catalog readable (read only)",
"nullable" : false
},
"errorMessages" : {
"type" : "array",
"description" : "Errors found in the validation process (read only)",
"items" : {
"type" : "string",
"description" : "Errors found in the validation process (read only)"
}
},
"warningMessages" : {
"type" : "array",
"description" : "Warnings found in the validation process (read only)",
"items" : {
"type" : "string",
"description" : "Warnings found in the validation process (read only)"
}
},
"infoMessages" : {
"type" : "array",
"description" : "Additional information found in the validation process (read only)",
"items" : {
"type" : "string",
"description" : "Additional information found in the validation process (read only)"
}
}
},
"description" : "Results of running validation on a catalog (read only)",
"x-tags" : [ "Model Definitions" ]
},
"Violation" : {
"required" : [ "description", "subject", "type" ],
"properties" : {
"type" : {
"type" : "string",
"description" : "Violation type",
"enum" : [ "TermsOfService" ]
},
"subject" : {
"type" : "string",
"description" : "Violation subject"
},
"description" : {
"type" : "string",
"description" : "Violation description"
}
},
"description" : "Field violations (read only)",
"x-tags" : [ "Responses" ]
}
}
},
"x-tagGroups" : [ {
"name" : "Help",
"tags" : [ "About", "API Versions", "Access Tokens" ]
}, {
"name" : "Services",
"tags" : [ "Cluster Service", "User Service", "Role Service", "Group Service", "Privilege Service", "SchemaDiscovery Service", "Catalog Service", "Discovery Service", "Tag Service", "RowFilter Service", "ServiceAccount Service", "ColumnMask Service", "Policy Service", "DataProduct Service", "DataDomain Service", "Data Product Usage Example Service", "CrossAccountIamRole Service", "Privatelink Service", "Data quality metrics Service", "SqlJobs Service", "LiveTable Service", "KafkaIngestSource Service", "FileIngestSource Service", "Data Quality Service", "Data Quality Schedule Service" ]
}, {
"name" : "Models",
"tags" : [ "Model Definitions", "Responses" ]
} ]
}