You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, no API docs are published, you'd have to read the code to see what are the endpoints and what do they do.
This adds an /api-doc endpoint to the server that will serve an openapi schema for all of our endpoints automatically.
It might be useful as well to take that yaml/json from that endpoint and generate some documentation in markdown/html and check-them on the repository or somewhere else.
The text was updated successfully, but these errors were encountered:
We have written documentation on our Confluence as well, we can use it for descriptions, etc. We should look into integrating these docs within the /api-doc endpoint.
We have written documentation on our Confluence as well, we can use it for descriptions, etc. We should look into integrating these docs within the /api-doc endpoint.
Also, some link to our academic research perhaps? I am thinking that we could add a README.md like this, that gives information about the org.
Currently, no API docs are published, you'd have to read the code to see what are the endpoints and what do they do.
This adds an
/api-doc
endpoint to the server that will serve an openapi schema for all of our endpoints automatically.It might be useful as well to take that yaml/json from that endpoint and generate some documentation in markdown/html and check-them on the repository or somewhere else.
The text was updated successfully, but these errors were encountered: