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

Add input examples / OpenAPI spec #63

Closed
edoardottt opened this issue Feb 7, 2024 · 2 comments
Closed

Add input examples / OpenAPI spec #63

edoardottt opened this issue Feb 7, 2024 · 2 comments

Comments

@edoardottt
Copy link
Contributor

edoardottt commented Feb 7, 2024

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.

@edoardottt edoardottt changed the title Add input examples Add input examples / OpenAPI spec Feb 7, 2024
@sarnesjo
Copy link

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
Copy link
Contributor Author

understood, thanks for the answer

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

2 participants