Skip to content

docs: add docs for schemas and protocols#7583

Merged
kuhe merged 1 commit intomainfrom
kuhe/docs/schemas
Dec 16, 2025
Merged

docs: add docs for schemas and protocols#7583
kuhe merged 1 commit intomainfrom
kuhe/docs/schemas

Conversation

@kuhe
Copy link
Copy Markdown
Contributor

@kuhe kuhe commented Dec 16, 2025

Issue

smithy-lang/smithy-typescript#1600

Description

Adds docs under supplemental docs

  • protocol selection for clients
  • schemas

Testing

added integration test using schemas in the ways documented

@kuhe kuhe requested a review from a team as a code owner December 16, 2025 18:48
@kuhe kuhe force-pushed the kuhe/docs/schemas branch 4 times, most recently from 1471c95 to 787d2cc Compare December 16, 2025 19:15

#### Keep in mind

- At this time, few AWS services support more than one protocol.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is there a website which reader can visit to find out which services support multiple protocols.

This website shows occurrences of aws.protocols# in models for example https://github.com/search?q=repo%3Aaws%2Faws-sdk-js-v3%20%22aws.protocols%23%22%20path%3A*.json&type=code

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.

We can generate the list of supported protocols into each client package's documentation.

I'll do that in a later PR, since the list is unlikely to change for the time being.

@kuhe kuhe force-pushed the kuhe/docs/schemas branch from 787d2cc to 401ced8 Compare December 16, 2025 20:51
@kuhe kuhe merged commit 1662866 into main Dec 16, 2025
7 checks passed
@kuhe kuhe deleted the kuhe/docs/schemas branch December 16, 2025 21:40
@github-actions
Copy link
Copy Markdown

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Dec 31, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants