[#9540] docs: add OpenAPI specification for function/UDF operations#9928
Merged
[#9540] docs: add OpenAPI specification for function/UDF operations#9928
Conversation
Add OAS definition for function CRUD operations including: - List functions (with optional details query param) - Register function - Get function - Alter function (with 6 update request subtypes) - Drop function Schemas cover Function, FunctionDefinition, FunctionParam, FunctionColumn, FunctionImpl (SQL/Java/Python), FunctionResources, and all request/response models with examples for both scalar and table function types. Also update AGENTS.md with OpenAPI docs validation command.
jerryshao
approved these changes
Feb 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Add OpenAPI specification (OAS) for function/UDF operations by creating
docs/open-api/functions.yamland updatingdocs/open-api/openapi.yaml.The new OAS covers:
detailsquery param), register (POST), get (GET), alter (PUT), drop (DELETE)Function,FunctionDefinition,FunctionParam,FunctionColumn,FunctionImpl(polymorphic with SQL/Java/Python subtypes vialanguagediscriminator),FunctionResourcesFunctionRegisterRequest,FunctionUpdatesRequest, and 6FunctionUpdateRequestsubtypes (updateComment,addDefinition,removeDefinition,addImpl,updateImpl,removeImpl) using@typediscriminatorFunctionResponse,FunctionListResponseAlso updates
AGENTS.mdto document the./gradlew :docs:buildcommand for OpenAPI validation.Why are the changes needed?
The function/UDF REST API is fully implemented in Java but lacks OpenAPI documentation. This OAS definition is needed for API documentation, client code generation, and API contract validation.
Fix: #9540
Does this PR introduce any user-facing change?
No. This is a documentation-only change adding OpenAPI specification files.
How was this patch tested?
Validated by running
./gradlew :docs:buildwhich includes Redocly CLI linting — passed with no errors.