docs: add upcoming breaking change notice to show instances endpoint#343
Open
guthrie-vast wants to merge 2 commits intovast-ai:masterfrom
Open
docs: add upcoming breaking change notice to show instances endpoint#343guthrie-vast wants to merge 2 commits intovast-ai:masterfrom
guthrie-vast wants to merge 2 commits intovast-ai:masterfrom
Conversation
Adds a prominent warning to the OpenAPI spec for GET /api/v0/instances/ noting that responses will soon be paginated with a maximum of 25 instances per request. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
openapi/yaml/show_instances.yaml
Outdated
| description: | | ||
| > ⚠️ **Upcoming Breaking Change:** This endpoint will soon return paginated results. | ||
| > Responses will be limited to a **maximum of 25 instances per request**. | ||
| > Update your API, CLI, and SDK integrations to handle pagination before this change takes effect. |
Contributor
There was a problem hiding this comment.
They need to know how to handle the pagination. We've standardized how you can do this in the repo, do customers have info on how to do this?
- Add show_instances_v1.yaml with keyset pagination, filtering, column selection, and sorting; tested against live API - Fix operator names: ne→neq, nin→notin; remove unsupported like/ilike - Fix default limit (5→25), add nullable to label and status_msg fields - Add 400 error response; document ports as running-instance-only - Mark v0 /api/v0/instances/ as deprecated, link to v1 replacement - Rebuild combined_api.yaml Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
stackanthony
approved these changes
Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
⚠️ Upcoming Breaking Changewarning to the OpenAPI spec forGET /api/v0/instances/Test plan
deprecated: trueflag is set (endpoint is not being removed, only behavior is changing)🤖 Generated with Claude Code