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 documentation to IAM trait enums #1322

Merged
merged 1 commit into from
Jul 29, 2022
Merged

Add documentation to IAM trait enums #1322

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
58 changes: 41 additions & 17 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 @@ -127,79 +127,99 @@
"ARN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ARN"
"smithy.api#enumValue": "ARN",
"smithy.api#documentation": "A String type that contains an Amazon Resource Name (ARN)."
}
},
"ARRAY_OF_ARN": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfARN"
"smithy.api#enumValue": "ArrayOfARN",
"smithy.api#documentation": "An unordered list of ARN types."
}
},
"BINARY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "Binary"
"smithy.api#enumValue": "Binary",
"smithy.api#documentation": "A String type that contains base-64 encoded binary data."
}
},
"ARRAY_OF_BINARY": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfBinary"
"smithy.api#enumValue": "ArrayOfBinary",
"smithy.api#documentation": "An unordered list of Binary types."
}
},
"STRING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "String"
"smithy.api#enumValue": "String",
"smithy.api#documentation": "A general string type."
}
},
"ARRAY_OF_STRING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfString"
"smithy.api#enumValue": "ArrayOfString",
"smithy.api#documentation": "An unordered list of String types."
}
},
"NUMERIC": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "Numeric"
"smithy.api#enumValue": "Numeric",
"smithy.api#documentation": "A general type for integers and floats."
}
},
"ARRAY_OF_NUMERIC": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfNumeric",
"smithy.api#documentation": "An unordered list of Numeric types."
}
},
"DATE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "Date"
"smithy.api#enumValue": "Date",
"smithy.api#documentation": "A String type that conforms to the datetime profile of ISO 8601."
}
},
"ARRAY_OF_DATE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfDate"
"smithy.api#enumValue": "ArrayOfDate",
"smithy.api#documentation": "An unordered list of Date types."
}
},
"BOOL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "Bool"
"smithy.api#enumValue": "Bool",
"smithy.api#documentation": "A general boolean type."
}
},
"ARRAY_OF_BOOL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfBool"
"smithy.api#enumValue": "ArrayOfBool",
"smithy.api#documentation": "An unordered list of Bool types."
}
},
"IP_ADDRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "IPAddress"
"smithy.api#enumValue": "IPAddress",
"smithy.api#documentation": "A String type that conforms to RFC 4632."
}
},
"ARRAY_OF_IP_ADDRESS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ArrayOfIPAddress"
"smithy.api#enumValue": "ArrayOfIPAddress",
"smithy.api#documentation": "An unordered list of IPAddress types."
}
}
},
Expand All @@ -214,25 +234,29 @@
"ROOT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "Root"
"smithy.api#enumValue": "Root",
"smithy.api#documentation": "An AWS account."
}
},
"IAM_USER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "IAMUser"
"smithy.api#enumValue": "IAMUser",
"smithy.api#documentation": "An AWS IAM user."
}
},
"IAM_ROLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "IAMRole"
"smithy.api#enumValue": "IAMRole",
"smithy.api#documentation": "An AWS IAM role."
}
},
"FEDERATED_USER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FederatedUser"
"smithy.api#enumValue": "FederatedUser",
"smithy.api#documentation": "A federated user session."
}
}
},
Expand Down