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

(Feature request) Link to AWS API docs from cognitect.aws.client.api/doc ? #108

Closed
jffry opened this issue Nov 25, 2019 · 4 comments
Closed
Labels
enhancement New feature or request

Comments

@jffry
Copy link

jffry commented Nov 25, 2019

Description

AWS has usually-helpful API documentation outlining the purpose of API docs, and the meaning of (and caveats for) request/response values - for example, https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html

Is that link knowable/constructable from the underlying data that drives this library's description of available operations? If so, that could be a helpful addition to cognitect.aws.client.api/doc , a la:

(require '[cognitect.aws.client.api :as aws])
(def s3 (aws/client {:api :s3}))
(aws/doc s3 :PutObject)

;=> -------------------------
;=> PutObject
;=> 
;=> Adds an object to a bucket.
;=> https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
;=> 
;=> -------------------------
;=> Request
;=> ...
@dchelimsky dchelimsky added the enhancement New feature or request label Nov 25, 2019
@dchelimsky
Copy link
Contributor

I would love this feature myself!

Unfortunately the URLs are not provided in the data from which we build services (https://github.com/aws/aws-sdk-js/tree/master/apis), nor is there is consistency in the URLs across services, 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

The filenames appear consistent, but the paths do not.

@dchelimsky
Copy link
Contributor

Actually, the service data for s3 does include documentationUrls for its operations, but that's the only one. I've updated the api/doc-str (used by api/doc) to present the documentationUrl when available.

I've also added an issue to the aws-sdk-js project requesting documentationUrl be added for every op on every service. As that is addressed, we'll see the docs appear in aws-api for other services.

@jffry
Copy link
Author

jffry commented Nov 25, 2019

Bummer, but hopefully upstream will add that everywhere. Thanks!

@dchelimsky
Copy link
Contributor

Partial fix released in 0.8.408

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants