Skip to content

Document awsQuery protocol#700

Merged
kstich merged 2 commits intomainfrom
query_protocol_docs
Feb 3, 2021
Merged

Document awsQuery protocol#700
kstich merged 2 commits intomainfrom
query_protocol_docs

Conversation

@kstich
Copy link
Copy Markdown
Contributor

@kstich kstich commented Feb 2, 2021

This fleshes out the documentation for the awsQuery protocol.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly darker to be visible in dark background table rows without being obnoxious in light backgrounds.

@kstich kstich force-pushed the query_protocol_docs branch from 539d9f2 to 0adcb0e Compare February 2, 2021 03:00
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifically the operation's shape name ( :token:`shape name ` )

Comment on lines 150 to 152
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

parameter -> member ?

Comment on lines 207 to 234
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These could use inlined examples

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

specifically the string member. The mixing of quotes and ticks is a bit odd here. The same applies the the other entries

Comment on lines 210 to 212
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To what are the traits applied
ditto for member and structure

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please define how one serializes a null value. Also empty string

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wording in the request section is better as it calls out that this protocol specifically doesn't support it

Comment on lines 304 to 332
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These could also use inline examples, or links to the specific sections of the serializing xml shapes page

This fleshes out the documentation for the `awsQuery` protocol.
@kstich kstich force-pushed the query_protocol_docs branch 4 times, most recently from 0359a7b to acc2c04 Compare February 3, 2021 03:16
Comment on lines 142 to 144
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These traits should be ref'd

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The s in errors should be lowercased

Comment on lines 148 to 165
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should show up in normal query too

This adds documentation for ec2Query by abstracting out the docs
for awsQuery and including substitutions for the differences.

Examples for awsQuery have been added as well.
@kstich kstich force-pushed the query_protocol_docs branch from acc2c04 to 1f28d6f Compare February 3, 2021 14:42
@kstich kstich merged commit 61cffbe into main Feb 3, 2021
@kstich kstich deleted the query_protocol_docs branch February 3, 2021 18:14
@kstich kstich mentioned this pull request Feb 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants