Generate REST API docs - Githubissues

conda-incubator / conda-store

Data science environments, for collaboration. ✨

https://conda.store

BSD 3-Clause "New" or "Revised" License

139 stars 45 forks source link

Generate REST API docs #702

Closed pavithraes closed 4 months ago

pavithraes commented 7 months ago

Addresses #561 Closes #754

Description

This pull request:

Pull request checklist

[ ] Did you test this change locally?
[ ] Did you update the documentation (if required)?
[ ] Did you add/update relevant tests for this change (if required)?

Additional information

TODO before merging

[ ] Write a gh action to make sure openapi.json and the rest api docs are automatically updates on each release.

netlify[bot] commented 7 months ago

Deploy Preview for kaleidoscopic-dango-0cf31d failed.

Name	Link
Latest commit	915beaaff7f409817896dad0cbd2625bccb328aa
Latest deploy log	https://app.netlify.com/sites/kaleidoscopic-dango-0cf31d/deploys/6597e7fc31d21100084908aa

pavithraes commented 6 months ago

The plugin we're using here is in the process of adding support for Docusaurus v3, ref: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/654

pavithraes commented 4 months ago

Closing this because we have a temporary solution in place, we can open a fresh PR later when unblocked. :)