search

amzn / ads-advanced-tools-docs

Code samples and supplements for the Amazon Ads advanced tools center
https://advertising.amazon.com/API/docs/en-us/index
MIT No Attribution
96 stars 32 forks source link

Central repository for Advertising API OpenAPI specification files #84

Open jasonhebert opened 1 year ago

jasonhebert commented 1 year ago

Type of content [X] Advanced tools center documentation [ ] Amazon Ads API Postman collection [ ] Other

Describe the solution you'd like Add the Advertising API OpenAPI specification files to this repository.

Additional context We use the published OpenAPI specification files to generate a library allowing us to easily communicate with the Advertising API. We currently must scour the documentation site to locate the JSON/YAML specification files to use in our build process. Providing a central location here to host these files would ease development of third-party libraries, prevent incomplete library code due to missing/missed specifications, and provide an account of changes to theses specifications. PR's could also be submitted to correct inaccuracies and incorrect definitions within the specification files themselves when encountered.

Amazon already provides the OpenAPI specification files for the Selling Partner API (selling-partner-api-models). It would be of great benefit to many if the same were provided for the Advertising API.

Thank you in advance...

elizafarley commented 1 year ago

Hi @jasonhebert, thanks for submitting this feedback! I'm going to leave this ticket open while we evaluate the possibilities, and will follow up once we have more information.

jasonhebert commented 1 year ago

Thank you for the prompt response @elizafarley. Fingers crossed for a positive outcome and possibilities.

Much appreciated!

jasonhebert commented 1 year ago

Any chance that there's additional info on the possibility of this happening?

elizafarley commented 1 year ago

Hi @jasonhebert, we are still looking into whether it would be possible to post specs on GitHub.

In the meantime, we've put together a single page with download links to all the specs and associated tutorials. Would be interested to get your feedback if this is helpful or not.

ptaylor9999 commented 1 year ago

@jasonhebert we're also thinking about publishing a openAPI manifest to our developer portal - essentially a JSON file that includes metadata about the files themselves such as download URL, last update date, and a change log that describes which line numbers changed. Then you could wget the JSON manifest as part of your build process and pull down the latest openAPI specs similarly to how you would with a git pull. We would love to get your feedback on this as well. Thanks!

jasonhebert commented 1 year ago

This is a great step in the right direction and made things so much easier to find the spec files. Ultimately I'd also like a way to submit issues and pull requests against the spec files. There are a number of places where items are incorrectly typed, incomplete, or just wrong according to the specification.

What's been done, and is still being worked on, to help developers is great. Keep moving in this direction!!!

jasonhebert commented 7 months ago

Any traction on this request? Thanks...

iliaaz commented 6 months ago

Hi there! This is a great idea - we would love to be able to contribute corrections to the schema.