This is an automated email from the ASF dual-hosted git repository.
jerryshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 6f5c640f0a [#13634] Fix incorrect privilege scopes, Kafka property
name and CLI link in docs (#13635)
6f5c640f0a is described below
commit 6f5c640f0a846e7de15c7f6b7062cfeca3638314
Author: Bharath Krishna <[email protected]>
AuthorDate: Wed Sep 30 17:04:21 2026 -0700
[#13634] Fix incorrect privilege scopes, Kafka property name and CLI link
in docs (#13635)
### What changes were proposed in this pull request?
Eight corrections:
- **Privilege scopes** — `CREATE_TOPIC`, `CREATE_FILESET` and
`REGISTER_FUNCTION` were listed as grantable on the object they create.
`docs/security/access-control.md` limits all three to Metalake, Catalog
and Schema, which is how `tables-and-views.md` already documents
`CREATE_TABLE` and `CREATE_VIEW`.
- **Kafka property** — the broker config is `num.partitions`, not
`num.partition`. Corrected in `topics.md`, `kafka-catalog.md`, and the
`PARTITION_COUNT` property description in
`KafkaTopicPropertiesMetadata`, which carried the same typo.
- **Spark UDFs** — `functions.md` said a definition can carry "a Python
version for Spark", but `spark-connector-udf.md` states only Java
implementations with `RuntimeType.SPARK` can be invoked.
- **Broken link** — the CLI Reference entry in
`optimizer-extension-guide.md` pointed at the configuration page.
### Why are the changes needed?
Part of #13634
Each one leads a reader to something that does not work: a grant the
server rejects, a Kafka property that does not exist, a Spark UDF
language that cannot be invoked, and a link to the wrong page.
### Does this PR introduce any user-facing change?
No behaviour change. The Kafka `partition-count` property description is
user-visible through the API and is corrected.
### How was this patch tested?
No tests. Each correction was checked against an authoritative source:
- privilege scopes against `docs/security/access-control.md`
- the Spark claim against `docs/spark-connector/spark-connector-udf.md`
- `num.partitions` against Kafka's own
`ServerLogConfigs.NUM_PARTITIONS_CONFIG`
- the link target exists at `optimizer-cli-reference.md`
A repository-wide grep confirms no remaining `num.partition` and no
other `CREATE_*`/`REGISTER_*` row listing the leaf object.
---
.../apache/gravitino/catalog/kafka/KafkaTopicPropertiesMetadata.java | 2 +-
docs/filesets.md | 2 +-
docs/functions.md | 4 ++--
docs/kafka-catalog.md | 2 +-
docs/table-maintenance-service/optimizer-extension-guide.md | 2 +-
docs/topics.md | 4 ++--
6 files changed, 8 insertions(+), 8 deletions(-)
diff --git
a/catalogs/catalog-kafka/src/main/java/org/apache/gravitino/catalog/kafka/KafkaTopicPropertiesMetadata.java
b/catalogs/catalog-kafka/src/main/java/org/apache/gravitino/catalog/kafka/KafkaTopicPropertiesMetadata.java
index 773b670037..f74df52a7f 100644
---
a/catalogs/catalog-kafka/src/main/java/org/apache/gravitino/catalog/kafka/KafkaTopicPropertiesMetadata.java
+++
b/catalogs/catalog-kafka/src/main/java/org/apache/gravitino/catalog/kafka/KafkaTopicPropertiesMetadata.java
@@ -37,7 +37,7 @@ public class KafkaTopicPropertiesMetadata extends
BasePropertiesMetadata {
PropertyEntry.integerOptionalPropertyEntry(
PARTITION_COUNT,
"The number of partitions for the topic, if not specified, "
- + "will use the num.partition property in the broker",
+ + "will use the num.partitions property in the broker",
false /* immutable */,
null /* default value */,
false /* hidden */),
diff --git a/docs/filesets.md b/docs/filesets.md
index 3b2d92eb5e..8dd046f5dc 100644
--- a/docs/filesets.md
+++ b/docs/filesets.md
@@ -98,7 +98,7 @@ today. Attaching a tag to a fileset goes through the API.
| Privilege | Grantable on | What it allows
|
|------------------|---------------------------------------|-----------------------------|
-| `CREATE_FILESET` | Metalake, catalog, schema, or fileset | Creating filesets
|
+| `CREATE_FILESET` | Metalake, catalog, or schema | Creating filesets
|
| `READ_FILESET` | Metalake, catalog, schema, or fileset | Reading a
fileset's files |
| `WRITE_FILESET` | Metalake, catalog, schema, or fileset | Writing a
fileset's files |
diff --git a/docs/functions.md b/docs/functions.md
index e3c8fe383a..483563fc6a 100644
--- a/docs/functions.md
+++ b/docs/functions.md
@@ -55,7 +55,7 @@ definitions is the same name accepting different arguments,
the way `round(x)` a
are one function in most engines.
An implementation is how a definition is expressed for a given engine. Each
declares a language and
-a runtime, so one definition can carry a SQL version for Trino and a Python
version for Spark, and
+a runtime, so one definition can carry a SQL version for Trino and a Java
version for Spark, and
each engine uses the one it can execute.
| Language | Carries |
@@ -79,7 +79,7 @@ all go through the API, as does attaching a tag, which the
function page does no
| Privilege | Grantable on | What it
allows |
|---------------------|----------------------------------------|-----------------------------------|
-| `REGISTER_FUNCTION` | Metalake, catalog, schema, or function | Registering
functions |
+| `REGISTER_FUNCTION` | Metalake, catalog, or schema | Registering
functions |
| `EXECUTE_FUNCTION` | Metalake, catalog, schema, or function | Calling a
function from an engine |
| `MODIFY_FUNCTION` | Metalake, catalog, schema, or function | Altering a
registered function |
diff --git a/docs/kafka-catalog.md b/docs/kafka-catalog.md
index 103aced176..0504b49aa1 100644
--- a/docs/kafka-catalog.md
+++ b/docs/kafka-catalog.md
@@ -59,7 +59,7 @@ workaround.
| Property name | Description | Default
value |
Required |
|----------------------|------------------------------------------|-------------------------------------------------------------------------------------|----------|
-| `partition-count` | The number of partitions for the topic. | if not
specified, will use the `num.partition` property in the broker. |
No |
+| `partition-count` | The number of partitions for the topic. | if not
specified, will use the `num.partitions` property in the broker. |
No |
| `replication-factor` | The number of replications for the topic | if not
specified, will use the `default.replication.factor` property in the broker. |
No |
Pass other topic configurations to the topic properties. Refer to [Topic
Configs](https://kafka.apache.org/34/documentation.html#topicconfigs) for more
details.
diff --git a/docs/table-maintenance-service/optimizer-extension-guide.md
b/docs/table-maintenance-service/optimizer-extension-guide.md
index 9d33021cb1..8193636414 100644
--- a/docs/table-maintenance-service/optimizer-extension-guide.md
+++ b/docs/table-maintenance-service/optimizer-extension-guide.md
@@ -127,5 +127,5 @@ If you also extend Gravitino server job execution, see
[Manage jobs in Gravitino
- [Table Maintenance Service](./optimizer.md)
- [Configuration](./optimizer-configuration.md)
-- [CLI Reference](./optimizer-configuration.md)
+- [CLI Reference](./optimizer-cli-reference.md)
- [Troubleshooting](./optimizer-troubleshooting.md)
diff --git a/docs/topics.md b/docs/topics.md
index 185fb644b3..fffde8c810 100644
--- a/docs/topics.md
+++ b/docs/topics.md
@@ -52,7 +52,7 @@ A topic name is unique within its schema, and matches the
topic name in the clus
Two properties are settable at creation. `partition-count` sets the number of
partitions and can be
changed afterward. `replication-factor` sets the replication and is immutable
once the topic exists.
-Leaving either unset takes the broker's own default, from `num.partition` and
+Leaving either unset takes the broker's own default, from `num.partitions` and
`default.replication.factor` respectively.
### What Gravitino Stores and What It Does Not
@@ -77,7 +77,7 @@ the UI today. Attaching a tag to a topic goes through the API.
| Privilege | Grantable on | What it allows
|
|-----------------|-------------------------------------|-----------------------|
-| `CREATE_TOPIC` | Metalake, catalog, schema, or topic | Creating topics
|
+| `CREATE_TOPIC` | Metalake, catalog, or schema | Creating topics
|
| `PRODUCE_TOPIC` | Metalake, catalog, schema, or topic | Writing to a topic
|
| `CONSUME_TOPIC` | Metalake, catalog, schema, or topic | Reading from a topic
|
