docs: docs: surface /runpod:migrate command for v1 REST and GraphQL migration - #806
Conversation
Add guidance pointing users to the Runpod skills plugin's /runpod:migrate command on the API v2 overview, the v1 REST and GraphQL deprecation notices, and the agent skills page.
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| 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> | ||
| If you have an existing REST v1 or GraphQL integration, run `/runpod:migrate` with the [Runpod skills plugin](/get-started/agent-skills#migrate-an-existing-integration) installed in your coding agent to migrate it to v2 automatically. See the [migration guide](/api-reference-v2/migrate-from-v1) for details. |
There was a problem hiding this comment.
Confirms /runpod:migrate with no scope argument defaults to scope "all", which migrates both REST v1 and GraphQL integrations to v2, matching the doc's claim that running the bare command migrates an existing REST v1 or GraphQL integration.
|
|
||
| <Warning> | ||
| REST API v1 is deprecated and will be retired on **November 15, 2026**. Migrate your integrations to REST API v2 before that date. See the [migration guide](/api-reference-v2/migrate-from-v1) to get started. | ||
| REST API v1 is deprecated and will be retired on **November 15, 2026**. Migrate your integrations to REST API v2 before that date. See the [migration guide](/api-reference-v2/migrate-from-v1) to get started. To migrate automatically, ask your coding agent to run `/runpod:migrate rest` once you've installed the [Runpod skills plugin](/get-started/agent-skills#migrate-an-existing-integration). |
There was a problem hiding this comment.
Confirms rest is a valid scope argument for /runpod:migrate that targets REST v1 only, matching the doc's claim that /runpod:migrate rest migrates the REST v1 integration.
|
|
||
| <Warning> | ||
| The GraphQL API is deprecated and will be retired in early 2027. For new integrations, use [REST API v2](/api-reference-v2/overview). | ||
| The GraphQL API is deprecated and will be retired in early 2027. For new integrations, use [REST API v2](/api-reference-v2/overview). To migrate automatically, ask your coding agent to run `/runpod:migrate graphql` once you've installed the [Runpod skills plugin](/get-started/agent-skills#migrate-an-existing-integration). |
There was a problem hiding this comment.
Confirms graphql is a valid scope argument for /runpod:migrate that targets the GraphQL API only, matching the doc's claim that /runpod:migrate graphql migrates the GraphQL integration.
| | **flash** | Writes and deploys your own Python code to Runpod Serverless using the [runpod-flash](/flash/overview) SDK. | | ||
| | **companion-clis** | Uses supporting CLIs such as Hugging Face, Docker, and the AWS CLI when a task needs them. | | ||
| | **runpod-usage** | Provides conceptual knowledge about Pods, Serverless, storage, and GPU selection. | | ||
| | **runpod-migrate** | Migrates a codebase from the GraphQL API or REST v1 to REST v2. It inventories which API each call site uses, rewrites the call sites, and verifies the result. | |
There was a problem hiding this comment.
Confirms the runpod-migrate skill's description: migrates a codebase from the GraphQL API or REST v1 to REST v2, inventorying which API version each call site uses, rewriting call sites, and verifying — matching the new table row.
|
|
||
| ## Migrate an existing integration | ||
|
|
||
| If you already have an integration built on the GraphQL API or REST v1, the `/runpod:migrate` command moves it to REST v2. It inventories which API version each part of your code uses, then rewrites the call sites, flags breaking changes, and verifies the result. It migrates one file at a time, with one commit per file. |
There was a problem hiding this comment.
Confirms the /runpod:migrate workflow inventories call sites, rewrites them, flags breaking changes, verifies the result, and migrates "one file per commit" (SKILL.md step 4 heading: "Migrate, one file per commit"), matching the section's description of the command's behavior.
| Because it edits and commits your code as it goes, run it on a feature branch and review each commit before you merge or deploy. | ||
|
|
||
| The command takes an optional scope and path: | ||
|
|
There was a problem hiding this comment.
Confirms the verbatim argument-hint for the /runpod:migrate command: "[scope: all | rest | graphql] [path]", matching the invocation syntax shown in the code block.
|
|
||
| ```bash | ||
| /runpod:migrate [scope: all | rest | graphql] [path] | ||
| ``` |
There was a problem hiding this comment.
Confirms scope defaults to "all" (both REST v1 and GraphQL) and path defaults to the current working directory when no arguments are given, matching the doc's explanation of scope/path defaults.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.) |
1 participant
Open in Promptless
Surfaces the Runpod skills plugin's
/runpod:migratecommand as the automated path off the two deprecated APIs (REST v1 and GraphQL) and onto REST v2, at the points where developers with an existing integration land.api-reference-v2/overview.mdx): adds a note telling readers with a v1 REST or GraphQL integration they can migrate automatically with/runpod:migrate.api-reference/overview.mdx): adds a sentence pointing to/runpod:migrate rest.sdks/graphql/configurations.mdx): adds a sentence pointing to/runpod:migrate graphql.get-started/agent-skills.mdx): adds arunpod-migraterow to the skills table and a new "Migrate an existing integration" section documenting the command syntax, scope/path arguments, a worked example, and a branch-and-review safety note.api-reference-v2/migrate-from-v1.mdx): adds a "Next steps" card so readers arriving directly discover the automated command.Trigger Events
/runpod:migrateto the runpod api v2 item and in the deprecation header of v1 and gql to...Tip: Worried about broken links? Ask Promptless to find and fix them automatically 🔗