Improve API Gateway documentation#3118
Merged
Merged
Conversation
Group traits by task (authentication, method/response, integrations, endpoint and access control) and alphabetize within each group. Add Validation sub-sections for traits with validators, cross-references between aws.apigateway and aws.auth authorization traits, and a section listing public traits from other namespaces that influence API Gateway OpenAPI generation. Fix dead developer-guide links. In the OpenAPI guide, expand the Other traits table, demote Cognito and API key sections under Authorizers, and add a Recommendations section covering jsonAdd, substitutions, and CloudFormation Fn::Sub patterns.
sugmanue
reviewed
May 14, 2026
kstich
requested changes
May 14, 2026
kstich
approved these changes
May 14, 2026
This file contains hidden or 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
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.
Group traits by task (authentication, method/response, integrations,
endpoint and access control) and alphabetize within each group. Add
Validation sub-sections for traits with validators, cross-references
between aws.apigateway and aws.auth authorization traits, and a section
listing public traits from other namespaces that influence API Gateway
OpenAPI generation. Fix dead developer-guide links. In the OpenAPI
guide, expand the Other traits table, demote Cognito and API key
sections under Authorizers, and add a Recommendations section covering
jsonAdd, substitutions, and CloudFormation Fn::Sub patterns.
Background
What do these changes do?
Documentation-only cleanup of the public Amazon API Gateway and
OpenAPI guides. The trait sections in
amazon-apigateway.rstwere aflat alphabetical list with stale links and inconsistent formatting.
After the recent set of trait additions (
endpointConfiguration,gatewayResponses,apiTlsPolicy,cognitoUserPoolsScopes), thepage needed restructuring to make the traits easier to discover and
to call out validation behavior.
Why are they important?
Smithy users converting models to OpenAPI for API Gateway are the
primary consumers of these pages. Grouping traits by task, listing
related traits from
aws.authandsmithy.api, and documentingvalidators and recommended workarounds (jsonAdd, substitutions,
CloudFormation Fn::Sub) makes the public docs match the current trait
surface and reduces support questions.
Testing
How did you test these changes?
-W -n) from a clean build directoryon Python 3.12 with Sphinx 9.1; build succeeds with no warnings.
./gradlew buildto confirm the wider project still passes.:ref:labels) and externallink resolves.
extension claim matches the current implementation in
smithy-aws-apigateway-openapi(mappers, security schemeconverters) and
smithy-aws-apigateway-traits(validators).Links
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.