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

Provide documentationUrl for all operations on all APIs #2977

Closed
dchelimsky opened this issue Nov 25, 2019 · 1 comment
Closed

Provide documentationUrl for all operations on all APIs #2977

dchelimsky opened this issue Nov 25, 2019 · 1 comment
Labels
closed-for-staleness documentation This is a problem with documentation. feature-request A feature should be added or improved.

Comments

@dchelimsky
Copy link

Is your feature request related to a problem? Please describe.

I can only discover links to documentation for S3 operations via thedocumentationUrl of an operation (

property(this, 'documentationUrl', operation.documentationUrl);
). No other apis provide this.

Describe the solution you'd like

Add 'documentationUrl' for every operation on every API (e.g.

"documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html",
)

Describe alternatives you've considered

I've considered building a mechanical mapping of operations to their docs, but the URL paths are not consistent across APIs, e.g.

https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html
https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListUsers.html
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
https://docs.aws.amazon.com/lambda/latest/dg/API_ListFunctions.html
@github-actions
Copy link

Greetings! We’re closing this issue because it has been open a long time and hasn’t been updated in a while and may not be getting the attention it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to comment or open a new issue.

@github-actions github-actions bot added closing-soon This issue will automatically close in 4 days unless further comments are made. closed-for-staleness and removed closing-soon This issue will automatically close in 4 days unless further comments are made. labels Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed-for-staleness documentation This is a problem with documentation. feature-request A feature should be added or improved.
Projects
None yet
Development

No branches or pull requests

2 participants