Skip to content

[Preview] OpenAPI spec from vast PR #5363 - #920

Closed
Gobind-Vast wants to merge 1 commit into
mainfrom
auto/openapi-preview-pr-5363
Closed

[Preview] OpenAPI spec from vast PR #5363#920
Gobind-Vast wants to merge 1 commit into
mainfrom
auto/openapi-preview-pr-5363

Conversation

@Gobind-Vast

@Gobind-Vast Gobind-Vast commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Automated preview of the OpenAPI spec from vast PR #5363.

Auto-generated split files are under api-reference/openapi/yaml/auto_*.yaml; openapi.yaml is the build.py-aggregated result.

Source commit: https://bitbucket.org/vastai/vast/commits/d05dbe118297e06687ebe0e6fb14465d8c2b8d69

Mintlify will deploy a preview — check the preview URL to verify the API reference renders correctly.


⚠️ Hand-curated docs review needed

Curated documentation lives in vast:scripts/openapi_overrides.json and is merged over the auto-generated spec on every regeneration. The checks below flag places where it may have drifted from the code.

Hand-curated endpoints whose handler code changed

The introspected parameter surface of these endpoints changed in this update, and they carry hand-curated documentation. Reviewers should verify the curated descriptions/schemas still match the implementation:

  • PUT /api/v0/commands/rsync/ — body params removed: dst_id, src_id

@mintlify

mintlify Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
vastai-80aa3a82 🟢 Ready View Preview Aug 7, 2026, 5:57 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@Gobind-Vast

Copy link
Copy Markdown
Collaborator Author

Closing: the OpenAPI docs-publishing pipeline steps have been removed from vastai/vast master (PR #5269, merged 2026-08-06), so this repo no longer receives auto-generated spec PRs.

This preview was still generated because Bitbucket reads bitbucket-pipelines.yml from a PR's source branch. vast PR #5363 branched before the removal landed, so its pipeline still carries the old step-openapi-docs-preview. Merging master into that branch will stop it.

Leaving the auto/openapi-preview-pr-5363 branch in place deliberately -- the step only opens a new PR when the preview branch does not exist. Keeping the branch means later pushes force-push to it and find no open PR, so no replacement is created. Deleting the branch would cause a fresh PR on the next push.

No documentation change is lost; the API reference is generated from the backend.

@Gobind-Vast Gobind-Vast closed this Aug 7, 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.

1 participant