Skip to content

[MINOR] docs: supplement missing request path description for set owner API#10736

Merged
roryqi merged 3 commits intoapache:mainfrom
jarredhj0214:docs/standardize-placeholders
Apr 14, 2026
Merged

[MINOR] docs: supplement missing request path description for set owner API#10736
roryqi merged 3 commits intoapache:mainfrom
jarredhj0214:docs/standardize-placeholders

Conversation

@jarredhj0214
Copy link
Copy Markdown
Contributor

@jarredhj0214 jarredhj0214 commented Apr 10, 2026

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.

@jarredhj0214
Copy link
Copy Markdown
Contributor Author

Hi @roryqi , could you please take a look at this PR when you have a moment? Thanks!

@jerryshao jerryshao requested a review from roryqi April 13, 2026 02:04
Comment thread docs/security/access-control.md Outdated
"name": "${user}",
"type": "USER"
}' http://localhost:8090/api/metalakes/test/owners/table/catalog1.schema1.table1
}' http://localhost:8090/api/metalakes/${metalake}/owners/table/${metadataObjectName}
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.

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}/`.

Comment thread docs/security/access-control.md Outdated
- Given different operating privileges based on their assigned roles
- Made owners of securable objects

**Examples:**
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.

Could u remove this example? It makes user confused.

Comment thread docs/security/access-control.md Outdated
Groups can be granted roles and privileges, but they cannot be owners of securable objects. Only users can be owners.
:::

**Examples:**
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.

Could u remove the example? This makes user confused.

@jarredhj0214 jarredhj0214 changed the title [MINOR] docs: Standardize variable placeholders in permission API examples [MINOR] docs: supplement missing request path description for set owner API Apr 14, 2026
@roryqi roryqi merged commit b53d673 into apache:main Apr 14, 2026
22 checks passed
@roryqi
Copy link
Copy Markdown
Contributor

roryqi commented Apr 14, 2026

@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>
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.

3 participants