Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing documentation for some trait models #737

Merged
merged 1 commit into from
Mar 11, 2021
Merged

Add missing documentation for some trait models #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion smithy-aws-apigateway-traits/src/main/resources/META-INF/smithy/aws.apigateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,10 @@
"type": "structure",
"members": {
"statusCode": {
"target": "smithy.api#String"
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "HTTP status code for the method response; for example, \"200\". This must correspond to a matching response in the OpenAPI Operation responses field."
}
},
"contentHandling": {
"target": "aws.apigateway#ContentHandling"
Expand Down
13 changes: 10 additions & 3 deletions smithy-aws-iam-traits/src/main/resources/META-INF/smithy/aws.iam.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,16 @@
"type": "structure",
"members": {
"documentation": {
"target": "smithy.api#String"
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "Defines documentation about the condition key."
}
},
"externalDocumentation": {
"target": "smithy.api#String"
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "A valid URL that defines more information about the condition key."
}
},
"type": {
"target": "aws.iam#ConditionKeyType",
Expand All @@ -82,7 +88,8 @@
}
},
"traits": {
"smithy.api#private": {}
"smithy.api#private": {},
"smithy.api#documentation": "A defined condition key to appear within a service in addition to inferred and global condition keys."
}
},
"aws.iam#ConditionKeyType": {
Expand Down