Skip to content

ECS "Pages" APIs documentation incorrect #351

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

Closed
jhspaybar opened this issue Aug 17, 2015 · 2 comments
Closed

ECS "Pages" APIs documentation incorrect #351

jhspaybar opened this issue Aug 17, 2015 · 2 comments

Comments

@jhspaybar
Copy link

I haven't been able to find where to submit a pull request to change documentation, if you can point me to where it exists I'll happily submit a pull request. If it's not something I change, it looks like the ECS docs have code like

pageNum := 0
err := client.ListContainerInstancesPages(params, func(page *ecs.ListContainerInstancesInput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})

Where the "page" type should be ...Output rather than ...Input.

http://docs.aws.amazon.com/sdk-for-go/api/service/ecs/ECS.html#ListContainerInstancesPages-instance_method

@marcosnils
Copy link
Contributor

@jhspaybar documentation is generated automatically using ruby scripts located in the repo. Specifically what you want to modify is located here:

@note This operation can generate multiple requests to a service.
@example Iterating over at most 3 pages of a #{opname} operation
pageNum := 0
err := client.#{obj.name}(params, func(page *#{obj.parent.parent.name}.#{obj.parameters.first[0].split("*").last}, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
@see #{opname}

marcosnils added a commit to marcosnils/aws-sdk-go that referenced this issue Aug 17, 2015
Fix parameter input type in pages operations

Fixes aws#351

Signed-off-by: Marcos Lilljedahl <[email protected]>
@jasdel jasdel closed this as completed in 83ab8bd Aug 18, 2015
@jasdel
Copy link
Contributor

jasdel commented Aug 18, 2015

I pulled in this update and updated the docs. The EC2 request docs are now updated. Thanks for taking the time to report this issue.

http://docs.aws.amazon.com/sdk-for-go/api/service/ecs/ECS.html#ListContainerInstancesPages-instance_method

jasdel added a commit that referenced this issue Aug 20, 2015
skotambkar pushed a commit to skotambkar/aws-sdk-go that referenced this issue May 20, 2021
…ws#356)

Fixes the EC2 Instance Metadata Service client to no longer squash the trailing slash when requesting instance metadata. Also, fixes the iamSecurityCredsPath var to include a trailing slash preventing redirects when making requests to the EC2 Instance Metadata service.

Fix aws#351
Related to aws#351
skotambkar pushed a commit to skotambkar/aws-sdk-go that referenced this issue May 20, 2021
Services
===
* Synced the V2 SDK with latest AWS service API definitions.
  * Fixes [aws#359](aws/aws-sdk-go-v2#359)

SDK Features
===

SDK Enhancements
===
* `private/protocol`: Add support for TimestampFormat in protocols ([aws#358](aws/aws-sdk-go-v2#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/aws-sdk-go-v2#202)
  * Fixes [aws#286](aws/aws-sdk-go-v2#286)
* `aws`: Add example for custom HTTP client idle connection options ([aws#350](aws/aws-sdk-go-v2#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/aws-sdk-go-v2#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#2748](aws#2748)
* `aws/ec2rolecreds`: Fix security creds path to include trailing slash ([aws#356](aws/aws-sdk-go-v2#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/aws-sdk-go-v2#351)
* `service/dynamodb/expression`: Improved reporting of bad key conditions ([aws#360](aws/aws-sdk-go-v2#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
None yet
Projects
None yet
Development

No branches or pull requests

3 participants