Skip to content

Commit d041466

Browse files
atrakhConvex, Inc.
authored andcommitted
Allow passing deployment names OR deployment ids to the "Get deployment" api endpoint (#37509)
GitOrigin-RevId: a6f7149782beabcc7ab8ad4ed8eb5c547fac23db
1 parent afa5a59 commit d041466

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

npm-packages/dashboard/dashboard-openapi.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1424,10 +1424,10 @@
14241424
{
14251425
"name": "deployment_id",
14261426
"in": "path",
1427-
"description": "",
1427+
"description": "Can be a deployment's id (integer) or name (string)",
14281428
"required": true,
14291429
"schema": {
1430-
"$ref": "#/components/schemas/DeploymentId"
1430+
"type": "string"
14311431
}
14321432
}
14331433
],

npm-packages/dashboard/src/api/deployments.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,15 @@ export function useProvisionDeployment(projectId: number) {
7474
});
7575
}
7676

77-
export function useDeploymentById(teamId: number, deploymentId?: number) {
77+
export function useDeploymentById(
78+
teamId: number,
79+
deploymentId?: number | string,
80+
) {
7881
const { data: deployment } = useBBQuery({
7982
path: "/teams/{team_id}/deployments/{deployment_id}",
8083
pathParams: {
8184
team_id: teamId,
82-
deployment_id: deploymentId || 0,
85+
deployment_id: deploymentId?.toString() || "",
8386
},
8487
});
8588

npm-packages/dashboard/src/generatedApi.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3421,7 +3421,8 @@ export interface operations {
34213421
header?: never;
34223422
path: {
34233423
team_id: components["schemas"]["TeamId"];
3424-
deployment_id: components["schemas"]["DeploymentId"];
3424+
/** @description Can be a deployment's id (integer) or name (string) */
3425+
deployment_id: string;
34253426
};
34263427
cookie?: never;
34273428
};

0 commit comments

Comments
 (0)