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

Generate REST API docs #702

Closed
wants to merge 3 commits into from

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Dec 12, 2023

Addresses #561
Closes #754

Description

This pull request:

  • a
  • b
  • c

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.

Copy link

netlify bot commented Dec 12, 2023

Deploy Preview for kaleidoscopic-dango-0cf31d failed.

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

@pavithraes
Copy link
Member Author

pavithraes commented Jan 5, 2024

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 pavithraes self-assigned this Jan 9, 2024
@pavithraes
Copy link
Member Author

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

@pavithraes pavithraes closed this Mar 19, 2024
@pavithraes pavithraes deleted the rest-api-docs branch September 16, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

Reference - Update REST API docs
1 participant