spec-sync: track V2 spec drift - #140
Open
yzld2002 wants to merge 1 commit into
Open
Conversation
![spec-sync[bot]](https://github.githubassets.com/images/gravatars/gravatar-user-420.png){kind=avatar}
Contributor
There was a problem hiding this comment.
Pull request overview
Tracks V2 API specification drift and refreshes generated reference models.
Changes:
- Clarifies presigned output URL validity requirements.
- Documents DPT-3 Fast model support.
- Advertises form-urlencoded workflow requests, though the formal OpenAPI content schema is missing.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
specs/v2-aide.json |
Updates V2 API descriptions. |
specs/_generated/v2_models.py |
Regenerates model field descriptions. |
| "/v2/workflow": { | ||
| "post": { | ||
| "description": "Run synchronously and return the result inline.\n\nAccepts ``application/json`` (the request fields as the body) or\n``multipart/form-data`` (file fields are staged automatically).\n\nReturns **504** if the work does not finish within the wait\nwindow — long-running work belongs on the async ``POST\n{path}/jobs`` route, which returns 202 immediately and is polled\nvia ``GET {path}/jobs/{job_id}``. On a 504 the workflow is\nCANCELLED (a sync caller can never collect the result); a retry\nstarts the work over as a fresh job.", | ||
| "description": "Run synchronously and return the result inline.\n\nAccepts ``application/json`` (the request fields as the body),\n``multipart/form-data`` (file fields are staged automatically),\nor ``application/x-www-form-urlencoded`` (text fields only).\n\nReturns **504** if the work does not finish within the wait\nwindow — long-running work belongs on the async ``POST\n{path}/jobs`` route, which returns 202 immediately and is polled\nvia ``GET {path}/jobs/{job_id}``. On a 504 the workflow is\nCANCELLED (a sync caller can never collect the result); a retry\nstarts the work over as a fresh job.", |
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
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.
Automated V2 spec-sync PR (
client.v2).Gates (surface-lock, V2 contract tests, lint/test/typecheck) must pass. When present, the AI commit is a draft a human finishes (the V2 ergonomic layer — unified Job, dual-host, schema coercion — is not in the spec). Human review required before merge.
What changed
AI-generated from the PR diff — verify against the actual changes.
parse/parseasync job endpoints:output_save_urldocs clarified — presigned URL must remain valid until job completion (not just at submit), with a minimum validity window (default 15 min, plus ~3s/page foranalyze) enforced via 422 at submit time; no schema change.modelparameter (parse/analyze endpoints): doc-only update — now describes two model families,dpt-3-pro(highest quality) anddpt-3-fast(lower latency, no vision captioning), both supporting dated snapshots,-latestaliases, and bare family names./v2/workflow(spec-only, not part of SDK surface): description updated to note support forapplication/x-www-form-urlencodedin addition to JSON/multipart — not exposed via this SDK.