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

API Documentation #154

Open
medic-code opened this issue Dec 4, 2022 · 1 comment
Open

API Documentation #154

medic-code opened this issue Dec 4, 2022 · 1 comment

Comments

@medic-code
Copy link
Contributor

I read somewhere in the PRs you were using Postman to test the API. Has API documentation been created ? Wondered if this is something you'd considered for contribution purposes, perhaps on a ask per request nature.

Postman seems like an obvious choice, particularly if you've already designed the API in postman using the OpenAPI 3.0 spec.

https://learning.postman.com/docs/publishing-your-api/documenting-your-api/#generating-api-documentation

@eamon0989
Copy link
Contributor

Unfortunately we do not currently have any API docs, we tried to design the endpoints to be easily readable, but of course, something like OpenAPI or Swagger would be a fantastic enhancement.

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