Skip to content

REST v1 retirement — deprecation notice and page removal (DOCS-608) - #965

Open
promptless[bot] wants to merge 9 commits into
mainfrom
promptless/docs-608-rest-v1-retirement
Open

promptless[bot] wants to merge 9 commits into
mainfrom
promptless/docs-608-rest-v1-retirement

Conversation

@promptless

@promptless promptless Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

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

  • Removes the API v1 tab from the navigation. The GraphQL API navigation group (sdks/graphql/configurations, manage-pods, manage-pod-templates, manage-endpoints, and references/graphql-spec) is unchanged.
  • Deletes the 38 REST v1 page files under api-reference/. The validate-redirect-sources.js check 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.json is kept.
  • Adds redirects from /api-reference/overview and every other /api-reference/* path to /api-reference-v2/overview.
  • Adds a "REST API v1 is deprecated and no longer available." line to the note at the top of the API v2 overview.
  • Adds a November 2026 release notes accordion with a "REST API v1 retired" Breaking entry, and moves defaultOpen from October to November.
  • Removes the Transformer Lab integration guide (integrations/transformer-lab) from the Integrations > Guides navigation, deletes the page, and redirects /integrations/transformer-lab to /integrations/overview, as requested in review.

Verification

  • docs.json parses as valid JSON; the remaining tabs are Docs, Examples, Community, CLI, API v2, Models, and Release notes.
  • node scripts/validate-redirect-sources.js and node scripts/validate-tooltips.js pass locally.

Trigger Events

@mintlify

mintlify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Nov 13, 2026, 12:00 AM

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

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

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.

lavanya-gunreddi and others added 3 commits November 12, 2026 11:45
Updated breaking changes for REST API v1 and GraphQL API deprecation.
Comment thread api-reference-v2/overview.mdx Outdated
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

@Promptless docs.json
Restore the sdks/graphql group to the sidebar navigation exactly as it was before. It should include all 4 pages: configurations, manage-pods, manage-pod-templates, manage-endpoints.

Remove this redirect:

json
{ "source": "/sdks/graphql/:slug*", "destination": "/api-reference-v2/overview" }

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

Thanks, I'm on it. I'll restore the sdks/graphql sidebar group with all four pages and remove the /sdks/graphql/:slug* redirect from docs.json, then reply here when the update is pushed.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

@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
The Breaking entry title currently reads:

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.

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

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.

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

Quick update: this branch had deleted the four sdks/graphql pages, so I'm restoring them from main along with the sidebar group. That way the restored nav entries point to real pages instead of 404s.

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

Done. In docs.json, the GraphQL API sidebar group is back in its original position and matches main line for line. It includes configurations, manage-pods, manage-pod-templates, and manage-endpoints, plus the references/graphql-spec page that was also in the original group. The /sdks/graphql/:slug* → /api-reference-v2/overview redirect is removed, and the docs.json diff touches only those two blocks.

This branch had deleted the four sdks/graphql pages, so I restored them unchanged from main so the sidebar links resolve.

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

Done. The note in api-reference-v2/overview.mdx reads "REST API v1 is deprecated and no longer available."

In release-notes.mdx, the November 15, 2026 Breaking entry is titled "REST API v1 retired". Before this change, the title read "REST API v1 and the GraphQL API are deprecated and no longer available." rather than the wording quoted in your comment. The entry description didn't mention GraphQL or api.runpod.io/graphql, so I left it unchanged. All REST API v1 changes are as they were.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

@Promptless Remove the Transformer Lab page from the docs and add a redirect to the integrations overview.

docs.json
Remove integrations/transformer-lab from the sidebar navigation.

Add this redirect:

json
{ "source": "/integrations/transformer-lab", "destination": "/integrations/overview" }

@promptless

promptless Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

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.

@promptless

promptless Bot commented Nov 13, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

I removed the Transformer Lab page, took integrations/transformer-lab out of the sidebar navigation in docs.json, and added the redirect from /integrations/transformer-lab to /integrations/overview. All three changes are on this PR.

No other page in the docs repo linked to Transformer Lab, and it didn't use any images or snippets that also need removing. docs.json is still valid JSON, and the repo's redirect and tooltip validation scripts pass. I didn't run a full Mintlify build.

This branch was successfully deployed

1 active deployment
staging — 954d8794 Deployed Nov 13, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants