From 9974787df618cf9e2123bdb0ae81d361a8a82e76 Mon Sep 17 00:00:00 2001 From: Andrew Nguonly Date: Fri, 10 Jan 2025 15:16:48 -0800 Subject: [PATCH] docs: Add API docs for `POST /v1/projects/{project_id}/revisions/{revision_id}/deploy` endpoint (#2994) --- .../reference/api/openapi_control_plane.json | 113 ++++++++++++++---- 1 file changed, 88 insertions(+), 25 deletions(-) diff --git a/docs/docs/cloud/reference/api/openapi_control_plane.json b/docs/docs/cloud/reference/api/openapi_control_plane.json index 80e57c53f..646ca09b6 100644 --- a/docs/docs/cloud/reference/api/openapi_control_plane.json +++ b/docs/docs/cloud/reference/api/openapi_control_plane.json @@ -279,6 +279,58 @@ } } }, + "/v1/projects/{project_id}/revisions/{revision_id}/deploy": { + "post": { + "tags": ["Revisions (v1)"], + "summary": "Deploy Revision", + "description": "Deploy revision by ID.\n\nThis endpoint redeploys the deployment of a revision without rebuilding the image for the deployment. Redeploying the deployment of a revision may mitigate intermittent issues with a deployment.\n\nThe revision must be in the `DEPLOYED` status and must be the latest revision of the project.", + "operationId": "deploy_revision_projects__project_id__revisions__revision_id__deploy_post", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Project ID" + }, + "name": "project_id", + "in": "path" + }, + { + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Revision ID" + }, + "name": "revision_id", + "in": "path" + } + ], + "responses": { + "400": { + "description": "Revision is not in DEPLOYED status or revision is not the latest revision for the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Revision not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, "/v1/projects/{project_id}/revisions/{revision_id}/interrupt": { "post": { "tags": ["Revisions (v1)"], @@ -319,31 +371,6 @@ } }, "schemas": { - "EnvVar": { - "type": "object", - "description": "An environment variable or secret.", - "properties": { - "name": { - "type": "string", - "description": "Environment variable or secret name.", - "required": true - }, - "value": { - "type": "string", - "description": "Environment variable or secret value.", - "required": true - }, - "type": { - "type": "string", - "enum": [ - "default", - "secret" - ], - "description": "Field to designate type of the environment variable (default) or secret.", - "required": true - } - } - }, "ContainerSpec": { "type": "object", "description": "Container specification for a revision's deployment.\n\nIf any field is omitted or set to `null`, the internal default value is used depending on the deployment type (`dev` or `prod`).", @@ -404,6 +431,42 @@ } } }, + "EnvVar": { + "type": "object", + "description": "An environment variable or secret.", + "properties": { + "name": { + "type": "string", + "description": "Environment variable or secret name.", + "required": true + }, + "value": { + "type": "string", + "description": "Environment variable or secret value.", + "required": true + }, + "type": { + "type": "string", + "enum": [ + "default", + "secret" + ], + "description": "Field to designate type of the environment variable (default) or secret.", + "required": true + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "detail": { + "type": "string", + "description": "Error details.", + "required": true + } + } + }, "Project": { "type": "object", "description": "A project corresponds to a LangGraph Server deployment and the associated LangSmith tracing project.",