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

Create temp REST API reference #766

Merged
merged 5 commits into from
Mar 15, 2024

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Feb 13, 2024

Addresses #754

Description

This pull request:

  • adds openapi.json
  • creates a static html file that generates the REST API using Swagger UI & openapi.json
  • Invokes the html file as an iframe in the docusaurus page

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

How to test

REST API Ref page preview: https://deploy-preview-766--kaleidoscopic-dango-0cf31d.netlify.app/conda-store/references/api
Static page preview: https://deploy-preview-766--kaleidoscopic-dango-0cf31d.netlify.app/rest-api.html

Copy link

netlify bot commented Feb 13, 2024

Deploy Preview for kaleidoscopic-dango-0cf31d ready!

Name Link
🔨 Latest commit 72deb65
🔍 Latest deploy log https://app.netlify.com/sites/kaleidoscopic-dango-0cf31d/deploys/65f34e1a3df8320008fcc779
😎 Deploy Preview https://deploy-preview-766--kaleidoscopic-dango-0cf31d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pavithraes pavithraes marked this pull request as ready for review February 13, 2024 17:27
@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation status: in progress 🏗 labels Feb 13, 2024
Copy link
Contributor

@dcmcand dcmcand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @pavithraes, how is this page generated? Does it need to be generated manually when API changes are made? If it isn't somehow automatic can we document how to generate it so that we know?

@pavithraes pavithraes mentioned this pull request Mar 14, 2024
3 tasks
@pavithraes
Copy link
Member Author

@dcmcand - Thanks for reviewing. The API docs are generated from openapi.json - I've opened #782 to auto-update the json file after each release. I think #782 unblocks us from merging this PR. :)

@pavithraes pavithraes merged commit 991c780 into conda-incubator:main Mar 15, 2024
19 checks passed
@pavithraes pavithraes deleted the rest-api-temp branch September 16, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

2 participants