adding schemas-cli-examples #8985
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elysahall
added
documentation
elysahall
suggested changes
Nov 13, 2024
|
|
||
| The following ``create-discoverer`` creates a discoverer. :: | ||
|
|
||
| aws schemas create-discoverer \ |
There was a problem hiding this comment.
All your examples are using tab indenting. Indents should be exactly 4 spaces per level of indentation. Please update all your examples to use 4 space indenting.
https://aws.github.io/aws-cli/docs_styleguide.html#general
| @@ -0,0 +1,20 @@ | |||
| **To create a discoverer** | |||
|
|
|||
| The following ``create-discoverer`` creates a discoverer. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``create-discoverer`` creates a discoverer. :: | |
| The following ``create-discoverer`` example creates a discoverer. :: |
All your examples need to be updated to include the expression:
The following ``command-name`` example...
https://aws.github.io/aws-cli/docs_styleguide.html#description
| @@ -0,0 +1,8 @@ | |||
| **To delete a discoverer** | |||
|
|
|||
| The following ``delete-discoverer`` deletes a discoverer. If the command succeeds, no output is returned. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``delete-discoverer`` deletes a discoverer. If the command succeeds, no output is returned. :: | |
| The following ``delete-discoverer`` deletes a discoverer. :: |
For commands that produce no output, use the following line after the command and update all your examples to follow this format:
This command produces no output.
https://aws.github.io/aws-cli/docs_styleguide.html#command-produces-no-output
|
|
||
| aws schemas delete-discoverer \ | ||
| --discoverer-id example-discoverer-name | ||
|
|
There was a problem hiding this comment.
Suggested change
| This command produces no output. | |
| The following ``get-discovered-schema`` retrieves the discovered schema that was created by the Schemas service based on a sample event. :: | ||
|
|
||
| aws schemas get-discovered-schema \ | ||
| --events "{\"Source\":\"com.mycompany.myapp\",\"Detail\":\"{ \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\" }\",\"EventBusName\":\"default\",\"Resources\":[\"resource1\",\"resource2\"],\"DetailType\":\"myDetailType\"}" \ |
There was a problem hiding this comment.
Quotation rules for command examples must use unix-like formatting rules. This means using single quotes and unescaping your double quotes similar to the following:
Suggested change
| --events "{\"Source\":\"com.mycompany.myapp\",\"Detail\":\"{ \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\" }\",\"EventBusName\":\"default\",\"Resources\":[\"resource1\",\"resource2\"],\"DetailType\":\"myDetailType\"}" \ | |
| --events '{"Source":"com.mycompany.myapp","Detail":"{ \\"key1\\": \\"value1\\", \\"key2\\": \\"value2\\" }","EventBusName":"default","Resources":["resource1","resource2"],"DetailType":"myDetailType"}' \ |
Please update all examples not following these rules.
https://aws.github.io/aws-cli/docs_styleguide.html#command
| @@ -0,0 +1,15 @@ | |||
| **To retrieve the discovered schema that was created by the Schemas service based on a sample event.** | |||
There was a problem hiding this comment.
Suggested change
| **To retrieve the discovered schema that was created by the Schemas service based on a sample event.** | |
| **To retrieve the discovered schema that was created by the Schemas service based on a sample event** |
| @@ -0,0 +1,19 @@ | |||
| **To list all the existing registries** | |||
|
|
|||
| The following ``list-registries`` lists all the existing registries. You may use the --registry-name-prefix flag to narrow down the results. The command will return all registries by default, but you may narrow the results using the --scope flag to narrow down the results to custom or AWS managed registries. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``list-registries`` lists all the existing registries. You may use the --registry-name-prefix flag to narrow down the results. The command will return all registries by default, but you may narrow the results using the --scope flag to narrow down the results to custom or AWS managed registries. :: | |
| The following ``list-registries`` lists all the existing registries. You may use the ``--registry-name-prefix`` option to narrow down the results. The command will return all registries by default, but you may narrow the results using the ``--scope`` option to narrow down the results to custom or AWS managed registries. :: |
| @@ -0,0 +1,22 @@ | |||
| **To list all the existing schemas available in a registry** | |||
|
|
|||
| The following ``list-schemas`` lists all the existing schemas available in a registry. You may optionally use the --schema-name-prefix to narrow down the results. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``list-schemas`` lists all the existing schemas available in a registry. You may optionally use the --schema-name-prefix to narrow down the results. :: | |
| The following ``list-schemas`` lists all the existing schemas available in a registry. You may optionally use the ``--schema-name-prefix`` option to narrow down the results. :: |
| @@ -0,0 +1,20 @@ | |||
| **To create a new code biding source URI for a particular schema version in the language specified** | |||
There was a problem hiding this comment.
Suggested change
| **To create a new code biding source URI for a particular schema version in the language specified** | |
| **To create a new code binding source URI for a particular schema version in the language specified** |
| @@ -0,0 +1,20 @@ | |||
| **To create a new code biding source URI for a particular schema version in the language specified** | |||
|
|
|||
| The following ``put-code-binding`` creates a new code biding source URI for a particular schema version in the language specified. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``put-code-binding`` creates a new code biding source URI for a particular schema version in the language specified. :: | |
| The following ``put-code-binding`` creates a new code binding source URI for a particular schema version in the language specified. :: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Adding example CLI commands for Amazon EventBridge Schemas: https://docs.aws.amazon.com/cli/latest/reference/schemas/
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.