private/model/api: Add docs for errors to API operations #881
Conversation
This file contains 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
jasdel
added
the
investigating
Adds additional information about inspecting the error returned by API operations to their respective doc strings. Also includes the Error code the SDK would return via the Error.Code interface method.
jasdel
force-pushed
the
feature/genAPIErrorDocs
branch
from
5b43185 to
1e77776
Compare
|
Updated to include more friendly error list, and ensure the correct error type vs code string is added to the doc based on protocol. _Example output added to Route53's ChangeResourceRecordSets docstring:_ Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error. See the AWS API reference guide for Amazon Route 53's API operation ChangeResourceRecordSets for usage and error information. Returned Error Codes: |
jasdel
added
Review Needed
and removed
investigating
|
|
jasdel
added a commit
to jasdel/aws-sdk-go
that referenced
this pull request
Oct 12, 2016
Service Model Updates --- * `service/ecr`: Update Amazon EC2 Container Registry service model * DescribeImages is a new api used to expose image metadata which today includes image size and image creation timestamp. * `service/elasticache`: Update Amazon ElastiCache service model * Elasticache is launching a new major engine release of Redis, 3.2 (providing stability updates and new command sets over 2.8), as well as ElasticSupport for enabling Redis Cluster in 3.2, which provides support for multiple node groups to horizontally scale data, as well as superior engine failover capabilities SDK Bug Fixes --- * `aws/session`: Skip shared config on read errors (aws#883) * `aws/signer/v4`: Add support for URL.EscapedPath to signer (aws#885) SDK Features --- * `private/model/api`: Add docs for errors to API operations (aws#881) * `private/model/api`: Improve field and waiter doc strings (aws#879) * `service/dynamodb/dynamodbattribute`: Allow multiple struct tag elements (aws#886) * Add build tags to internal SDK tools (aws#880)
jasdel
added a commit
to jasdel/aws-sdk-go
that referenced
this pull request
Oct 12, 2016
Service Model Updates --- * `service/ecr`: Update Amazon EC2 Container Registry service model * DescribeImages is a new api used to expose image metadata which today includes image size and image creation timestamp. * `service/elasticache`: Update Amazon ElastiCache service model * Elasticache is launching a new major engine release of Redis, 3.2 (providing stability updates and new command sets over 2.8), as well as ElasticSupport for enabling Redis Cluster in 3.2, which provides support for multiple node groups to horizontally scale data, as well as superior engine failover capabilities SDK Bug Fixes --- * `aws/session`: Skip shared config on read errors (aws#883) * `aws/signer/v4`: Add support for URL.EscapedPath to signer (aws#885) SDK Features --- * `private/model/api`: Add docs for errors to API operations (aws#881) * `private/model/api`: Improve field and waiter doc strings (aws#879) * `service/dynamodb/dynamodbattribute`: Allow multiple struct tag elements (aws#886) * Add build tags to internal SDK tools (aws#880)
Merged
jasdel
added a commit
that referenced
this pull request
Oct 12, 2016
Service Model Updates --- * `service/ecr`: Update Amazon EC2 Container Registry service model * DescribeImages is a new api used to expose image metadata which today includes image size and image creation timestamp. * `service/elasticache`: Update Amazon ElastiCache service model * Elasticache is launching a new major engine release of Redis, 3.2 (providing stability updates and new command sets over 2.8), as well as ElasticSupport for enabling Redis Cluster in 3.2, which provides support for multiple node groups to horizontally scale data, as well as superior engine failover capabilities SDK Bug Fixes --- * `aws/session`: Skip shared config on read errors (#883) * `aws/signer/v4`: Add support for URL.EscapedPath to signer (#885) SDK Features --- * `private/model/api`: Add docs for errors to API operations (#881) * `private/model/api`: Improve field and waiter doc strings (#879) * `service/dynamodb/dynamodbattribute`: Allow multiple struct tag elements (#886) * Add build tags to internal SDK tools (#880)
diehlaws
added
needs-review
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.
Adds docs to API operations on with the errors that could be returned by the service.
Progress note:
type. This may not match the errorcodereturned by the SDK, because the SDK is given thecodeby the service instead oftype.