google / deps.dev

Resources for the deps.dev API
https://deps.dev
Apache License 2.0
258 stars 20 forks source link

Add input examples / OpenAPI spec #63

Closed edoardottt closed 8 months ago

edoardottt commented 9 months ago

It would be cool to have a list of input that provides the full responses for the API.
This could be a test for the clients using the API to check if everything is working correctly.
So non only something like @colors/colors

Just to be clear, an OpenAPI specification could help, by a lot.

sarnesjo commented 8 months ago

I'm not quite sure what your feature request is. :)

There are already examples of requests in the API documentation, as well as more fleshed-out client examples in the examples directory of this repo. We can't include expected responses, as those change over time. For instance, GetPackage includes additional versions as they're released, GetVersion includes advisories as they're published, etc.

For discussion around an OpenAPI definition, please see #5.

edoardottt commented 8 months ago

understood, thanks for the answer