Skip to content

Comments

Edit instructions for updating API docs#982

Closed
tcrespog wants to merge 2 commits intomasterfrom
task/PLAT-4367-api-docs-sdk-fix
Closed

Edit instructions for updating API docs#982
tcrespog wants to merge 2 commits intomasterfrom
task/PLAT-4367-api-docs-sdk-fix

Conversation

@tcrespog
Copy link
Contributor

@tcrespog tcrespog commented Dec 22, 2025

Closes PLAT-4367.

Once the PR that applies some tweaks to the OpenAPI specs to fix the SDK generation is merged (https://github.com/seqeralabs/platform/pull/9831), the API docs should use the seqera-api-latest-flattened.yml version of the specs, as seqera-api-latest.yml contains recursive references that might not be accepted by the docusaurus-openapi-docs tool.

@netlify
Copy link

netlify bot commented Dec 22, 2025

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit b3fce45
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/695e6269a4ab6e0008db25bc
😎 Deploy Preview https://deploy-preview-982--seqera-docs.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 project configuration.

@llewellyn-sl
Copy link
Contributor

Thanks @tcrespog ! Note that the OpenAPI docs process is changing with some automation workflows being introduced in #965 . But I'll update the workflows to retrieve the flattened spec rather than *-latest.yml 👍

@tcrespog
Copy link
Contributor Author

tcrespog commented Jan 8, 2026

PR https://github.com/seqeralabs/platform/pull/9831 merged. Closing this PR, as the relevant changes were already applied in master.

@tcrespog tcrespog closed this Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants