From 1b5f55319cd4fb1733400fe7b99377b313e6b462 Mon Sep 17 00:00:00 2001 From: elinamirnaya <20165953+elinamirnaya@users.noreply.github.com> Date: Mon, 13 Apr 2026 20:42:09 +0000 Subject: [PATCH] docs: OpenAPI spec version upgraded from 1.8.0 to 1.8.4 --- docs/openapi/openapi.json | 736 ++++++++++++++++++++++++++++++-------- 1 file changed, 583 insertions(+), 153 deletions(-) diff --git a/docs/openapi/openapi.json b/docs/openapi/openapi.json index 524cb40f7c2c..60b36a8ae50a 100644 --- a/docs/openapi/openapi.json +++ b/docs/openapi/openapi.json @@ -2,99 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Langflow", - "version": "1.8.0" - }, - "$defs": { - "ComponentOutput": { - "description": "Component output schema.", - "properties": { - "type": { - "description": "Type of the component output (e.g., 'message', 'data', 'tool', 'text')", - "title": "Type", - "type": "string" - }, - "status": { - "$ref": "#/$defs/JobStatus" - }, - "content": { - "anyOf": [ - {}, - { - "type": "null" - } - ], - "title": "Content" - }, - "metadata": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Metadata" - } - }, - "required": [ - "type", - "status" - ], - "title": "ComponentOutput", - "type": "object" - }, - "ErrorDetail": { - "description": "Error detail schema.", - "properties": { - "error": { - "title": "Error", - "type": "string" - }, - "code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Code" - }, - "details": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Details" - } - }, - "required": [ - "error" - ], - "title": "ErrorDetail", - "type": "object" - }, - "JobStatus": { - "description": "Job execution status.", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "cancelled", - "timed_out" - ], - "title": "JobStatus", - "type": "string" - } + "version": "1.8.4" }, "paths": { "/api/v1/build/{flow_id}/flow": { @@ -466,6 +374,99 @@ } } }, + "/api/v1/build_public_tmp/{job_id}/events": { + "get": { + "tags": [ + "Chat" + ], + "summary": "Get Build Events Public", + "description": "Get events for a public flow build job.

This endpoint does not require authentication, matching the public build endpoint.
It is used by the shareable playground to consume build events.", + "operationId": "get_build_events_public_api_v1_build_public_tmp__job_id__events_get", + "parameters": [ + { + "name": "job_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Job Id" + } + }, + { + "name": "event_delivery", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/EventDeliveryType", + "default": "streaming" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/api/v1/build_public_tmp/{job_id}/cancel": { + "post": { + "tags": [ + "Chat" + ], + "summary": "Cancel Build Public", + "description": "Cancel a public flow build job.

This endpoint does not require authentication, matching the public build endpoint.
It is used by the shareable playground to cancel builds.", + "operationId": "cancel_build_public_api_v1_build_public_tmp__job_id__cancel_post", + "parameters": [ + { + "name": "job_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Job Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelFlowResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/api/v1/all": { "get": { "tags": [ @@ -3595,7 +3596,7 @@ ], "summary": "Handle Streamable Http", "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", - "operationId": "handle_streamable_http_api_v1_mcp_streamable_delete", + "operationId": "handle_streamable_http_api_v1_mcp_streamable_post", "responses": { "200": { "description": "Successful Response" @@ -3619,7 +3620,7 @@ ], "summary": "Handle Streamable Http", "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", - "operationId": "handle_streamable_http_api_v1_mcp_streamable_delete", + "operationId": "handle_streamable_http_api_v1_mcp_streamable_post", "responses": { "200": { "description": "Successful Response" @@ -3643,7 +3644,7 @@ ], "summary": "Handle Streamable Http", "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", - "operationId": "handle_streamable_http_api_v1_mcp_streamable_delete", + "operationId": "handle_streamable_http_api_v1_mcp_streamable_post", "responses": { "200": { "description": "Successful Response" @@ -3679,6 +3680,80 @@ } } }, + "/api/v1/mcp/streamable/": { + "get": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_v1_mcp_streamable__post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "post": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_v1_mcp_streamable__post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "delete": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_v1_mcp_streamable__post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + } + }, "/api/v1/mcp/project/{project_id}": { "get": { "tags": [ @@ -4009,13 +4084,13 @@ } } }, - "delete": { + "post": { "tags": [ "mcp_projects" ], "summary": "Handle Project Streamable Http", "description": "Handle Streamable HTTP connections for a specific project.", - "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_delete", + "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post", "parameters": [ { "name": "project_id", @@ -4044,13 +4119,13 @@ } } }, - "get": { + "delete": { "tags": [ "mcp_projects" ], "summary": "Handle Project Streamable Http", "description": "Handle Streamable HTTP connections for a specific project.", - "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_delete", + "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post", "parameters": [ { "name": "project_id", @@ -4079,13 +4154,13 @@ } } }, - "post": { + "get": { "tags": [ "mcp_projects" ], "summary": "Handle Project Streamable Http", "description": "Handle Streamable HTTP connections for a specific project.", - "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_delete", + "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post", "parameters": [ { "name": "project_id", @@ -4115,25 +4190,14 @@ } } }, - "/api/v1/mcp/project/{project_id}/install": { + "/api/v1/mcp/project/{project_id}/streamable/": { "post": { "tags": [ "mcp_projects" ], - "summary": "Install Mcp Config", - "description": "Install MCP server configuration for Cursor, Windsurf, or Claude.", - "operationId": "install_mcp_config_api_v1_mcp_project__project_id__install_post", - "security": [ - { - "OAuth2PasswordBearerCookie": [] - }, - { - "API key query": [] - }, - { - "API key header": [] - } - ], + "summary": "Handle Project Streamable Http", + "description": "Handle Streamable HTTP connections for a specific project.", + "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post", "parameters": [ { "name": "project_id", @@ -4146,24 +4210,9 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MCPInstallRequest" - } - } - } - }, "responses": { "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } + "description": "Successful Response" }, "422": { "description": "Validation Error", @@ -4176,27 +4225,14 @@ } } } - } - }, - "/api/v1/mcp/project/{project_id}/composer-url": { - "get": { + }, + "delete": { "tags": [ "mcp_projects" ], - "summary": "Get Project Composer Url", - "description": "Get the MCP Composer URL for a specific project.

On failure, this endpoint should return with a 200 status code and an error message in
the body of the response to display to the user.", - "operationId": "get_project_composer_url_api_v1_mcp_project__project_id__composer_url_get", - "security": [ - { - "OAuth2PasswordBearerCookie": [] - }, - { - "API key query": [] - }, - { - "API key header": [] - } - ], + "summary": "Handle Project Streamable Http", + "description": "Handle Streamable HTTP connections for a specific project.", + "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post", "parameters": [ { "name": "project_id", @@ -4211,11 +4247,157 @@ ], "responses": { "200": { - "description": "Successful Response", + "description": "Successful Response" + }, + "422": { + "description": "Validation Error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ComposerUrlResponse" + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "tags": [ + "mcp_projects" + ], + "summary": "Handle Project Streamable Http", + "description": "Handle Streamable HTTP connections for a specific project.", + "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post", + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Project Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response" + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/api/v1/mcp/project/{project_id}/install": { + "post": { + "tags": [ + "mcp_projects" + ], + "summary": "Install Mcp Config", + "description": "Install MCP server configuration for Cursor, Windsurf, or Claude.", + "operationId": "install_mcp_config_api_v1_mcp_project__project_id__install_post", + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ], + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Project Id" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MCPInstallRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/api/v1/mcp/project/{project_id}/composer-url": { + "get": { + "tags": [ + "mcp_projects" + ], + "summary": "Get Project Composer Url", + "description": "Get the MCP Composer URL for a specific project.

On failure, this endpoint should return with a 200 status code and an error message in
the body of the response to display to the user.", + "operationId": "get_project_composer_url_api_v1_mcp_project__project_id__composer_url_get", + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ], + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Project Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ComposerUrlResponse" } } } @@ -4570,6 +4752,16 @@ "default": false, "title": "Append" } + }, + { + "name": "ephemeral", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false, + "title": "Ephemeral" + } } ], "requestBody": { @@ -4699,6 +4891,16 @@ "default": false, "title": "Append" } + }, + { + "name": "ephemeral", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false, + "title": "Ephemeral" + } } ], "requestBody": { @@ -6018,6 +6220,234 @@ ] } }, + "/api/mcp/sse": { + "get": { + "tags": [ + "mcp" + ], + "summary": "Handle Sse", + "operationId": "handle_sse_api_mcp_sse_get", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "head": { + "tags": [ + "mcp" + ], + "summary": "Im Alive", + "operationId": "im_alive_api_mcp_sse_head", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "text/html": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/mcp/": { + "post": { + "tags": [ + "mcp" + ], + "summary": "Handle Messages", + "operationId": "handle_messages_api_mcp__post", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/api/mcp/streamable": { + "get": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_mcp_streamable_post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "post": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_mcp_streamable_post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "delete": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_mcp_streamable_post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "head": { + "tags": [ + "mcp" + ], + "summary": "Streamable Health", + "operationId": "streamable_health_api_mcp_streamable_head", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/api/mcp/streamable/": { + "get": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_mcp_streamable__post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "post": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_mcp_streamable__post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + }, + "delete": { + "tags": [ + "mcp" + ], + "summary": "Handle Streamable Http", + "description": "Streamable HTTP endpoint for MCP clients that support the new transport.", + "operationId": "handle_streamable_http_api_mcp_streamable__post", + "responses": { + "200": { + "description": "Successful Response" + } + }, + "security": [ + { + "OAuth2PasswordBearerCookie": [] + }, + { + "API key query": [] + }, + { + "API key header": [] + } + ] + } + }, "/health": { "get": { "tags": [