[MINOR] docs: supplement missing request path description for set owner API#10736
Merged
roryqi merged 3 commits intoapache:mainfrom Apr 14, 2026
Merged
Conversation
Contributor
Author
|
Hi @roryqi , could you please take a look at this PR when you have a moment? Thanks! |
roryqi
reviewed
Apr 13, 2026
| "name": "${user}", | ||
| "type": "USER" | ||
| }' http://localhost:8090/api/metalakes/test/owners/table/catalog1.schema1.table1 | ||
| }' http://localhost:8090/api/metalakes/${metalake}/owners/table/${metadataObjectName} |
Contributor
There was a problem hiding this comment.
Hi, I think we don't need to modify so many places. We can add above command using variable placeholdsers the example
The request path for REST API is `/api/metalakes/${metalake}/owners/{metadataObjectType}/${metadataObjectName}/`.
roryqi
reviewed
Apr 13, 2026
| - Given different operating privileges based on their assigned roles | ||
| - Made owners of securable objects | ||
|
|
||
| **Examples:** |
Contributor
There was a problem hiding this comment.
Could u remove this example? It makes user confused.
roryqi
reviewed
Apr 13, 2026
| Groups can be granted roles and privileges, but they cannot be owners of securable objects. Only users can be owners. | ||
| ::: | ||
|
|
||
| **Examples:** |
Contributor
There was a problem hiding this comment.
Could u remove the example? This makes user confused.
roryqi
approved these changes
Apr 14, 2026
Contributor
|
@jarredhj0214 Thanks for your contribution! Welcome to join the Gravitino community! Enjoy your open source trip! Let's build the best catalog. |
yuqi1129
pushed a commit
to yuqi1129/gravitino
that referenced
this pull request
Apr 15, 2026
…er API (apache#10736) ### What changes were proposed in this pull request? Replaced hardcoded values (e.g., test, role1) with standard placeholder variables (e.g., ${metalake}, ${role}) in the permission API curl examples within the documentation. ### Why are the changes needed? The existing documentation examples used hardcoded values like test and role1 as path parameters, which could mislead users into thinking these are required or default values rather than user-defined inputs. Using consistent placeholder variables aligns with the documentation style used elsewhere in the project. ### Does this PR introduce _any_ user-facing change? No. This is a documentation-only change. No APIs, property keys, or runtime behaviors are affected. ### How was this patch tested? No code changes were made. The fix is documentation only and was verified by manual review of the updated curl examples. Co-authored-by: jarred0214 <jarredhj@163.com>
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
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?
Replaced hardcoded values (e.g., test, role1) with standard placeholder variables (e.g., ${metalake}, ${role}) in the permission API curl examples within the documentation.
Why are the changes needed?
The existing documentation examples used hardcoded values like test and role1 as path parameters, which could mislead users into thinking these are required or default values rather than user-defined inputs. Using consistent placeholder variables aligns with the documentation style used elsewhere in the project.
Does this PR introduce any user-facing change?
No. This is a documentation-only change. No APIs, property keys, or runtime behaviors are affected.
How was this patch tested?
No code changes were made. The fix is documentation only and was verified by manual review of the updated curl examples.