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/22 21:18:35 UTC
[GitHub] [iceberg] jackye1995 commented on a change in pull request #3770: Spec: Initial OpenAPI Spec for a Rest Catalog
jackye1995 commented on a change in pull request #3770:
URL: https://github.com/apache/iceberg/pull/3770#discussion_r774175669
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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.
Review comment:
nit: `last_modified_time`
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
Review comment:
nit: extra empty line
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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
Review comment:
what is `using 'SELECT NAMESPACE IN a'`? If this is not standard SQL sentence I think it's better to not mention it to avoid confusion.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
Review comment:
My understanding is that 409 usually means concurrent conflicts, already exists should be 400 bad request.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /v1/tables/rename:
+ post:
+ tags:
+ - Catalog API
+ summary: Rename a table from its current name to a new name
+ description:
+ Rename a table from one identifier to another. It's valid to move a table
+ across namespaces, but the server implementation is not required to support it.
+ 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:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, Table to rename does not exist
+ - NoSuchNamespaceException, The target namespace of the new table identifier does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceToRenameToDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 409:
+ description: Conflict - The target table identifier to rename to already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example:
+ $ref: '#/components/examples/TableAlreadyExistsError'
+
+components:
+ #######################################################
+ # Common Parameter Definitions Used In Several Routes #
+ #######################################################
+ parameters:
+ namespace:
+ name: namespace
+ in: path
+ required: true
+ description:
+ A namespace identifier as a single string.
+ Multipart namespace parts should be separated by the null byte.
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting%00tax"
+
+ table:
+ name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ ##############################
+ # Application Schema Objects #
+ ##############################
+ schemas:
+
+ StandardErrorWrapper:
+ type: object
+ description: JSON error payload returned in a response with further details on the error
+ required:
+ - message
+ - type
+ - code
+ properties:
+ message:
+ type: string
+ description: Human-readable error message
+ type:
+ type: string
+ description: Internal type definition of the error
+ example: NoSuchNamespaceException
+ code:
+ type: integer
+ minimum: 400
+ maximum: 600
+ description: HTTP response code
+ example: 404
+
+ CatalogConfiguration:
+ type: object
+ description: Server-provided configuration for the catalog.
+ required:
+ - defaults
+ - overrides
+ properties:
+ overrrides:
+ type: object
+ description:
+ Properties that should be used to override client configuration; applied after defaults and client configuration.
+ defaults:
+ type: object
+ description:
+ Properties that should be used as default configuration; applied before client configuration.
+
+ CreateNamespaceRequest:
+ type: object
+ required:
+ - namespace
+ properties:
+ namespace:
+ $ref: '#/components/schemas/Namespace'
+ properties:
+ type: object
+ description: Configured string to string map of properties for the namespace
+ example: '{ "owner": "Hank Bendickson" }'
Review comment:
who's Hank? (just curious)
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /v1/tables/rename:
+ post:
+ tags:
+ - Catalog API
+ summary: Rename a table from its current name to a new name
+ description:
+ Rename a table from one identifier to another. It's valid to move a table
+ across namespaces, but the server implementation is not required to support it.
+ 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:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, Table to rename does not exist
+ - NoSuchNamespaceException, The target namespace of the new table identifier does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceToRenameToDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 409:
+ description: Conflict - The target table identifier to rename to already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example:
+ $ref: '#/components/examples/TableAlreadyExistsError'
+
+components:
+ #######################################################
+ # Common Parameter Definitions Used In Several Routes #
+ #######################################################
+ parameters:
+ namespace:
+ name: namespace
+ in: path
+ required: true
+ description:
+ A namespace identifier as a single string.
+ Multipart namespace parts should be separated by the null byte.
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting%00tax"
+
+ table:
+ name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ ##############################
+ # Application Schema Objects #
+ ##############################
+ schemas:
+
+ StandardErrorWrapper:
+ type: object
+ description: JSON error payload returned in a response with further details on the error
+ required:
+ - message
+ - type
+ - code
+ properties:
+ message:
+ type: string
+ description: Human-readable error message
+ type:
+ type: string
+ description: Internal type definition of the error
+ example: NoSuchNamespaceException
+ code:
+ type: integer
+ minimum: 400
+ maximum: 600
+ description: HTTP response code
+ example: 404
+
+ CatalogConfiguration:
+ type: object
+ description: Server-provided configuration for the catalog.
+ required:
+ - defaults
+ - overrides
+ properties:
+ overrrides:
+ type: object
+ description:
+ Properties that should be used to override client configuration; applied after defaults and client configuration.
+ defaults:
+ type: object
+ description:
+ Properties that should be used as default configuration; applied before client configuration.
+
+ CreateNamespaceRequest:
+ type: object
+ required:
+ - namespace
+ properties:
+ namespace:
+ $ref: '#/components/schemas/Namespace'
+ properties:
+ type: object
+ description: Configured string to string map of properties for the namespace
+ example: '{ "owner": "Hank Bendickson" }'
+ default: '{ }'
+
+ Namespace:
+ description: Reference to one or more levels of a namespace
+ type: array
+ items:
+ type: string
+ example: [ "accounting", "tax" ]
+
+ RenameTableRequest:
+ type: object
+ properties:
+ sourceTableIdentifier:
+ $ref: '#/components/schemas/TableIdentifier'
+ destinationTableIdentifier:
+ $ref: '#/components/schemas/TableIdentifier'
+
+ TableIdentifier:
+ type: object
+ required:
+ - namespace
+ - name
+ properties:
+ namespace:
+ type: array
+ description: Individual levels of the namespace
+ items:
+ type: string
+ name:
+ type: string
+ nullable: false
+
+ UpdateNamespacePropertiesRequest:
+ type: object
+ properties:
+ removals:
+ type: array
+ uniqueItems: true
+ items:
+ type: string
+ example: '[ "department", "access_group" ]'
+ updates:
+ uniqueItems: true
+ type: object
+ items:
+ type: string
+ example: { "owner": "Hank Bendickson" }
+
+
+ #############################
+ # Reusable Response Objects #
+ #############################
+ responses:
+
+ # Note that this is a representative example response for use as a shorthand in the spec.
+ # The fields `message` and `type` as indicated here are not presently prescriptive.
+ UnauthorizedResponse:
+ description: Unauthorized. The client does not have permissions to call this route.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example: {
+ "error": {
+ "message": "Not authorized to make this request",
+ "type": "NotAuthorizedException",
+ "code": 401
+ }
+ }
+
+ # Note that this is a representative example response for use as a shorthand in the spec.
+ # The fields `message` and `type` as indicated here are not presently prescriptive.
+ UnsupportedOperationResponse:
+ description: Not Acceptable / Unsuported Operation. The server does not support this operation.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example: {
+ "error": {
+ "message": "The server does not support this operation",
+ "type": "UnsupportedOperationException",
+ "code": 406
+ }
+ }
+
+ IcebergErrorResponse:
+ description: JSON wrapper for all error responses (non-2xx)
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ error:
+ $ref: '#/components/schemas/StandardErrorWrapper'
+ additionalProperties: false
+ example: {
+ "error": {
+ "message": "The server does not support this operation",
+ "type": "UnsupportedOperationException",
+ "code": 406
+ } }
+
+ DropTableResponse:
+ description: A successful call to drop a table
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ dropped:
+ type: boolean
+ description: true if the table was found and removed from the catalog
+ purged:
+ type: boolean
+ description: whether the underlying data was purged or is being purged
+
+ DropNamespaceResponse:
+ description: A successful call to drop a namespace
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ dropped:
+ description: true if the namespace was dropped
+ type: boolean
+
+ GetNamespaceResponse:
+ description:
+ Returns a namespace, as well as any properties stored on the namespace if namespace properties
+ are supported by the server.
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - namespace
+ properties:
+ namespace:
+ $ref: '#/components/schemas/Namespace'
+ properties:
+ type: object
+ description:
+ Properties stored on the namespace, if supported by the server.
+ If the server does not support namespace properties, it should return null for this field.
+ If namespace properties are supported, but none are set, it should return an empty object.
+ example: { "owner": "Ralph", 'transient_lastDdlTime': '1452120468' }
+ default: { }
+ nullable: true
+
+ ListTablesResponse:
+ description: A list of table identifiers
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ identifiers:
+ type: array
+ uniqueItems: true
+ items:
+ $ref: '#/components/schemas/TableIdentifier'
+
+ ListNamespacesResponse:
+ description: A list of namespaces
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ namespaces:
+ type: array
+ uniqueItems: true
+ items:
+ $ref: '#/components/schemas/Namespace'
+
+ UpdateNamespacePropertiesResponse:
+ description: JSON data response for a synchronous update properties request.
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - updated
Review comment:
I think these should not be required, because you might have only updates or removes.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /v1/tables/rename:
+ post:
+ tags:
+ - Catalog API
+ summary: Rename a table from its current name to a new name
+ description:
+ Rename a table from one identifier to another. It's valid to move a table
+ across namespaces, but the server implementation is not required to support it.
+ 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:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, Table to rename does not exist
+ - NoSuchNamespaceException, The target namespace of the new table identifier does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceToRenameToDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 409:
+ description: Conflict - The target table identifier to rename to already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example:
+ $ref: '#/components/examples/TableAlreadyExistsError'
+
+components:
+ #######################################################
+ # Common Parameter Definitions Used In Several Routes #
+ #######################################################
+ parameters:
+ namespace:
+ name: namespace
+ in: path
+ required: true
+ description:
+ A namespace identifier as a single string.
+ Multipart namespace parts should be separated by the null byte.
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting%00tax"
+
+ table:
+ name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ ##############################
+ # Application Schema Objects #
+ ##############################
+ schemas:
+
+ StandardErrorWrapper:
+ type: object
+ description: JSON error payload returned in a response with further details on the error
+ required:
+ - message
+ - type
+ - code
+ properties:
+ message:
+ type: string
+ description: Human-readable error message
+ type:
+ type: string
+ description: Internal type definition of the error
+ example: NoSuchNamespaceException
+ code:
+ type: integer
+ minimum: 400
+ maximum: 600
+ description: HTTP response code
+ example: 404
+
+ CatalogConfiguration:
+ type: object
+ description: Server-provided configuration for the catalog.
+ required:
+ - defaults
+ - overrides
+ properties:
+ overrrides:
+ type: object
+ description:
+ Properties that should be used to override client configuration; applied after defaults and client configuration.
+ defaults:
+ type: object
+ description:
+ Properties that should be used as default configuration; applied before client configuration.
+
+ CreateNamespaceRequest:
+ type: object
+ required:
+ - namespace
+ properties:
+ namespace:
+ $ref: '#/components/schemas/Namespace'
+ properties:
+ type: object
+ description: Configured string to string map of properties for the namespace
+ example: '{ "owner": "Hank Bendickson" }'
+ default: '{ }'
+
+ Namespace:
+ description: Reference to one or more levels of a namespace
+ type: array
+ items:
+ type: string
+ example: [ "accounting", "tax" ]
+
+ RenameTableRequest:
+ type: object
+ properties:
+ sourceTableIdentifier:
+ $ref: '#/components/schemas/TableIdentifier'
+ destinationTableIdentifier:
+ $ref: '#/components/schemas/TableIdentifier'
+
+ TableIdentifier:
+ type: object
+ required:
+ - namespace
+ - name
+ properties:
+ namespace:
+ type: array
+ description: Individual levels of the namespace
+ items:
+ type: string
+ name:
+ type: string
+ nullable: false
+
+ UpdateNamespacePropertiesRequest:
+ type: object
+ properties:
+ removals:
+ type: array
+ uniqueItems: true
+ items:
+ type: string
+ example: '[ "department", "access_group" ]'
+ updates:
+ uniqueItems: true
+ type: object
+ items:
+ type: string
+ example: { "owner": "Hank Bendickson" }
+
+
+ #############################
+ # Reusable Response Objects #
+ #############################
+ responses:
+
+ # Note that this is a representative example response for use as a shorthand in the spec.
+ # The fields `message` and `type` as indicated here are not presently prescriptive.
+ UnauthorizedResponse:
+ description: Unauthorized. The client does not have permissions to call this route.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example: {
+ "error": {
+ "message": "Not authorized to make this request",
+ "type": "NotAuthorizedException",
+ "code": 401
+ }
+ }
+
+ # Note that this is a representative example response for use as a shorthand in the spec.
+ # The fields `message` and `type` as indicated here are not presently prescriptive.
+ UnsupportedOperationResponse:
+ description: Not Acceptable / Unsuported Operation. The server does not support this operation.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example: {
+ "error": {
+ "message": "The server does not support this operation",
+ "type": "UnsupportedOperationException",
+ "code": 406
+ }
+ }
+
+ IcebergErrorResponse:
Review comment:
if we have this one, why do we need to define the other error responses? My intention is that if we only have a very generic data model defined in open API spec, we don't need to spend effort to keep the error classes in Java and the response here always in sync.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
Review comment:
Maybe I missed the discussion last time, but I still don't understand why we cannot use `PUT /v1/namespaces/{namespace}` for this. I would assume if we have some special properties for namespace in the future, we still want to have the ability to update that anyway.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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
Review comment:
I also think it's better to use more meaningful examples, like `engineering.cs.faculties` instead of `a.b.t`
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /v1/tables/rename:
+ post:
+ tags:
+ - Catalog API
+ summary: Rename a table from its current name to a new name
+ description:
+ Rename a table from one identifier to another. It's valid to move a table
+ across namespaces, but the server implementation is not required to support it.
+ 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:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, Table to rename does not exist
+ - NoSuchNamespaceException, The target namespace of the new table identifier does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceToRenameToDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 409:
+ description: Conflict - The target table identifier to rename to already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example:
+ $ref: '#/components/examples/TableAlreadyExistsError'
+
+components:
+ #######################################################
+ # Common Parameter Definitions Used In Several Routes #
+ #######################################################
+ parameters:
+ namespace:
+ name: namespace
+ in: path
+ required: true
+ description:
+ A namespace identifier as a single string.
+ Multipart namespace parts should be separated by the null byte.
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting%00tax"
+
+ table:
+ name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ ##############################
+ # Application Schema Objects #
+ ##############################
+ schemas:
+
+ StandardErrorWrapper:
+ type: object
+ description: JSON error payload returned in a response with further details on the error
+ required:
+ - message
+ - type
+ - code
+ properties:
+ message:
+ type: string
+ description: Human-readable error message
+ type:
+ type: string
+ description: Internal type definition of the error
+ example: NoSuchNamespaceException
+ code:
+ type: integer
+ minimum: 400
+ maximum: 600
+ description: HTTP response code
+ example: 404
+
+ CatalogConfiguration:
+ type: object
+ description: Server-provided configuration for the catalog.
+ required:
+ - defaults
+ - overrides
+ properties:
+ overrrides:
+ type: object
+ description:
+ Properties that should be used to override client configuration; applied after defaults and client configuration.
+ defaults:
+ type: object
+ description:
+ Properties that should be used as default configuration; applied before client configuration.
+
+ CreateNamespaceRequest:
+ type: object
+ required:
+ - namespace
+ properties:
+ namespace:
+ $ref: '#/components/schemas/Namespace'
+ properties:
+ type: object
+ description: Configured string to string map of properties for the namespace
+ example: '{ "owner": "Hank Bendickson" }'
+ default: '{ }'
+
+ Namespace:
+ description: Reference to one or more levels of a namespace
+ type: array
+ items:
+ type: string
+ example: [ "accounting", "tax" ]
+
+ RenameTableRequest:
+ type: object
+ properties:
+ sourceTableIdentifier:
Review comment:
why not just `source` and `destination`? Identifier is already inferred from the schema definition.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
Review comment:
in that case, I feel it's better to use POST `/v1/tables/head` to express such operation, otherwise I am not sure what is going to happen for an open-api generated client.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /v1/tables/rename:
+ post:
+ tags:
+ - Catalog API
+ summary: Rename a table from its current name to a new name
+ description:
+ Rename a table from one identifier to another. It's valid to move a table
+ across namespaces, but the server implementation is not required to support it.
+ 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:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, Table to rename does not exist
+ - NoSuchNamespaceException, The target namespace of the new table identifier does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceToRenameToDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 409:
+ description: Conflict - The target table identifier to rename to already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example:
+ $ref: '#/components/examples/TableAlreadyExistsError'
+
+components:
+ #######################################################
+ # Common Parameter Definitions Used In Several Routes #
+ #######################################################
+ parameters:
+ namespace:
+ name: namespace
+ in: path
+ required: true
+ description:
+ A namespace identifier as a single string.
+ Multipart namespace parts should be separated by the null byte.
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting%00tax"
+
+ table:
+ name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ ##############################
+ # Application Schema Objects #
+ ##############################
+ schemas:
+
+ StandardErrorWrapper:
+ type: object
+ description: JSON error payload returned in a response with further details on the error
+ required:
+ - message
+ - type
+ - code
+ properties:
+ message:
+ type: string
+ description: Human-readable error message
+ type:
+ type: string
+ description: Internal type definition of the error
+ example: NoSuchNamespaceException
+ code:
+ type: integer
+ minimum: 400
+ maximum: 600
+ description: HTTP response code
+ example: 404
+
+ CatalogConfiguration:
+ type: object
+ description: Server-provided configuration for the catalog.
+ required:
+ - defaults
Review comment:
I don't think they should be required, because the server might return null for one or both of them.
##########
File path: rest_docs/rest-catalog-open-api.yaml
##########
@@ -0,0 +1,849 @@
+#
+# 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: 0.0.1
+ description:
+ Defines the specification for the first version of the REST Catalog API.
+ Implementations should ideally support both Iceberg table specs v1 and v2, with priority given to v2.
+servers:
+ - url: "{scheme}://{host}/{basePath}"
+ description: Server URL when the port can be inferred from the scheme
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+ - url: "{scheme}://{host}:{port}/{basePath}"
+ description: Generic base server URL, with all parts configurable
+ variables:
+ scheme:
+ description: The scheme of the URI, either http or https.
+ default: https
+ host:
+ description: The host address for the specified server
+ default: localhost
+ port:
+ description: The port used when addressing the host
+ default: "443"
+ basePath:
+ description: Optional prefix to be appended to all routes
+ default: ""
+# 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 clients should first call this route to get catalog configuration
+ properties from the server to configure the catalog and its HTTP client.
+ Configuration from the server consists of two sets of key/value pairs.
+
+ - defaults - properties that should be used as default configuration; applied before client configuration
+
+ - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
+
+
+ Catalog configuration is constructed by setting the defaults, then client-
+ provided configuration, and finally overrides. The final property set is then
+ used to configure the catalog.
+
+
+ For example, a default configuration property might set the size of the
+ client pool, which can be replaced with a client-specific setting. An
+ override might be used to set the warehouse location, which is stored
+ on the server rather than in client configuration.
+
+
+ Common catalog configuration settings are documented at
+ https://iceberg.apache.org/configuration/#catalog-properties
+ "
+ responses:
+ 200:
+ description: Server specified configuration values.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CatalogConfiguration'
+ example: {
+ "data": {
+ "overrides": {
+ "warehouse": "s3://bucket/warehouse/"
+ },
+ "defaults": {
+ "clients": "4"
+ }
+ }
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+
+ /v1/namespaces:
+ get:
+ tags:
+ - Catalog API
+ summary: List namespaces, optionally providing a parent namespace to list underneath
+ 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 a namespace, ["a", "b"]. If `parent` is not
+ provided, all top-level namespaces should be listed.
+ operationId: listNamespaces
+ parameters:
+ - name: parent
+ in: query
+ description:
+ An optional namespace, underneath which to list namespaces.
+ If not provided or empty, all top-level namespaces should be listed.
+ If parent is a multipart namespace, the parts must be separated by the null byte.
+ required: false
+ allowEmptyValue: true
+ schema:
+ type: string
+ example: "accounting%00tax"
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/ListNamespacesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListNamespacesNonEmptyExample'
+ EmptyResponse:
+ $ref: '#/components/examples/ListNamespacesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace provided in the `parent` query parameter is not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ 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'
+ responses:
+ 200:
+ description: OK
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 409:
+ description: Conflict - The namespace already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceAlreadyExists:
+ $ref: '#/components/examples/NamespaceAlreadyExistsError'
+
+ /v1/namespaces/{namespace}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/GetNamespaceResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a namespace exists
+ operationId: namespaceExists
+ description:
+ Check if a namespace exists.
+ This operation does not presently return a response body, which is why the response codes have only
+ a description field.
+ responses:
+ 200:
+ description: Namespace 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/DropNamespaceResponse'
+ example: { "dropped": true }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace to delete does not exist.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NoSuchNamespaceExample:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/properties:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: Set or remove properties on a namespace
+ operationId: updateProperties
+ description:
+ Set and/or remove properties on a namespace.
+ 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/UpdateNamespacePropertiesRequest'
+ examples:
+ UpdateAndRemoveProperties:
+ $ref: '#/components/examples/UpdateAndRemoveNamespacePropertiesRequest'
+ responses:
+ 200:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/UpdateNamespacePropertiesResponse'
+ example: {
+ "updated": [ "owner" ],
+ "removed": [ "foo" ],
+ "missing": [ "bar" ]
+ }
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - Namespace not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 422:
+ description: Unprocessable Entity - A property key was included in both `removals` and `updates`
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ UnprocessableEntityDuplicateKey:
+ $ref: '#/components/examples/UnprocessableEntityDuplicateKey'
+
+ /v1/namespaces/{namespace}/tables:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ 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/responses/ListTablesResponse'
+ examples:
+ NonEmptyResponse:
+ $ref: '#/components/examples/ListTablesNonEmptyExample'
+ EmptyNamespaceResponse:
+ $ref: '#/components/examples/ListTablesEmptyExample'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+
+ /v1/namespaces/{namespace}/tables/{table}:
+ parameters:
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/table'
+ 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/responses/DropTableResponse'
+ example: { "dropped": true, "purged": false }
+ 202:
+ description: Accepted - for use if purgeRequested is implemented as an asynchronous action.
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found - NoSuchTableException, Table to drop does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ head:
+ tags:
+ - Catalog API
+ summary: Check if a table exists
+ operationId: tableExists
+ description:
+ Check if a table exists within a given namespace. This request does not return a response body.
+ responses:
+ 200:
+ description: OK - Table Exists
+ 401:
+ description: Unauthorized
+ 404:
+ description: Not Found
+
+ /v1/tables/rename:
+ post:
+ tags:
+ - Catalog API
+ summary: Rename a table from its current name to a new name
+ description:
+ Rename a table from one identifier to another. It's valid to move a table
+ across namespaces, but the server implementation is not required to support it.
+ 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:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 404:
+ description:
+ Not Found
+ - NoSuchTableException, Table to rename does not exist
+ - NoSuchNamespaceException, The target namespace of the new table identifier does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ examples:
+ TableToRenameDoesNotExist:
+ $ref: '#/components/examples/NoSuchTableError'
+ NamespaceToRenameToDoesNotExist:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 406:
+ $ref: '#/components/responses/UnsupportedOperationResponse'
+ 409:
+ description: Conflict - The target table identifier to rename to already exists
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/responses/IcebergErrorResponse'
+ example:
+ $ref: '#/components/examples/TableAlreadyExistsError'
+
+components:
+ #######################################################
+ # Common Parameter Definitions Used In Several Routes #
+ #######################################################
+ parameters:
+ namespace:
+ name: namespace
+ in: path
+ required: true
+ description:
+ A namespace identifier as a single string.
+ Multipart namespace parts should be separated by the null byte.
+ schema:
+ type: string
+ examples:
+ singlepart_namespace:
+ value: "accounting"
+ multipart_namespace:
+ value: "accounting%00tax"
+
+ table:
+ name: table
+ in: path
+ description: A table name
+ required: true
+ schema:
+ type: string
+ example: "sales"
+
+ ##############################
+ # Application Schema Objects #
+ ##############################
+ schemas:
+
+ StandardErrorWrapper:
+ type: object
+ description: JSON error payload returned in a response with further details on the error
+ required:
+ - message
+ - type
+ - code
+ properties:
+ message:
+ type: string
+ description: Human-readable error message
+ type:
+ type: string
+ description: Internal type definition of the error
+ example: NoSuchNamespaceException
+ code:
+ type: integer
+ minimum: 400
+ maximum: 600
+ description: HTTP response code
+ example: 404
+
+ CatalogConfiguration:
+ type: object
+ description: Server-provided configuration for the catalog.
+ required:
+ - defaults
Review comment:
Also, why is this named differently from the other responses that are of format `XxxxResponse`
--
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