-
Notifications
You must be signed in to change notification settings - Fork 46
docs: docs: surface /runpod:migrate command for v1 REST and GraphQL migration #806
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ description: "Use the Runpod API to programmatically manage your compute resourc | |
| The Runpod REST API v1 provides programmatic access to all Runpod compute resources. Integrate GPU infrastructure into your applications, workflows, and automation systems. | ||
|
|
||
| <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). | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Confirms |
||
| </Warning> | ||
|
|
||
| ## Available resources | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,6 +57,7 @@ The plugin installs a router and a set of focused skills: | |
| | **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. | | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
|
|
||
| The plugin also includes a collection of worked, end-to-end reference tasks, such as deploying a Whisper endpoint or running a model on a Pod, that guide your agent through common workflows. | ||
|
|
||
|
|
@@ -75,6 +76,26 @@ Once installed, you can ask your agent to perform tasks like the following: | |
| | Deploy with Flash | "Deploy this function to a remote GPU with Flash" | | ||
| | Local development | "Start a local dev server with Flash" | | ||
|
|
||
| ## 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. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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: | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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] | ||
| ``` | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
|
|
||
| `scope` defaults to `all`, which covers both REST v1 and GraphQL. Use `rest` to target REST v1 only, or `graphql` to target GraphQL only. `path` defaults to the current directory. For example, to migrate only the REST v1 code under `src/`: | ||
|
|
||
| ```bash | ||
| /runpod:migrate rest src/ | ||
| ``` | ||
|
|
||
| Running the command requires the Runpod skills plugin installed in your coding agent (see [Quick start](#quick-start)). For a manual walkthrough of the API changes, see the [migration guide](/api-reference-v2/migrate-from-v1). | ||
|
|
||
| ## Native install options | ||
|
|
||
| The `npx skills add` command above works everywhere. If you'd rather install the plugin through your agent's native marketplace, use the route for your agent below. Each route installs the same router and skills. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ Use the GraphQL API to manage Pods, templates, and Serverless endpoints through | |
| All requests go to `https://api.runpod.io/graphql` with your API key included as a query parameter. For the complete schema including all available queries, mutations, fields, and inputs, see the [GraphQL Spec](https://graphql-spec.runpod.io/). | ||
|
|
||
| <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). | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Confirms |
||
| </Warning> | ||
|
|
||
| ## Quick start | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/commands/migrate.md#L3