stevenzwu commented on code in PR #15180:
URL: https://github.com/apache/iceberg/pull/15180#discussion_r3030005492
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -4184,6 +4299,278 @@ components:
items:
$ref: '#/components/schemas/Namespace'
+ LoadFunctionResult:
+ description: |
+ Result returned when a function is loaded from the catalog.
+
+
+ The function metadata JSON is returned in the `metadata` field. The
location of the metadata
+ file is returned in the `metadata-location` field, if available.
+ type: object
+ required:
+ - metadata
+ properties:
+ metadata-location:
+ type: string
+ metadata:
+ $ref: '#/components/schemas/FunctionMetadata'
+
+ FunctionMetadata:
+ description: |
+ Portable UDF metadata format.
+
+
+ Each function is represented by a self-contained metadata file. The
`format-version` field
+ identifies the UDF metadata format.
+ type: object
+ required:
+ - function-uuid
+ - format-version
+ - definitions
+ - definition-log
+ properties:
+ function-uuid:
+ type: string
+ format: uuid
+ description: A UUID that identifies this UDF, generated once at
creation.
+ format-version:
+ type: integer
+ description: UDF specification format version (must be 1).
+ enum: [1]
+ definitions:
+ type: array
+ description: List of function definition entities.
+ items:
+ $ref: '#/components/schemas/FunctionDefinition'
+ definition-log:
+ type: array
+ description: History of versions within the function's definitions.
+ items:
+ $ref: '#/components/schemas/FunctionDefinitionLogEntry'
+ location:
+ type: string
+ description: The function's base location; used to create metadata
file locations.
Review Comment:
nit: `used to create metadata file locations.` doesn't read quite right.
maybe?
```
The function's base location. This is used to store function metadata files.
```
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -4184,6 +4299,278 @@ components:
items:
$ref: '#/components/schemas/Namespace'
+ LoadFunctionResult:
+ description: |
+ Result returned when a function is loaded from the catalog.
+
+
+ The function metadata JSON is returned in the `metadata` field. The
location of the metadata
+ file is returned in the `metadata-location` field, if available.
+ type: object
+ required:
+ - metadata
+ properties:
+ metadata-location:
+ type: string
+ metadata:
+ $ref: '#/components/schemas/FunctionMetadata'
+
+ FunctionMetadata:
+ description: |
+ Portable UDF metadata format.
+
+
+ Each function is represented by a self-contained metadata file. The
`format-version` field
+ identifies the UDF metadata format.
+ type: object
+ required:
+ - function-uuid
+ - format-version
+ - definitions
+ - definition-log
+ properties:
+ function-uuid:
+ type: string
+ format: uuid
+ description: A UUID that identifies this UDF, generated once at
creation.
+ format-version:
+ type: integer
+ description: UDF specification format version (must be 1).
+ enum: [1]
+ definitions:
+ type: array
+ description: List of function definition entities.
+ items:
+ $ref: '#/components/schemas/FunctionDefinition'
+ definition-log:
+ type: array
+ description: History of versions within the function's definitions.
+ items:
+ $ref: '#/components/schemas/FunctionDefinitionLogEntry'
+ location:
+ type: string
+ description: The function's base location; used to create metadata
file locations.
+ properties:
+ type: object
+ description: A string-to-string map of properties.
+ additionalProperties:
+ type: string
+ secure:
+ type: boolean
+ description: Whether it is a secure function.
+ default: false
+ doc:
+ type: string
+ description: Documentation string.
+
+ FunctionDefinition:
+ type: object
+ required:
+ - definition-id
+ - parameters
+ - return-type
+ - versions
+ - current-version-id
+ - function-type
+ properties:
+ definition-id:
+ type: string
+ description: A canonical string derived from the parameter types,
formatted as a comma-separated list with no spaces.
+ parameters:
+ type: array
+ description: Ordered list of function parameters. Invocation order
must match this list.
+ items:
+ $ref: '#/components/schemas/FunctionParameter'
+ return-type:
+ $ref: '#/components/schemas/FunctionDataType'
+ return-nullable:
+ type: boolean
+ description: A hint to indicate whether the return value is nullable
or not.
+ default: true
+ versions:
+ type: array
+ description: Versioned implementations of this definition.
+ items:
+ $ref: '#/components/schemas/FunctionDefinitionVersion'
+ current-version-id:
+ type: integer
+ description: Identifier of the current version for this definition.
+ function-type:
+ type: string
+ description: Function type.
+ enum: ["udf", "udtf"]
+ doc:
+ type: string
+ description: Documentation string.
+
+ FunctionParameter:
+ type: object
+ required:
+ - type
+ - name
+ properties:
+ type:
+ $ref: '#/components/schemas/FunctionDataType'
+ name:
+ type: string
+ doc:
+ type: string
+ description: Parameter documentation.
+
+ FunctionDataType:
+ description: >
+ A UDF data type, encoded either as a type string or as a JSON object
for nested types
Review Comment:
maybe first explain its purpose. sth like
```
A type for function parameters or return value. It is encoded ...
```
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -613,6 +613,89 @@ paths:
5XX:
$ref: '#/components/responses/ServerErrorResponse'
+ /v1/{prefix}/namespaces/{namespace}/functions:
+ parameters:
+ - $ref: '#/components/parameters/prefix'
+ - $ref: '#/components/parameters/namespace'
+
+ get:
+ tags:
+ - Catalog API
+ summary: List all functions underneath a given namespace
+ description: Return all function identifiers under this namespace
+ operationId: listFunctions
+ parameters:
+ - $ref: '#/components/parameters/page-token'
+ - $ref: '#/components/parameters/page-size'
+ responses:
+ 200:
+ $ref: '#/components/responses/ListFunctionsResponse'
+ 400:
+ $ref: '#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref: '#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref: '#/components/responses/ForbiddenResponse'
+ 404:
+ description: Not Found - The namespace specified does not exist
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IcebergErrorResponse'
+ examples:
+ NamespaceNotFound:
+ $ref: '#/components/examples/NoSuchNamespaceError'
+ 419:
+ $ref: '#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref: '#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref: '#/components/responses/ServerErrorResponse'
+
+ /v1/{prefix}/namespaces/{namespace}/functions/{function}:
+ parameters:
+ - $ref: '#/components/parameters/prefix'
+ - $ref: '#/components/parameters/namespace'
+ - $ref: '#/components/parameters/function'
+
+ get:
+ tags:
+ - Catalog API
+ summary: Load a function from the catalog
+ description:
+ Load a function from the catalog.
+
+ The response contains the function's full UDF metadata JSON, matching
the function metadata JSON file.
Review Comment:
nit: maybe simplify
```
The response contains the function's full UDF metadata JSON, matching the
function metadata JSON file.
-->
The response contains function metadata.
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
