fix: regenerate documentation for registry (#1378)

docs/commands/rhoas_service-registry.md

@@ -4,15 +4,15 @@ Service Registry commands
 
 ### Synopsis
 
-
 Manage and interact with your Service Registry instances directly from the command line.
 
 Create new Service Registry instances and interact with them by adding schema and API artifacts and downloading them to your computer.
 
 Commands are divided into the following categories:
- - instance management commands: create, list, and so on
- - commands executed on selected instance: artifacts
- - "use" command that selects the current instance
+
+* Instance management commands: create, list, and so on
+* Commands executed on selected instance: artifacts
+* "use" command that selects the current instance
 
 
 ### Examples
@@ -22,7 +22,7 @@ Commands are divided into the following categories:
 rhoas service-registry create --name myregistry
 
 ## List Service Registry instances
-rhoas service-registry list 
+rhoas service-registry list
 
 ```
 

docs/commands/rhoas_service-registry_artifact.md

@@ -59,11 +59,11 @@ For example: https://raw.githubusercontent.com/redhat-developer/app-services-cli
 ### SEE ALSO
 
 * [rhoas service-registry](rhoas_service-registry.md)	 - Service Registry commands
-* [rhoas service-registry artifact create](rhoas_service-registry_artifact_create.md)	 - Creates new artifact from file or standard input
-* [rhoas service-registry artifact delete](rhoas_service-registry_artifact_delete.md)	 - Deletes single or all artifacts in a given group
+* [rhoas service-registry artifact create](rhoas_service-registry_artifact_create.md)	 - Create new artifact from file or standard input
+* [rhoas service-registry artifact delete](rhoas_service-registry_artifact_delete.md)	 - Deletes an artifact or all artifacts in a given group
 * [rhoas service-registry artifact download](rhoas_service-registry_artifact_download.md)	 - Download artifacts from Service Registry using global identifiers
 * [rhoas service-registry artifact export](rhoas_service-registry_artifact_export.md)	 - Export data from Service Registry instance
-* [rhoas service-registry artifact get](rhoas_service-registry_artifact_get.md)	 - Get artifact by ID and group
+* [rhoas service-registry artifact get](rhoas_service-registry_artifact_get.md)	 - Get artifact by ID, group, and version
 * [rhoas service-registry artifact import](rhoas_service-registry_artifact_import.md)	 - Import data into a Service Registry instance
 * [rhoas service-registry artifact list](rhoas_service-registry_artifact_list.md)	 - List artifacts
 * [rhoas service-registry artifact metadata-get](rhoas_service-registry_artifact_metadata-get.md)	 - Get artifact metadata

docs/commands/rhoas_service-registry_artifact_create.md

@@ -1,23 +1,24 @@
 ## rhoas service-registry artifact create
 
-Creates new artifact from file or standard input
+Create new artifact from file or standard input
 
 ### Synopsis
 
-Creates a new artifact by posting the artifact content to the registry instance.
+Create a new artifact by posting the artifact content to the registry instance.
 
-Artifacts are typically in JSON format for most of the supported types, but may be in another format for a few (for example, PROTOBUF).
-Service Registry attempts to figure out what kind of artifact is being added from the following supported list:
+Artifacts are typically in JSON format for most of the supported types, but might be in another format for a few types (for example, PROTOBUF).
 
-- Avro (AVRO)
-- Protobuf (PROTOBUF)
-- JSON Schema (JSON)
-- Kafka Connect (KCONNECT)
-- OpenAPI (OPENAPI)
-- AsyncAPI (ASYNCAPI)
-- GraphQL (GRAPHQL)
-- Web Services Description Language (WSDL)
-- XML Schema (XSD)
+Service Registry attempts to identify what type of artifact is being added from the following supported list:
+
+* Avro (AVRO)
+* Protobuf (PROTOBUF)
+* JSON Schema (JSON)
+* Kafka Connect (KCONNECT)
+* OpenAPI (OPENAPI)
+* AsyncAPI (ASYNCAPI)
+* GraphQL (GRAPHQL)
+* Web Services Description Language (WSDL)
+* XML Schema (XSD)
 
 An artifact is created using the content provided in the request body.
 This content is created with a unique artifact ID that can be provided by user.
@@ -51,7 +52,7 @@ rhoas service-registry artifact create --type=JSON my-artifact.json
       --description string   Custom description of the artifact
       --file string          File location of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --name string          Custom name of the artifact
   -o, --output string        Output format (json, yaml, yml) (default "json")
   -t, --type string          Type of artifact. Choose from: AVRO, PROTOBUF, JSON, OPENAPI, ASYNCAPI, GRAPHQL, KCONNECT, WSDL, XSD, XML

docs/commands/rhoas_service-registry_artifact_delete.md

@@ -1,14 +1,14 @@
 ## rhoas service-registry artifact delete
 
-Deletes single or all artifacts in a given group
+Deletes an artifact or all artifacts in a given group
 
 ### Synopsis
 
-Deletes single or all artifacts in a given group.
+Deletes a single artifact or all artifacts in a given group:
 
-When called without arguments, deletes all artifacts in the group
-When --artifact-id is specified, deletes only a single artifact and its version
-When --group parameter is missing, the command uses the "default" group.
+* When called without arguments, deletes all artifacts in the group.
+* When --artifact-id is specified, deletes only a single artifact and its version.
+* When --group is omitted, the command uses the "default" group.
 
 
 ```
@@ -31,7 +31,7 @@ rhoas service-registry artifact delete --artifact-id=my-artifact
 ```
       --artifact-id string   ID of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
   -y, --yes                  Delete artifact without prompt
 ```
 

docs/commands/rhoas_service-registry_artifact_download.md

@@ -4,14 +4,16 @@ Download artifacts from Service Registry using global identifiers
 
 ### Synopsis
 
-Get single or more artifacts by group, content, hash or globalIds.
-NOTE: Use "service-registry get" command to download artifacts by artifactId.
+Get one or more artifacts by group, content, hash, or globalId.
 
-Flags are used to specify the artifact to download:
+NOTE: To download artifacts by artifactId, use the "service-registry artifact get" command.
 
---contentId - ID if the content is from metadata
---globalId - globalId of the content from metadata
---hash - SHA-256 hash of the content
+Use the following flags to specify the artifacts to download:
+
+* --contentId (ID if the content is from metadata)
+* --globalId (globalId of the content from metadata)
+* --hash (SHA-256 hash of the content)
+* --group (artifact group)
 
 
 ```
@@ -42,7 +44,7 @@ rhoas service-registry artifact download --hash=c71d239df91726fc519c6eb72d318ec6
       --global-id int        Global ID of the artifact (default -1)
   -g, --group string         Artifact group (default "default")
       --hash string          SHA-256 hash of the artifact
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --output-file string   Location of the output file
 ```
 

docs/commands/rhoas_service-registry_artifact_export.md

@@ -4,7 +4,7 @@ Export data from Service Registry instance
 
 ### Synopsis
 
-Export all artifacts and metadata from Service Registry instance to specified file
+Export all artifacts and metadata from a Service Registry instance to a specified file
 
 
 ```
@@ -22,7 +22,7 @@ rhoas service-registry artifact export --file=export.zip
 ### Options
 
 ```
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --output-file string   File location of the artifact
 ```
 

docs/commands/rhoas_service-registry_artifact_get.md

@@ -1,15 +1,15 @@
 ## rhoas service-registry artifact get
 
-Get artifact by ID and group
+Get artifact by ID, group, and version
 
 ### Synopsis
 
-Get artifact by specifying ID and group.
-Command fetches the latest artifact from the registry based on the artifact-id and group.
+Get an artifact from the registry based on the artifact ID, group, and version.
+
+NOTE: To fetch artifacts using global identifiers, use the "service-registry artifact download" command.
+
+When --version is specified, the command fetches the specified artifact version. When --version is not specified, the command fetches the latest artifact version.
 
-When --version is specified, the command fetches the specific artifact version.
-Get command fetches artifacts based on --group and --artifact-id and --version.
-For fetching artifacts using global identifiers, use the "service-registry download" command
 
 
 ```
@@ -38,7 +38,7 @@ rhoas service-registry artifact get --artifact-id=myartifact --version=4
 ```
       --artifact-id string   ID of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --output-file string   Location of the output file
       --version string       Version of the artifact
 ```

docs/commands/rhoas_service-registry_artifact_import.md

@@ -4,7 +4,7 @@ Import data into a Service Registry instance
 
 ### Synopsis
 
-Import all artifacts and metadata from export file to another Service Segistry instance
+Import all artifacts and metadata from an export file to another Service Registry instance
 
 
 ```
@@ -23,7 +23,7 @@ rhoas service-registry artifact import --file=export.zip
 
 ```
       --file string          File location of the artifact
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
 ```
 
 ### Options inherited from parent commands

docs/commands/rhoas_service-registry_artifact_list.md

@@ -4,7 +4,7 @@ List artifacts
 
 ### Synopsis
 
-List all artifacts for the group by specified output format (by default, table)
+List all artifacts for the group in the specified output format (by default, "table")
 
 ```
 rhoas service-registry artifact list [flags]
@@ -38,7 +38,7 @@ rhoas service-registry artifact list --description sample
 ```
       --description string     Text search to filter artifacts by description
   -g, --group string           Artifact group (default "default")
-      --instance-id string     ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string     ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --label stringArray      Text search to filter artifacts by labels
       --limit int32            Page limit (default 100)
       --name string            Text search to filter artifacts by name

docs/commands/rhoas_service-registry_artifact_metadata-get.md

@@ -4,7 +4,8 @@ Get artifact metadata
 
 ### Synopsis
 
-Gets the metadata for an artifact in a Service Registry instance
+Get the metadata for an artifact in a Service Registry instance.
+
 The returned metadata includes both generated (read-only) and editable metadata (such as name and description).
 
 
@@ -28,7 +29,7 @@ rhoas service-registry artifact metadata-get --artifact-id=my-artifact --group m
 ```
       --artifact-id string   ID of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
   -o, --output string        Output format (json, yaml, yml)
 ```
 

docs/commands/rhoas_service-registry_artifact_metadata-set.md

@@ -4,8 +4,9 @@ Update artifact metadata
 
 ### Synopsis
 
-Updates the metadata for an artifact in a Service Registry instance
-Editable metadata includes fields like name and description
+Update the metadata for an artifact in a Service Registry instance.
+
+Editable metadata includes fields such as name and description.
 
 
 ```
@@ -32,7 +33,7 @@ EDITOR="code -w" rhoas service-registry artifact metadata-set --artifact-id=my-a
       --artifact-id string   ID of the artifact
       --description string   Custom description of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --name string          Custom name of the artifact
   -o, --output string        Output format (json, yaml, yml)
 ```

docs/commands/rhoas_service-registry_artifact_state-set.md

@@ -4,10 +4,11 @@ Set artifact state
 
 ### Synopsis
 
-Set artifact state by setting one of possible values
-- ENABLED (Enable artifact)
-- DISABLED (Disable artifact usage)
-- DEPRECATED (Deprecate artifact)
+Set the artifact state by setting one of the following values:
+
+* ENABLED (Enable artifact)
+* DISABLED (Disable artifact usage)
+* DEPRECATED (Deprecate artifact)
 
 
 ```
@@ -27,7 +28,7 @@ rhoas service-registry artifact state-set --artifact-id=my-artifact --state=DISA
 ```
       --artifact-id string   ID of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --state string         new artifact state
 ```
 

docs/commands/rhoas_service-registry_artifact_update.md

@@ -4,17 +4,17 @@ Update artifact
 
 ### Synopsis
 
-Update artifact from file or directly standard input
+Update an artifact from a file or directly from standard input.
 
-Artifacts are typically in JSON format for most supported types, but may be in another format for a few (for example, PROTOBUF).
+Artifacts are typically in JSON format for most supported types, but might be in another format for some types (for example, PROTOBUF).
 The type of the content should be compatible with the current artifact type.
 
-When successful, this creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact.
+When successful, this command creates a new version of the artifact, making it the most recent (and therefore official) version of the artifact.
 
 An artifact is updated using the content provided in the request body.
-This content is updated under a unique artifactId provided by user.
+This content is updated under a unique artifactId provided by the user.
 
-Updated artifact content should conform to validity and compatibility rules set for the registry instance.
+Updated artifact content should conform to the validity and compatibility rules set for the registry instance.
 
 
 ```
@@ -39,7 +39,7 @@ rhoas service-registry artifact update --artifact-id=my-artifact --group my-grou
       --description string   Custom description of the artifact
   -f, --file string          File location of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
       --name string          Custom name of the artifact
       --version string       Custom version of the artifact (for example 1.0.0)
 ```

docs/commands/rhoas_service-registry_artifact_versions.md

@@ -4,7 +4,7 @@ Get latest artifact versions by artifact-id and group
 
 ### Synopsis
 
-Get latest artifact versions by specifying group and artifact-id
+Get the latest artifact versions by specifying the group and artifact-id
 
 ```
 rhoas service-registry artifact versions [flags]
@@ -26,7 +26,7 @@ rhoas service-registry artifact versions --artifact-id=my-artifact --group mygro
 ```
       --artifact-id string   ID of the artifact
   -g, --group string         Artifact group (default "default")
-      --instance-id string   ID of the Service Registry instance to be used. By default, uses the currently selected instance
+      --instance-id string   ID of the Service Registry instance to be used (by default, uses the currently selected instance)
   -o, --output string        Output format (json, yaml, yml)
 ```
 

docs/commands/rhoas_service-registry_create.md

@@ -4,7 +4,7 @@ Create a Service Registry instance
 
 ### Synopsis
 
-Create a Service Registry instance to store and manage your schema and API artifacts. 
+Create a Service Registry instance to store and manage your schema and API artifacts
 
 
 ```

docs/commands/rhoas_service-registry_delete.md

@@ -4,7 +4,6 @@ Delete a Service Registry instance
 
 ### Synopsis
 
-
 Delete a Service Registry instance along with all of its schema and API artifacts.
 
 

docs/commands/rhoas_service-registry_describe.md

@@ -4,8 +4,7 @@ Describe a Service Registry instance
 
 ### Synopsis
 
-
-Describe a Service Registry instance. Fetch all required fields including the registry URL. 
+Describe a Service Registry instance. Fetch all required fields including the registry URL.
 
 
 ```

docs/commands/rhoas_service-registry_list.md

@@ -4,7 +4,6 @@ List Service Registry instances
 
 ### Synopsis
 
-
 List all Service Registry instances for your account and paginate over the results.