Skip to content

[#9535] docs(function-privilege): document function privileges#10820

Open
mchades wants to merge 2 commits intoapache:mainfrom
mchades:issue-9535-docs
Open

[#9535] docs(function-privilege): document function privileges#10820
mchades wants to merge 2 commits intoapache:mainfrom
mchades:issue-9535-docs

Conversation

@mchades
Copy link
Copy Markdown
Contributor

@mchades mchades commented Apr 20, 2026

What changes were proposed in this pull request?

Update the authorization documentation to cover the three new function privileges
introduced in #10811.

Changes:

  • docs/security/access-control.md — add a Function privileges section with a privilege table (REGISTER_FUNCTION, EXECUTE_FUNCTION, MODIFY_FUNCTION) and corresponding rows in the operation-to-privilege reference table
  • docs/open-api/roles.yaml — add REGISTER_FUNCTION, EXECUTE_FUNCTION, MODIFY_FUNCTION to the Privilege.name enum and FUNCTION to the SecurableObject.type enum (both in the schema and the path-parameter enum)

Why are the changes needed?

The new function privileges are unusable without documentation.
Users and integrators need to know which privilege grants which operation and at which securable-object level.

Fix: #9535

Does this PR introduce any user-facing change?

Documentation only — no code changes.

How was this patch tested?

./gradlew :docs:build — OpenAPI specification validation passes.

Add REGISTER_FUNCTION/EXECUTE_FUNCTION/MODIFY_FUNCTION and FUNCTION
metadata object entries to the access-control reference and the
OpenAPI roles schema.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mchades mchades requested a review from roryqi April 20, 2026 10:39
@mchades mchades changed the title [#9535] docs: document function privileges [#9535] docs(function-privilege): document function privileges Apr 20, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

Code Coverage Report

Overall Project 65.16% 🟢
Files changed No Java source files changed -

Module Coverage
aliyun 1.73% 🔴
api 47.09% 🟢
authorization-common 85.96% 🟢
aws 1.1% 🔴
azure 2.6% 🔴
catalog-common 10.2% 🔴
catalog-fileset 80.02% 🟢
catalog-glue 75.36% 🟢
catalog-hive 81.83% 🟢
catalog-jdbc-clickhouse 79.06% 🟢
catalog-jdbc-common 43.93% 🟢
catalog-jdbc-doris 80.28% 🟢
catalog-jdbc-hologres 54.03% 🟢
catalog-jdbc-mysql 79.23% 🟢
catalog-jdbc-oceanbase 78.38% 🟢
catalog-jdbc-postgresql 82.05% 🟢
catalog-jdbc-starrocks 78.27% 🟢
catalog-kafka 77.01% 🟢
catalog-lakehouse-generic 45.07% 🟢
catalog-lakehouse-hudi 79.1% 🟢
catalog-lakehouse-iceberg 87.16% 🟢
catalog-lakehouse-paimon 77.71% 🟢
catalog-model 77.72% 🟢
cli 44.51% 🟢
client-java 77.63% 🟢
common 48.97% 🟢
core 81.41% 🟢
filesystem-hadoop3 76.97% 🟢
flink 40.55% 🟢
flink-runtime 0.0% 🔴
gcp 14.2% 🔴
hadoop-common 10.39% 🔴
hive-metastore-common 46.14% 🟢
iceberg-common 50.73% 🟢
iceberg-rest-server 66.03% 🟢
integration-test-common 0.0% 🔴
jobs 66.17% 🟢
lance-common 23.88% 🔴
lance-rest-server 57.84% 🟢
lineage 53.02% 🟢
optimizer 82.87% 🟢
optimizer-api 21.95% 🔴
server 85.75% 🟢
server-common 69.52% 🟢
spark 32.79% 🔴
spark-common 39.09% 🔴
trino-connector 33.83% 🔴

| CREATE_MODEL | Metalake, Catalog, Schema | Register a model, this is deprecated. Please use `REGISTER_MODEL` instead. |
| CREATE_MODEL_VERSION | Metalake, Catalog, Schema, Model | Link a model version, this is deprecated. Please use `LINK_MODEL_VERSION` instead. |

### Function privileges
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should include function in Supported Objects:.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

…object descriptions

- Add Function to Supported Objects (ownership) table
- Add Function and Model to Metadata Objects description text
- Add Function and Model to securable objects hierarchy diagram
- Add Function to MANAGE_GRANTS supported securable objects

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mchades mchades requested a review from roryqi April 20, 2026 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Subtask] Function privilege support

2 participants