Skip to content

Commit 559a9ff

Browse files
thomasballingerConvex, Inc.
authored andcommitted
Remove buggy create deploy key endpoint (#39901)
GitOrigin-RevId: 08041a47c69372eade4123176a151089a7d1c62c
1 parent f66d617 commit 559a9ff

File tree

4 files changed

+1
-144
lines changed

4 files changed

+1
-144
lines changed

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

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -170,50 +170,6 @@
170170
]
171171
}
172172
},
173-
"/deployments/{deployment_name}/create_deploy_key": {
174-
"post": {
175-
"summary": "Create deploy key",
176-
"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 because token derivation\nhas not been implemented. When access to the deployment is granted any\nother way a new token will be created which grants access only to this\ndeployment.",
177-
"operationId": "create deploy key",
178-
"parameters": [
179-
{
180-
"name": "deployment_name",
181-
"in": "path",
182-
"description": "Deployment name",
183-
"required": true
184-
}
185-
],
186-
"requestBody": {
187-
"content": {
188-
"application/json": {
189-
"schema": {
190-
"$ref": "#/components/schemas/PlatformCreateDeployKeyArgs"
191-
}
192-
}
193-
},
194-
"required": true
195-
},
196-
"responses": {
197-
"200": {
198-
"description": "",
199-
"content": {
200-
"application/json": {
201-
"schema": {
202-
"$ref": "#/components/schemas/PlatformCreateDeployKeyResponse"
203-
}
204-
}
205-
}
206-
}
207-
},
208-
"security": [
209-
{
210-
"OAuth Project Token": [],
211-
"OAuth Team Token": [],
212-
"Team Token": []
213-
}
214-
]
215-
}
216-
},
217173
"/token_details": {
218174
"get": {
219175
"summary": "Get token details",
@@ -243,10 +199,6 @@
243199
},
244200
"components": {
245201
"schemas": {
246-
"AdminKey": {
247-
"type": "string",
248-
"description": "Encrypted admin key"
249-
},
250202
"DeploymentType": {
251203
"type": "string",
252204
"enum": [
@@ -258,31 +210,6 @@
258210
"DeviceName": {
259211
"type": "string"
260212
},
261-
"PlatformCreateDeployKeyArgs": {
262-
"type": "object",
263-
"required": [
264-
"name"
265-
],
266-
"properties": {
267-
"name": {
268-
"type": "string",
269-
"description": "Name for the deploy key."
270-
}
271-
},
272-
"additionalProperties": false
273-
},
274-
"PlatformCreateDeployKeyResponse": {
275-
"type": "object",
276-
"required": [
277-
"deployKey"
278-
],
279-
"properties": {
280-
"deployKey": {
281-
"$ref": "#/components/schemas/AdminKey",
282-
"description": "The generated deploy key."
283-
}
284-
}
285-
},
286213
"PlatformCreateProjectArgs": {
287214
"type": "object",
288215
"required": [

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

Lines changed: 0 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -84,33 +84,6 @@ export interface paths {
8484
patch?: never;
8585
trace?: never;
8686
};
87-
"/deployments/{deployment_name}/create_deploy_key": {
88-
parameters: {
89-
query?: never;
90-
header?: never;
91-
path?: never;
92-
cookie?: never;
93-
};
94-
get?: never;
95-
put?: never;
96-
/**
97-
* Create deploy key
98-
* @description Create a deploy key like "dev:happy-animal-123|ey..." which can be
99-
* used with the Convex CLI to develop against or deploy code.
100-
*
101-
* When access to the deployment is granted through an OAuth token this
102-
* deploy key will use the same OAuth-granted token because token derivation
103-
* has not been implemented. When access to the deployment is granted any
104-
* other way a new token will be created which grants access only to this
105-
* deployment.
106-
*/
107-
post: operations["create deploy key"];
108-
delete?: never;
109-
options?: never;
110-
head?: never;
111-
patch?: never;
112-
trace?: never;
113-
};
11487
"/token_details": {
11588
parameters: {
11689
query?: never;
@@ -137,19 +110,9 @@ export interface paths {
137110
export type webhooks = Record<string, never>;
138111
export interface components {
139112
schemas: {
140-
/** @description Encrypted admin key */
141-
AdminKey: string;
142113
/** @enum {string} */
143114
DeploymentType: "dev" | "prod" | "preview";
144115
DeviceName: string;
145-
PlatformCreateDeployKeyArgs: {
146-
/** @description Name for the deploy key. */
147-
name: string;
148-
};
149-
PlatformCreateDeployKeyResponse: {
150-
/** @description The generated deploy key. */
151-
deployKey: components["schemas"]["AdminKey"];
152-
};
153116
PlatformCreateProjectArgs: {
154117
/** @description Projects always include a deployment, so start this project off with a
155118
* "dev" development deployment or a "prod" production deployment. */
@@ -236,11 +199,8 @@ export interface components {
236199
headers: never;
237200
pathItems: never;
238201
}
239-
export type AdminKey = components['schemas']['AdminKey'];
240202
export type DeploymentType = components['schemas']['DeploymentType'];
241203
export type DeviceName = components['schemas']['DeviceName'];
242-
export type PlatformCreateDeployKeyArgs = components['schemas']['PlatformCreateDeployKeyArgs'];
243-
export type PlatformCreateDeployKeyResponse = components['schemas']['PlatformCreateDeployKeyResponse'];
244204
export type PlatformCreateProjectArgs = components['schemas']['PlatformCreateProjectArgs'];
245205
export type PlatformCreateProjectResponse = components['schemas']['PlatformCreateProjectResponse'];
246206
export type PlatformDeploymentResponse = components['schemas']['PlatformDeploymentResponse'];
@@ -344,32 +304,6 @@ export interface operations {
344304
};
345305
};
346306
};
347-
"create deploy key": {
348-
parameters: {
349-
query?: never;
350-
header?: never;
351-
path: {
352-
/** @description Deployment name */
353-
deployment_name: string;
354-
};
355-
cookie?: never;
356-
};
357-
requestBody: {
358-
content: {
359-
"application/json": components["schemas"]["PlatformCreateDeployKeyArgs"];
360-
};
361-
};
362-
responses: {
363-
200: {
364-
headers: {
365-
[name: string]: unknown;
366-
};
367-
content: {
368-
"application/json": components["schemas"]["PlatformCreateDeployKeyResponse"];
369-
};
370-
};
371-
};
372-
};
373307
"get token details": {
374308
parameters: {
375309
query?: never;

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,6 @@ The examples here assume you are working in a container with shell and file
6868
system access from which you can drive the app building process. You likely
6969
already have this if you're generating frontend code.
7070

71-
Set [`CONVEX_DEPLOY_KEY`](/docs/cli/deploy-key-types.mdx) is the value returned
72-
by the [Create deploy key](/management-api/create-deploy-key) API.
73-
7471
### Pushing code to the dev Convex backend
7572

7673
```bash

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ Required information for `postMessage`:
3333
- `deploymentName`: The readable identifier for the deployment. Returned when
3434
creating the project with the
3535
[Create project API](/management-api/create-project).
36-
- `adminKey`: A deploy key scoped to the specified `deploymentName`. Can be
37-
retrieved with the [Create deploy key API](/management-api/create-deploy-key).
36+
- `adminKey`: A deploy key scoped to the specified `deploymentName`.
3837

3938
Here's an example of the Convex dashboard embedded in a React application:
4039

0 commit comments

Comments
 (0)