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
onkabes
force-pushed
the
schemas-cli-docs-v1
branch
2 times, most recently
from
a867cff to
574facb
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #8985 +/- ##
==========================================
- Coverage 0.08% 0.08% -0.01%
==========================================
Files 210 210
Lines 16952 16978 +26
==========================================
Hits 14 14
- Misses 16938 16964 +26 ☔ View full report in Codecov by Sentry. |
elysahall
approved these changes
Jan 8, 2025
elysahall
added
pr:needs-review
elysahall
assigned kdaily, ashovlin, aemous, AndrewAsseily and hssyoo and unassigned kdaily, ashovlin, aemous, AndrewAsseily and hssyoo
elysahall
requested review from
kdaily,
ashovlin,
aemous,
AndrewAsseily and
hssyoo
ashovlin
reviewed
Jan 21, 2025
| Output:: | ||
|
|
||
| { | ||
| "Content": "{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"version\": \"1.0.0\",\n \"title\": \"Event\"\n },\n \"paths\": {},\n \"components\": {\n \"schemas\": {\n \"Event\": {\n \"type\": \"object\",\n \"properties\": {\n \"ordinal\": {\n \"type\": \"number\",\n \"format\": \"int64\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"price\": {\n \"type\": \"number\",\n \"format\": \"double\"\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"comments\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n }\n }\n }\n }\n}", |
There was a problem hiding this comment.
Are the \n expected to be part of the output? Just checking that they weren't the result of copy+paste or something similar.
Running it for an AWS schema, I see the JSON on one line without the newlines.
aws schemas describe-schema --registry-name aws.events --schema-name aws.a4b@RoomStateChange
{
"Content": "{ \"openapi\": \"3.0.0\", \"info\": { \"version\": \"1.0.0\", \"title\": \"RoomStateChange\" }, \"paths\": {}, \"components\": { \"schemas\": { \"AWSEvent\": { \"type\": \"object\", \"required\": [ \"detail-type\", \"resources\", \"detail\", \"id\", \"source\", \"time\", \"region\", \"account\" ], \"x-amazon-events-detail-type\": \"Room State Change\", \"x-amazon-events-source\": \"aws.a4b\", \"properties\": { \"detail\": { \"$ref\": \"#/components/schemas/RoomStateChange\" }, \"account\": { \"type\": \"string\" }, \"detail-type\": { \"type\": \"string\" }, \"id\": { \"type\": \"string\" }, \"region\": { \"type\": \"string\" }, \"resources\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"source\": { \"type\": \"string\" }, \"time\": { \"type\": \"string\", \"format\": \"date-time\" } } }, \"RoomStateChange\": { \"type\": \"object\", \"required\": [ \"mode\", \"calendar-event\", \"event-type\", \"version\" ], \"properties\": { \"calendar-event\": { \"$ref\": \"#/components/schemas/Calendar-event\" }, \"event-type\": { \"type\": \"string\" }, \"mode\": { \"type\": \"string\" }, \"version\": { \"type\": \"string\" } } }, \"Calendar-event\": { \"type\": \"object\", \"required\": [ \"profileArn\", \"calendarId\", \"provider\", \"startTime\", \"endTime\", \"id\", \"roomArn\" ], \"properties\": { \"calendarId\": { \"type\": \"string\" }, \"checkInTime\": { \"type\": \"string\", \"format\": \"date-time\" }, \"endTime\": { \"type\": \"string\", \"format\": \"date-time\" }, \"id\": { \"type\": \"string\" }, \"profileArn\": { \"type\": \"string\" }, \"provider\": { \"type\": \"string\" }, \"releaseTime\": { \"type\": \"string\", \"format\": \"date-time\" }, \"roomArn\": { \"type\": \"string\" }, \"startTime\": { \"type\": \"string\", \"format\": \"date-time\" } } } } } }",
"Description": "Schema for event type RoomStateChange, published by AWS service aws.a4b",
"LastModified": "2020-10-22T16:03:09+00:00",
"SchemaArn": "",
"SchemaName": "aws.a4b@RoomStateChange",
"SchemaVersion": "1",
"Tags": {},
"Type": "OpenApi3",
"VersionCreatedDate": "2020-10-22T16:03:09+00:00"
}
There was a problem hiding this comment.
I think it's important to still have the \" escaping in the Content value, if that's what the service is returning.
ashovlin
reviewed
Jan 21, 2025
ashovlin
reviewed
Jan 21, 2025
| Output:: | ||
|
|
||
| { | ||
| "Policy": "{\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Sid\": \"AllowReadWrite\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"*\"\n },\n \"Action\": \"schemas:*\",\n \"Resource\": [\"arn:aws:schemas:us-east-1:012345678912:registry/example-registry\", \"arn:aws:schemas:us-east-1:012345678912:schema/example-registry*\"]\n }]\n}\n", |
There was a problem hiding this comment.
Similar question as https://github.com/aws/aws-cli/pull/8985/files#r1923940695
ashovlin
reviewed
Jan 21, 2025
ashovlin
reviewed
Jan 21, 2025
Comment on lines
3
to
15
| The following ``update-discoverer`` example updates an existing discoverer on the Event Bus. You can change the description, or you can enable or disable discovering schemas on cross-012345678912 Events. :: | ||
|
|
||
| aws schemas update-discoverer \ | ||
| --discoverer-id example-discoverer-id \ | ||
| --no-cross-012345678912 | ||
|
|
||
| Output:: | ||
|
|
||
| { | ||
| "DiscovererArn": "arn:aws:schemas:us-east-1:012345678912:discoverer/example-discoverer-id", | ||
| "DiscovererId": "example-discoverer-id", | ||
| "SourceArn": "arn:aws:events:us-east-1:012345678912:event-bus/example-event-bus", | ||
| "State": "STOPPED", | ||
| "Cross012345678912": false, |
There was a problem hiding this comment.
Looks like "account" may have been replaced with 012345678912 in three places.
There was a problem hiding this comment.
I'm still seeing cross-012345678912 and Cross012345678912 instead of cross-account and CrossAccount.
ashovlin
reviewed
Jan 21, 2025
Comment on lines
3
to
9
| The following ``update-registry`` example waits for a new code binding to be created from the put-code-binding API. :: | ||
|
|
||
| aws schemas wait code-binding-exists \ | ||
| --registry-name example-registry \ | ||
| --schema-name example-schema \ | ||
| --schema-version 6 \ | ||
| --language Python36 |
There was a problem hiding this comment.
There's a mismatch between the command in the code block and that in the description.
ashovlin
requested changes
Jan 21, 2025
onkabes
force-pushed
the
schemas-cli-docs-v1
branch
from
6d0fedc to
15d278f
Compare
|
requested changes have been made |
ashovlin
reviewed
Feb 7, 2025
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.