Skip to content

Platform API docs 🤘 #560

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft

Platform API docs 🤘 #560

wants to merge 10 commits into from

Conversation

llewellyn-sl
Copy link
Contributor

@llewellyn-sl llewellyn-sl commented Apr 23, 2025 •
edited
Loading

New post-versioning PR

  • Adds docusaurus-openapi-docs plugin
  • Renders Platform API docs at /platform-api
  • Custom API docs sidebar, categorized by Platform entity

WIP:

  • Entity overview pages listing all relevant params, operation prerequisites, instructions for retrieving IDs, etc.
  • Seqera docs styling

@llewellyn-sl
Copy link
Contributor Author

@dana-seqera I've fixed the sidebar issues in this new PR. Deployment preview takes you to the API overview 👍

@netlify Netlify
Copy link

netlify bot commented Apr 23, 2025 •
edited
Loading

❌ Deploy Preview for seqera-docs failed. Why did it fail? →

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/seqera-docs/deploys/6811bdd3f31d2fe9c8146414

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrew-dawson-seqera andrew-dawson-seqera Awaiting requested review from andrew-dawson-seqera

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@llewellyn-sl