You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by GitBox <gi...@apache.org> on 2021/12/08 09:28:03 UTC
[GitHub] [iceberg] omarsmak commented on a change in pull request #3561: [CORE] Specification for an HTTP REST catalog
omarsmak commented on a change in pull request #3561:
URL: https://github.com/apache/iceberg/pull/3561#discussion_r764661610
##########
File path: rest_docs/rest-catalog-open-api-v0.1.yaml
##########
@@ -0,0 +1,657 @@
+#
+# 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: https://{host}:{port}/{basePath}
+ variables:
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ default: v1
+ - url: http://127.0.0.1:1080/v1
+ description: URL Used for Mock-Server Unit Tests
+# All routes are currently configured using an Authorization header.
+security:
+ - BearerAuth: []
+paths:
+ /config:
+ get:
+ tags:
+ - Configuration API
+ summary: List all catalog configuration settings
+ operationId: getConfig
+ description: >
+ All REST catalog clients will first call this route to get possible catalog-specific
+ configuration values provided by the server, that the catalog (and its HTTP client)
+ can use to complete the `initialize` step.
+
+ This call is similar to the initial set-up calls that some catalogs already do for
+ domain-specific information, such as the Nessie catalog or the Glue catalog.
+ This is to allow for services that would like to integrate with Iceberg to do so,
+ and to be able to add their own domain-specific information into the REST catalog without
+ requiring them to write and distribute a catalog themselves.
+
+ There will be two sets of values provided -
+
+ - overrides
+ * An object containing values that the client must use.
+ For example, auth headers that the client will receive from the server
+ as temporary credentials.
+ - defaults
+ * Catalog-specific configuration that the client may use as a default value.
+ These are optional and the client is free to use its own value for these.
+
+ responses:
+ default:
+ description: Server-Specific Configuration Values (or Overrides)
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IcebergConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "prefix": "/raul",
+ "headers": {
+ "User-Agent": "Raul",
+ "Authorization": "Basic Ym9zY236Ym9zY28=",
+ }
+ },
+ "defaults": {
+ "clients": 5,
+ "headers": {
+ "Upgrade-Insecure-Requests": "1"
+ }
+ }
+ }
+ }
+ "400":
+ description: Unknown Error
+ "401":
+ description: Unauthorized
+ /namespaces:
+ 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 /namespaces?parent=a` and must return Namepace.of("a","b").
+ operationId: listNamespaces
+ 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
+ example: ?parent=accounting.tax
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListNamespacesResponse'
+ '401':
+ description: Unauthorized
+ '404':
+ description: Not Found (Parent namespace does not exist)
+ post:
+ tags:
+ - Catalog API
+ summary: Create a namespace
+ description: Create a namespace, with an optional set of properties. The server might also add properties, such as last_modified_time etc.
+ operationId: createNamespace
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateNamespaceRequest'
+ required: true
+ responses:
+ '200':
Review comment:
Shouldn't this be [`201`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) instead?
##########
File path: rest_docs/rest-catalog-open-api-v0.1.yaml
##########
@@ -0,0 +1,657 @@
+#
+# 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: https://{host}:{port}/{basePath}
+ variables:
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ default: v1
+ - url: http://127.0.0.1:1080/v1
+ description: URL Used for Mock-Server Unit Tests
+# All routes are currently configured using an Authorization header.
+security:
+ - BearerAuth: []
+paths:
+ /config:
+ get:
+ tags:
+ - Configuration API
+ summary: List all catalog configuration settings
+ operationId: getConfig
+ description: >
+ All REST catalog clients will first call this route to get possible catalog-specific
+ configuration values provided by the server, that the catalog (and its HTTP client)
+ can use to complete the `initialize` step.
+
+ This call is similar to the initial set-up calls that some catalogs already do for
+ domain-specific information, such as the Nessie catalog or the Glue catalog.
+ This is to allow for services that would like to integrate with Iceberg to do so,
+ and to be able to add their own domain-specific information into the REST catalog without
+ requiring them to write and distribute a catalog themselves.
+
+ There will be two sets of values provided -
+
+ - overrides
+ * An object containing values that the client must use.
+ For example, auth headers that the client will receive from the server
+ as temporary credentials.
+ - defaults
+ * Catalog-specific configuration that the client may use as a default value.
+ These are optional and the client is free to use its own value for these.
+
+ responses:
+ default:
+ description: Server-Specific Configuration Values (or Overrides)
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IcebergConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "prefix": "/raul",
+ "headers": {
+ "User-Agent": "Raul",
+ "Authorization": "Basic Ym9zY236Ym9zY28=",
+ }
+ },
+ "defaults": {
+ "clients": 5,
+ "headers": {
+ "Upgrade-Insecure-Requests": "1"
+ }
+ }
+ }
+ }
+ "400":
+ description: Unknown Error
+ "401":
+ description: Unauthorized
+ /namespaces:
+ 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 /namespaces?parent=a` and must return Namepace.of("a","b").
+ operationId: listNamespaces
+ 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
+ example: ?parent=accounting.tax
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListNamespacesResponse'
+ '401':
+ description: Unauthorized
+ '404':
+ description: Not Found (Parent namespace does not exist)
+ post:
+ tags:
+ - Catalog API
+ summary: Create a namespace
+ description: Create a namespace, with an optional set of properties. The server might also add properties, such as last_modified_time etc.
+ operationId: createNamespace
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateNamespaceRequest'
+ required: true
+ responses:
+ '200':
+ description: OK
+ '401':
+ description: Unauthorized
+ '409':
+ $ref: '#/components/responses/NamespaceAlreadyExistsResponse'
+
+ /namespaces/{namespace}:
+ 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/json:
+ schema:
+ $ref: '#/components/schemas/GetNamespaceResponse'
+ '404':
+ $ref: '#/components/responses/NoSuchNamespaceResponse'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description: Check if a namespace exists.
+ responses:
+ '200':
+ description: OK - Namesapce exists
+ '401':
+ description: Unauthorized
+ '404':
+ description: Not Found
+ 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:
+ $ref: '#/components/responses/IcebergResponseObject'
+ example: { "data": { "dropped": true } }
+ '401':
+ description: Unauthorized
+ '404':
+ description: Not Found
+
+
+ /namespaces/{namespace}/properties:
+ parameters:
+ - name: namespace
+ in: path
+ required: true
+ schema:
+ type: string
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: setProperties / removeProperties
+ description:
+ Set and/or remove a collection or properties on a namespae.
+ The request body specifies a list of properties to remove and a map
+ of key value pairs to update.
+
+ Properties that are not in the request are not modified or removed by this call.
+ Server implementations are not required to support namespace properties.
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdatePropertiesRequest'
+ example:
+ { "toRemove": [ "foo", "bar" ], "toUpdate": { "owner": "Raoul" } }
+ required: true
+ responses:
+ 200:
+ description: OK
+ content:
+ 'application/json':
+ schema:
+ # This is an IcebergResponseObject<SetPropertiesResponse>, in that it uses the standard wrapper of { "data": toJson(SetPropertiesResponse) }
+ $ref: '#/components/schemas/UpdatePropertiesResponse'
+ example: {
+ "data": {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "notPresent": [ "bar" ]
+ }
+ }
+ 404:
+ description: Not Found (NoSuchNamespaceException)
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergResponseObject'
+ example:
+ { "error": { "message": "Namespace does not exist", "type": "NoSuchNamespaceException", "code": 404 } }
+ 406:
+ description: Not Acceptable (Unsupported Operation)
+ 422:
+ description: Unprocessable Entity. A property key was included in both toRemove and toUpdate.
+
+ /namespaces/{namespace}/tables:
+ parameters:
+ - name: namespace
+ description: A namespace identifier 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
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListTablesResponse'
+ '404':
+ description: Not Found (NoSuchNamespaceException)
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergResponseObject'
+ example:
+ '{ error: { message: "Namespace does not exist", type: "NoSuchNamespaceException", code: 404 }'
+
+ /namespaces/{namespace}/tables/{table}:
+ parameters:
+ - name: namespace
+ in: path
+ description: A namespace identifier
+ required: true
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting.tax"
+ - name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ 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:
+ $ref: '#/components/schemas/DropTableResponse'
+ example: { "data": { "dropped": true, "purged": false } }
+ 202:
+ # TODO - Add a callback or handle to check on the state of an async purge request
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 404:
+ $ref: '#/components/responses/NoSuchTableResponse'
+
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /tables/rename:
Review comment:
I am concern here to mix to functionalities into one method. Why don't we just separate these two functionalities and move under the table endpoint? E.g:
`PUT /namespaces/{namespace}/tables/{table}/rename`
`PUT /namespaces/{namespace}/tables/{table}/move`
--
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-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org