This is an automated email from the ASF dual-hosted git repository.
mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 4ed4233 Add documentation for schema CLI (#1983)
4ed4233 is described below
commit 4ed4233d9ed0e119b679cb120a014cd456967ac9
Author: Sijie Guo <[email protected]>
AuthorDate: Mon Jun 18 18:29:24 2018 -0700
Add documentation for schema CLI (#1983)
*Motivation*
Make sure we document schema CLI
*Solution*
Add the section in pulsar-admin for schemas CLI.
The last `compact` section is duplicated so removed it.
---
site/_data/cli/pulsar-admin.yaml | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/site/_data/cli/pulsar-admin.yaml b/site/_data/cli/pulsar-admin.yaml
index dbbbf79..46fc0a4 100644
--- a/site/_data/cli/pulsar-admin.yaml
+++ b/site/_data/cli/pulsar-admin.yaml
@@ -730,9 +730,22 @@ commands:
description: A bundle of the form `{start-boundary}_{end_boundary}`.
- flags: -n, --namespace
description: The namespace as `property/cluster/namespace`, for example
`my-prop/my-cluster/my-ns`.
-- name: topics
- description: Operations related to Pulsar topics of all kinds (both
persistent and non-persistent)
+- name: schemas
+ description: Operations related to Schemas associated with Pulsar topics.
subcommands:
- - name: compact
- description: Runs a compaction operation on the specified topic
- argument: topic-name
+ - name: upload
+ description: Upload the schema definition for a topic
+ argument: persistent://tenant/namespace/topic
+ options:
+ - flags: --filename
+ description: The path to the schema definition file. An example schema
file is available under `conf` directory.
+ - name: delete
+ description: Delete the schema definition associated with a topic
+ argument: persistent://tenant/namespace/topic
+ - name: get
+ description: Retrieve the schema definition assoicated with a topic (at a
given version if version is supplied).
+ argument: persistent://tenant/namespace/topic
+ options:
+ - flags: --version
+ description: The version of the schema definition to retrive for a topic.
+
