docs(cloud): mark /api/history_v2 as deprecated, prefer /api/jobs#897
Open
MillerMedia wants to merge 1 commit intomainfrom
Open
docs(cloud): mark /api/history_v2 as deprecated, prefer /api/jobs#897MillerMedia wants to merge 1 commit intomainfrom
MillerMedia wants to merge 1 commit intomainfrom
Conversation
Add `deprecated: true` on both /api/history_v2 operations in the
OpenAPI spec so Mintlify renders a deprecation banner, and point
readers at /api/jobs and /api/jobs/{job_id} as replacements. The
prompt_id returned by /api/prompt is the same UUID as job_id, so
client code can swap the path without any other changes.
Update the complete-example snippets (EN + ZH) to fetch outputs via
/api/jobs/${prompt_id} instead of /api/history_v2/${prompt_id}. The
JobDetailResponse schema already exposes the same `outputs` field
the snippets read.
No runtime spec changes in the cloud repo — deprecation is docs-only
until a Linear ticket is filed for the full removal pass.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
/api/history_v2and/api/history_v2/{prompt_id}asdeprecated: trueinopenapi-cloud.yamlso Mintlify renders a deprecation banner, with descriptions pointing at/api/jobsand/api/jobs/{job_id}as replacements./api/jobs/${prompt_id}— theprompt_idreturned by/api/promptis literally the job UUID (services/ingest/server/implementation/prompt.go:392), andJobDetailResponse.outputshas the same shape the snippets were already reading.services/ingest/openapi.yamluntouched) — full deprecation/removal is tracked for a future Linear ticket under Core ↔ Cloud Catchup, following the BE-120/121 pattern.Notes for review
"will be removed in a future release; no removal date set") since there's no timeline yet.[\/api/jobs`](#tag/job/GET/api/jobs)`); worth a quick Mintlify preview check to confirm it renders as a link.Test plan
/api/history_v2and/api/history_v2/{prompt_id}/api/jobsand/api/jobs/{job_id}operationsprompt_id→/api/jobs/{prompt_id}returnsoutputs)snippets/zh/cloud/complete-example.mdx) renders consistently with the English version🤖 Generated with Claude Code