roryqi opened a new pull request, #11203:
URL: https://github.com/apache/gravitino/pull/11203
### What changes were proposed in this pull request?
Add user-facing documentation and OpenAPI for the hierarchical (multi-level)
schema feature:
- **OpenAPI** (`docs/open-api/schemas.yaml`): add the optional
`parentSchema` query parameter to `listSchemas`, and note that a schema name
may encode a nested path joined by the configured separator.
- **Server config** (`docs/gravitino-server-config.md`): new Schema
configuration subsection documenting `gravitino.schema.separator` (default `:`,
since 1.3.0).
- **Schema management guide**
(`docs/manage-relational-metadata-using-gravitino.md`): new "Hierarchical
schema" subsection with Shell/Java/Python examples for creating nested schemas
and listing children via `parentSchema`.
- **Iceberg docs** (`docs/iceberg-rest-service.md`,
`docs/lakehouse-iceberg-catalog.md`): capability notes linking to the new
section.
### Why are the changes needed?
The hierarchical schema feature (#11118 for Iceberg REST, #11175 for
Gravitino REST) was merged without user-facing documentation ("Will add the
document later"). This PR fills that gap.
Fix: #9970
### Does this PR introduce _any_ user-facing change?
Documentation only. It documents the new `gravitino.schema.separator` server
config and the new `parentSchema` query parameter on `GET .../schemas`.
### How was this patch tested?
`./gradlew :docs:build` passes (the OpenAPI spec validates).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
--
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]
