Repository navigation
REST v1 retirement — deprecation notice and page removal (DOCS-608) - #965
promptless[bot] wants to merge 9 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed. |
…edirect (DOCS-608)
Updated breaking changes for REST API v1 and GraphQL API deprecation.
| The Runpod REST API v2 provides programmatic access to your Runpod resources over standard HTTP. Use it to create and manage Pods, query Serverless endpoints, provision storage, and retrieve billing data — without using the console. | ||
|
|
||
| <Note> | ||
| REST API v1 and the GraphQL API are deprecated and no longer available. |
There was a problem hiding this comment.
not sure how strong of wording we want for graphql - it is still available-but-deprecated. rest v1 is the only one we're shutting down next week.
|
@Promptless docs.json Remove this redirect: json |
|
In reply to this discussion Thanks, I'm on it. I'll restore the |
|
@Promptless The line added before the migration note currently reads: REST API v1 and the GraphQL API are deprecated and no longer available. Change it back to: REST API v1 is deprecated and no longer available. release-notes.mdx REST API v1 and GraphQL API retired Change it back to: REST API v1 retired Also remove any mention of GraphQL (api.runpod.io/graphql) from the entry description. No other changes. The REST API v1 changes stay as-is. |
|
In reply to this discussion Thanks, I'm on it. I'll change the deprecation line back to "REST API v1 is deprecated and no longer available.", rename the release notes entry to "REST API v1 retired", and remove the GraphQL mention from its description. The REST API v1 changes will stay as they are. I'll reply here once the update is pushed. |
|
In reply to this discussion Quick update: this branch had deleted the four |
|
In reply to this discussion Done. In This branch had deleted the four |
|
In reply to this discussion Done. The note in In |
|
@Promptless Remove the Transformer Lab page from the docs and add a redirect to the integrations overview. docs.json Add this redirect: json |
|
In reply to this discussion I'll remove the Transformer Lab page, take integrations/transformer-lab out of the docs.json navigation, and add the redirect to /integrations/overview. I'll update this pull request and reply here when the change is pushed. |
…grations overview (DOCS-608)
|
In reply to this discussion I removed the Transformer Lab page, took No other page in the docs repo linked to Transformer Lab, and it didn't use any images or snippets that also need removing. |
Open in Promptless
REST API v1 is being retired on November 15, 2026, so this change removes the v1 reference pages from the docs and points readers to REST API v2 (DOCS-608). The GraphQL API docs stay in place.
Changes
sdks/graphql/configurations,manage-pods,manage-pod-templates,manage-endpoints, andreferences/graphql-spec) is unchanged.api-reference/. Thevalidate-redirect-sources.jscheck fails when a redirect source still has a page file, so the pages have to go for the new redirects to pass.api-reference/openapi.jsonis kept./api-reference/overviewand every other/api-reference/*path to/api-reference-v2/overview.defaultOpenfrom October to November.integrations/transformer-lab) from the Integrations > Guides navigation, deletes the page, and redirects/integrations/transformer-labto/integrations/overview, as requested in review.Verification
docs.jsonparses as valid JSON; the remaining tabs are Docs, Examples, Community, CLI, API v2, Models, and Release notes.node scripts/validate-redirect-sources.jsandnode scripts/validate-tooltips.jspass locally.Trigger Events