Restore platform create_deploy_key endpoint (#39909)

GitOrigin-RevId: dec9b715fac12b20738519470f3f2524a958a512

Author: thomasballinger

npm-packages/@convex-dev/platform/platform-openapi.json

@@ -170,6 +170,50 @@
         ]
       }
     },
+    "/deployments/{deployment_name}/create_deploy_key": {
+      "post": {
+        "summary": "Create deploy key",
+        "description": "Create a deploy key like \"dev:happy-animal-123|ey...\" which can be\nused with the Convex CLI to develop against or deploy code.\n\nWhen access to the deployment is granted through an OAuth token this\ndeploy key will use the same OAuth-granted token.\n\nWhen access to the deployment is granted any other way a new token will be\ncreated which grants access only to this deployment.",
+        "operationId": "create deploy key",
+        "parameters": [
+          {
+            "name": "deployment_name",
+            "in": "path",
+            "description": "Deployment name",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PlatformCreateDeployKeyArgs"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PlatformCreateDeployKeyResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "OAuth Project Token": [],
+            "OAuth Team Token": [],
+            "Team Token": []
+          }
+        ]
+      }
+    },
     "/token_details": {
       "get": {
         "summary": "Get token details",
@@ -199,6 +243,10 @@
   },
   "components": {
     "schemas": {
+      "AdminKey": {
+        "type": "string",
+        "description": "Encrypted admin key"
+      },
       "DeploymentType": {
         "type": "string",
         "enum": [
@@ -210,6 +258,31 @@
       "DeviceName": {
         "type": "string"
       },
+      "PlatformCreateDeployKeyArgs": {
+        "type": "object",
+        "required": [
+          "name"
+        ],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Name for the deploy key."
+          }
+        },
+        "additionalProperties": false
+      },
+      "PlatformCreateDeployKeyResponse": {
+        "type": "object",
+        "required": [
+          "deployKey"
+        ],
+        "properties": {
+          "deployKey": {
+            "$ref": "#/components/schemas/AdminKey",
+            "description": "The generated deploy key."
+          }
+        }
+      },
       "PlatformCreateProjectArgs": {
         "type": "object",
         "required": [

npm-packages/@convex-dev/platform/src/generatedApi.ts

@@ -84,6 +84,33 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/deployments/{deployment_name}/create_deploy_key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create deploy key
+         * @description Create a deploy key like "dev:happy-animal-123|ey..." which can be
+         *     used with the Convex CLI to develop against or deploy code.
+         *
+         *     When access to the deployment is granted through an OAuth token this
+         *     deploy key will use the same OAuth-granted token.
+         *
+         *     When access to the deployment is granted any other way a new token will be
+         *     created which grants access only to this deployment.
+         */
+        post: operations["create deploy key"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/token_details": {
         parameters: {
             query?: never;
@@ -110,9 +137,19 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /** @description Encrypted admin key */
+        AdminKey: string;
         /** @enum {string} */
         DeploymentType: "dev" | "prod" | "preview";
         DeviceName: string;
+        PlatformCreateDeployKeyArgs: {
+            /** @description Name for the deploy key. */
+            name: string;
+        };
+        PlatformCreateDeployKeyResponse: {
+            /** @description The generated deploy key. */
+            deployKey: components["schemas"]["AdminKey"];
+        };
         PlatformCreateProjectArgs: {
             /** @description Projects always include a deployment, so start this project off with a
              *     "dev" development deployment or a "prod" production deployment. */
@@ -199,8 +236,11 @@ export interface components {
     headers: never;
     pathItems: never;
 }
+export type AdminKey = components['schemas']['AdminKey'];
 export type DeploymentType = components['schemas']['DeploymentType'];
 export type DeviceName = components['schemas']['DeviceName'];
+export type PlatformCreateDeployKeyArgs = components['schemas']['PlatformCreateDeployKeyArgs'];
+export type PlatformCreateDeployKeyResponse = components['schemas']['PlatformCreateDeployKeyResponse'];
 export type PlatformCreateProjectArgs = components['schemas']['PlatformCreateProjectArgs'];
 export type PlatformCreateProjectResponse = components['schemas']['PlatformCreateProjectResponse'];
 export type PlatformDeploymentResponse = components['schemas']['PlatformDeploymentResponse'];
@@ -304,6 +344,32 @@ export interface operations {
             };
         };
     };
+    "create deploy key": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Deployment name */
+                deployment_name: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PlatformCreateDeployKeyArgs"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlatformCreateDeployKeyResponse"];
+                };
+            };
+        };
+    };
     "get token details": {
         parameters: {
             query?: never;

npm-packages/convex/scripts/build.py

@@ -122,8 +122,6 @@ def build_standalone_cli(temp_dir) -> None:
 
 
 def main() -> None:
-    # TODO -- fix lint error below (only shows up on flake8 v7.2.0)
-    global times  # noqa: F824
     t0 = time.time()
 
     global TEMP_DIR

npm-packages/docs/docs/platform-apis.mdx

@@ -68,6 +68,9 @@ The examples here assume you are working in a container with shell and file
 system access from which you can drive the app building process. You likely
 already have this if you're generating frontend code.
 
+Set [`CONVEX_DEPLOY_KEY`](/docs/cli/deploy-key-types.mdx) is the value returned
+by the [Create deploy key](/management-api/create-deploy-key) API.
+
 ### Pushing code to the dev Convex backend
 
 ```bash

npm-packages/docs/docs/platform-apis/embedded-dashboard.mdx

@@ -33,7 +33,8 @@ Required information for `postMessage`:
 - `deploymentName`: The readable identifier for the deployment. Returned when
   creating the project with the
   [Create project API](/management-api/create-project).
-- `adminKey`: A deploy key scoped to the specified `deploymentName`.
+- `adminKey`: A deploy key scoped to the specified `deploymentName`. Can be
+  retrieved with the [Create deploy key API](/management-api/create-deploy-key).
 
 Here's an example of the Convex dashboard embedded in a React application: