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.

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

private/model/api: Fix API doc being generated with wrong value #2748

Merged
merged 2 commits into from
Aug 12, 2019

Conversation

jasdel
Copy link
Contributor

@jasdel jasdel commented Aug 10, 2019

Fixes the SDK's generated API documentation for structure member being
generated with the wrong documentation value when the member was
included multiple times in the model doc-2.json file, but under
different types.

The SDK was not considering the member's type when associating documetation
with the member. Only parent struct name and member names was being
used.

Fixes the SDK's generated API documentation for structure member being
generated with the wrong documentation value when the member was
included multiple times in the model doc-2.json file, but under
different types.

The SDK was not considering the member's type when associating documetation
with the member. Only parent struct name and member names was being
used.
@jasdel jasdel requested a review from skotambkar August 10, 2019 18:56
@jasdel jasdel added the needs-review This issue or pull request needs review from a core team member. label Aug 10, 2019
@jasdel jasdel merged commit 9e9bc84 into aws:master Aug 12, 2019
@jasdel jasdel deleted the fixup/UnstableAPIDocs branch August 12, 2019 20:11
@aws-sdk-go-automation aws-sdk-go-automation mentioned this pull request Aug 13, 2019
jasdel added a commit to jasdel/aws-sdk-go-v2 that referenced this pull request Aug 19, 2019
Fixes the SDK's generated API documentation for structure member being
generated with the wrong documentation value when the member was
included multiple times in the model doc-2.json file, but under
different types.

The SDK was not considering the member's type when associating documetation
with the member. Only parent struct name and member names was being
used.

V2 Port of aws/aws-sdk-go#2748
jasdel added a commit to aws/aws-sdk-go-v2 that referenced this pull request Aug 20, 2019
Fixes the SDK's generated API documentation for structure member being
generated with the wrong documentation value when the member was
included multiple times in the model doc-2.json file, but under
different types.

The SDK was not considering the member's type when associating documentation
with the member. Only parent struct name and member names was being
used.

V2 Port of aws/aws-sdk-go#2748
jasdel added a commit to jasdel/aws-sdk-go-v2 that referenced this pull request Aug 22, 2019
Services
===
* Synced the V2 SDK with latest AWS service API definitions.
  * Fixes [aws#359](aws#359)

SDK Features
===

SDK Enhancements
===
* `private/protocol`: Add support for TimestampFormat in protocols ([aws#358](aws#358))
  * Adds support for the timestampForamt API model trait to the V2 SDK. The SDK will now generate API client parameters with the correct time format for APIs modeled with custom time stamp formats specified.
  * Fixes [aws#202](aws#202)
  * Fixes [aws#286](aws#286)
* `aws`: Add example for custom HTTP client idle connection options ([aws#350](aws#350))
  * Adds example to the SDK for configuring custom HTTP client idle connection keep alive options.

SDK Bugs
===
* `private/model/api`: Fix API doc being generated with wrong value ([aws#359](aws#359))
  * Fixes the SDK's generated API documentation for structure member being generated with the wrong documentation value when the member was included multiple times in the model doc-2.json file, but under different types.
  * V2 port of to v1 [aws/aws-sdk-go#2748](aws/aws-sdk-go#2748)
* `aws/ec2rolecreds`: Fix security creds path to include trailing slash ([aws#356](aws#356))
  * Fixes the iamSecurityCredsPath var to include a trailing slash preventing redirects when making requests to the EC2 Instance Metadata service.
  * Fixes [aws#351](aws#351)
* `service/dynamodb/expression`: Improved reporting of bad key conditions ([aws#360](aws#360))
  * Improved error reporting when invalid key conditions are constructed using KeyConditionBuilder
jasdel added a commit to aws/aws-sdk-go-v2 that referenced this pull request Aug 23, 2019
Services
===
* Synced the V2 SDK with latest AWS service API definitions.
  * Fixes [#359](#359)

SDK Features
===

SDK Enhancements
===
* `private/protocol`: Add support for TimestampFormat in protocols ([#358](#358))
  * Adds support for the timestampForamt API model trait to the V2 SDK. The SDK will now generate API client parameters with the correct time format for APIs modeled with custom time stamp formats specified.
  * Fixes [#202](#202)
  * Fixes [#286](#286)
* `aws`: Add example for custom HTTP client idle connection options ([#350](#350))
  * Adds example to the SDK for configuring custom HTTP client idle connection keep alive options.

SDK Bugs
===
* `private/model/api`: Fix API doc being generated with wrong value ([#359](#359))
  * Fixes the SDK's generated API documentation for structure member being generated with the wrong documentation value when the member was included multiple times in the model doc-2.json file, but under different types.
  * V2 port of to v1 [aws/aws-sdk-go#2748](aws/aws-sdk-go#2748)
* `aws/ec2rolecreds`: Fix security creds path to include trailing slash ([#356](#356))
  * Fixes the iamSecurityCredsPath var to include a trailing slash preventing redirects when making requests to the EC2 Instance Metadata service.
  * Fixes [#351](#351)
* `service/dynamodb/expression`: Improved reporting of bad key conditions ([#360](#360))
  * Improved error reporting when invalid key conditions are constructed using KeyConditionBuilder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-review This issue or pull request needs review from a core team member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants