kbendick commented on a change in pull request #3561: URL: https://github.com/apache/iceberg/pull/3561#discussion_r766342295
########## File path: rest_docs/rest-catalog-open-api-v0.1.yaml ########## @@ -0,0 +1,727 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +--- +openapi: 3.0.3 +info: + title: Apache Iceberg REST Catalog API + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 1.0.0 + description: + Defines the specification for the first version of the REST Catalog API. Implementations should support both Iceberg table specs v1 and v2, with priority given to v2. +servers: + - url: http://127.0.0.1:1080 + description: URL Used for Mock-Server Unit Tests +# All routes are currently configured using an Authorization header. +security: + - BearerAuth: [] +paths: + /v1/config: + get: + tags: + - Configuration API + summary: List all catalog configuration settings + operationId: getConfig + description: + All REST catalogs will be initialized by calling this route. This route + will return at least the minimum necessary metadata to initialize the + catalog. Optionally, it can also include server-side specific overrides. + For example, it might also include information used to initialize this catalog + such as the details of the Http connection pooling, etc. This route might + also advertise information about operations that are not implemented + so that the catalog can eagerly throw or go about another way of performing + the desired action. + responses: + default: + description: Server-Specific Configuration Overrides + content: + application/json: + schema: + $ref: '#/components/schemas/IcebergConfiguration' + "400": + description: Unknown Error + "401": + description: Unauthorized + + /v1/namespaces/{namespace}/tables/{table}: + parameters: + - name: namespace + in: path + description: Namespace the table is in + required: true + schema: + type: string + examples: + singlepart_namespace: + value: "accounting" + multipart_namespace: + value: "accounting.tax" + - name: table + in: path + description: Name of the table to load + required: true + schema: + type: string + example: "sales" + get: + tags: + - Catalog API + summary: Load a given table from a given namespace + operationId: loadTable + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/GetTableResponse' + '401': + description: Unauthorized + # Using 412, `Precondition Failed`, instead of 404, as 404 makes monitoring response codes from ELBs + # very difficult - Hard to tell if clients or servers are misconfigured and calling non-existent routes + # or missing routes versus expected error cases such as NoSuchTableException (expected meaning that + # a person who is on call shouldn't be paged for this but 404 they might need to be). + '412': + description: NoSuchTableException + content: + application/json: + schema: + $ref: '#/components/schemas/NoSuchTableError' + put: + tags: + - Catalog API + summary: Commit an in progress create (or replace) table transaction + operationId: commitTable + description: Commit a pending create (or replace) table transaction, e.g. for doCommit. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommitTableRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommitTableResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/IcebergResponseObject' + delete: + tags: + - Catalog API + summary: Drop a table from the catalog + operationId: dropTable + description: Remove a table from the catalog + parameters: + - name: purgeRequested + in: query + required: false + description: Whether the user requested to purge the underlying table's data and metadata + schema: + type: boolean + default: false + responses: + '200': + description: OK + content: + 'application/json': + schema: + type: boolean + description: true if the table was dropped and false if the table did not exist + head: + tags: + - Catalog API + summary: Check if a table exists + operationId: tableExists + description: + Check if a table exists within a given namespace. Returns the standard response with `true` when found. Will return a TableNotFound error if not present. + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: table + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + '412': + description: Table Not Found + /v1/namespaces/{namespace}/tables: + parameters: + - name: namespace + description: Namespace under which to list tables. + in: path + required: true + schema: + type: string + examples: + singlepart_namespace: + value: "accounting" + multipart_namespace: + value: "accounting.tax" + get: + tags: + - Catalog API + summary: List all table identifiers underneath a given namespace + description: Return all table identifiers under this namespace + operationId: listTables + parameters: + - name: namespace + description: Namespace under which to list tables. + in: path + required: true + schema: + type: string + examples: + singlepart_namespace: + value: "accounting" + multipart_namespace: + value: "accounting.tax" + # TODO - There's a much more native way to handle pagination + - name: limit + description: number of values to return in one request + in: query + required: false + schema: + type: integer + example: 10 + - name: offset + description: Place in the response to continue from if paginating + in: query + required: false + schema: + type: integer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ListTablesResponse' + post: + tags: + - Catalog API + summary: Create a table with the identifier given in the body + operationId: createTable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTableRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTableResponse' + put: + tags: + - Catalog API + summary: Rename a table from its current name to a new name within the same catalog + description: Rename a table within the same catalog + operationId: renameTable + requestBody: + description: Current table identifier to rename and new table identifier to rename to + content: + application/json: + schema: + $ref: '#/components/schemas/RenameTableRequest' + required: true + responses: + '200': + description: OK + '401': + description: Unauthorized + # Not using 404 as 404 is very hard to monitor. + # There's no way to tell by monitoring returned response codes + # if a client made a valid request but the table didn't exist, + # or if a client or server has been misconfigured or some bug exists + # and the client is actually calling endpoints that the server doesn't + # have. + # + # We can consider a different response code to use than 412. + '412': + description: Table to rename from does not exist + content: + application/json: + schema: + $ref: '#/components/schemas/NoSuchTableError' + example: + '{ error: { message: "Table does not exist", type: "NoSuchTableException", code: 41202 }' + '409': + description: The new table identifier, the to table rename to, already exists. + content: + application/json: + schema: + $ref: '#/components/schemas/TableAlreadyExistsError' + example: + '{ error: { message: "Namespace already exists", type: "AlreadyExistsException", code: 40902 }' + /v1/namespaces/{namespace}/properties: + parameters: + - name: namespace + in: path + required: true + schema: + type: string + get: + tags: + - Catalog API + summary: Load the metadata properties for a namespace + operationId: loadNamespaceMetadata + description: Return all stored metadata properties for a given namespace + responses: + '200': + description: OK + content: + application: + schema: + $ref: '#/components/schemas/GetNamespaceResponse' + '417': + description: Namespace not found + content: + application/json: + schema: + $ref: '#/components/schemas/NoSuchNamespaceError' + example: + '{ error: { message: "Namespace does not exist", type: "NoSuchNamespaceException", code: 41701 }' + put: + tags: + - Catalog API + summary: Add or overwrite properties to an existing namespace + operationId: setNamespaceProperties + description: + Adds propertiess for a namespace. This will overwrite any existing properties, + and merge with the others. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemovePropertiesRequest' + required: true + responses: + '200': + description: OK + content: + 'application/json': + schema: + type: boolean + '417': + description: Namespace not found + content: + application/json: + schema: + $ref: '#/components/schemas/NoSuchNamespaceError' + example: + '{ error: { message: "Namespace does not exist", type: "NoSuchNamespaceException", code: 41701 }' + '409': + description: Namespace already exists + content: + applicaton/json: + schema: + $ref: '#/components/schemas/NamespaceAlreadyExistsError' + example: + '{ error: { message: "Namespace already exists", type: "AlreadyExistsException", code: 40901 }' + post: + tags: + - Catalog API + summary: Overwrite a namespace's properties with a new set of properties + description: Set properties on a namespace + operationId: setProperties + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetPropertiesRequest' + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + example: '{ data: { success: true }, error: { } }' + # TODO - Pagination + /v1/namespaces: + parameters: + - name: parent + in: query + description: Optional parent namespace under which to list namespaces. When empty, list top-level namespaces. + required: false + schema: + type: string + get: + tags: + - Catalog API + summary: List namespaces, optionally providing a parent namespace to list underneaath + description: + List all namespaces at a certain level, optionally starting from a given parent namespace. + For example, if table a.b.t exists, using 'SELECT NAMESPACE IN a' this would translate into + `GET /v1/namespaces?parent=a` and must return Namepace.of("a","b"). + operationId: listNamespaces + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ListNamespacesResponse' + '401': + description: Unauthorized + /v1/namespaces/{namespace}: + parameters: + - name: namespace + in: path + required: true + schema: + type: string + post: + tags: + - Catalog API + summary: Create a namespace + description: Create a namespace, with an optional set of properties. The server might also add properties. + operationId: createNamespace + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNamespaceRequest' + required: true + responses: + '200': + description: OK + '401': + description: Unauthorized + delete: + tags: + - Catalog API + summary: Drop a namespace from the catalog. Namespace must be empty. + operationId: dropNamespace + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + # TODO - Not empty exception, No such namespace exception + '401': + description: Unauthorized +components: + schemas: + CommitTableRequest: + type: object + properties: + tableIdentifier: + $ref: '#/components/schemas/TableIdentifier' + metadataJson: + type: string + TableIdentifier: + type: object + required: + - namespace + properties: + namespace: + type: array + items: + type: string + nullable: false # Note this is ignored + name: + pattern: \S Review comment: I believe that’s just any character, including spaces. I’ll look into what form of regex it is. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
