{ "openapi": "3.1.0", "info": { "title": "etl-craft", "version": "1" }, "paths": { "/api/v1/health": { "get": { "summary": "Health", "operationId": "health_api_v1_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Health Api V1 Health Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/pipelines": { "get": { "summary": "List Pipelines", "operationId": "list_pipelines_api_v1_pipelines_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Pipelines Api V1 Pipelines Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/pipelines/{code}": { "get": { "summary": "Pipeline", "operationId": "pipeline_api_v1_pipelines__code__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Pipeline Api V1 Pipelines Code Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/pipelines/{code}/runs": { "get": { "summary": "History", "operationId": "history_api_v1_pipelines__code__runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response History Api V1 Pipelines Code Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Trigger", "operationId": "trigger_api_v1_pipelines__code__runs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Trigger Api V1 Pipelines Code Runs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/pipelines/{code}/backfills": { "post": { "summary": "Backfill", "operationId": "backfill_api_v1_pipelines__code__backfills_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Backfill" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Backfill Api V1 Pipelines Code Backfills Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/pipelines/{code}/pause": { "post": { "summary": "Pause", "operationId": "pause_api_v1_pipelines__code__pause_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Pause Api V1 Pipelines Code Pause Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/pipelines/{code}/resume": { "post": { "summary": "Resume", "operationId": "resume_api_v1_pipelines__code__resume_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resume Api V1 Pipelines Code Resume Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}": { "get": { "summary": "Run", "operationId": "run_api_v1_runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Api V1 Runs Run Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/tasks": { "get": { "summary": "Run Tasks", "operationId": "run_tasks_api_v1_runs__run_id__tasks_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Tasks Api V1 Runs Run Id Tasks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/tasks/{task}/explain": { "get": { "summary": "Explain", "operationId": "explain_api_v1_runs__run_id__tasks__task__explain_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } }, { "name": "task", "in": "path", "required": true, "schema": { "type": "string", "title": "Task" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Explain Api V1 Runs Run Id Tasks Task Explain Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_api_v1_runs__run_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Api V1 Runs Run Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/tasks/{task}/mark": { "post": { "summary": "Mark", "operationId": "mark_api_v1_runs__run_id__tasks__task__mark_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } }, { "name": "task", "in": "path", "required": true, "schema": { "type": "string", "title": "Task" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mark" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Mark Api V1 Runs Run Id Tasks Task Mark Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/tasks/{task}/rerun": { "post": { "summary": "Rerun", "operationId": "rerun_api_v1_runs__run_id__tasks__task__rerun_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } }, { "name": "task", "in": "path", "required": true, "schema": { "type": "string", "title": "Task" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rerun" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rerun Api V1 Runs Run Id Tasks Task Rerun Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/attempts/{attempt_id}": { "get": { "summary": "Attempt", "operationId": "attempt_api_v1_attempts__attempt_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "attempt_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Attempt Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Attempt Api V1 Attempts Attempt Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/attempts/{attempt_id}/log": { "get": { "summary": "Log", "operationId": "log_api_v1_attempts__attempt_id__log_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "attempt_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Attempt Id" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tokens": { "get": { "summary": "List Tokens", "operationId": "list_tokens_api_v1_tokens_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Tokens Api V1 Tokens Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "summary": "Token Create", "operationId": "token_create_api_v1_tokens_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Token Create Api V1 Tokens Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/tokens/{token_id}/revoke": { "post": { "summary": "Token Revoke", "operationId": "token_revoke_api_v1_tokens__token_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Token Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Token Revoke Api V1 Tokens Token Id Revoke Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "Backfill": { "properties": { "reason": { "type": "string", "maxLength": 4096, "minLength": 1, "pattern": "\\S", "title": "Reason" }, "first": { "type": "string", "format": "date", "title": "First" }, "last": { "type": "string", "format": "date", "title": "Last" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "first", "last" ], "title": "Backfill", "description": "The inclusive date range to execute." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Mark": { "properties": { "reason": { "type": "string", "maxLength": 4096, "minLength": 1, "pattern": "\\S", "title": "Reason" }, "status": { "type": "string", "title": "Status" }, "rows": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Rows" }, "stale": { "type": "boolean", "title": "Stale", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "reason", "status" ], "title": "Mark", "description": "One task's requested state and optional written row count." }, "Reason": { "properties": { "reason": { "type": "string", "maxLength": 4096, "minLength": 1, "pattern": "\\S", "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Reason", "description": "A required, nonblank explanation for a human intervention." }, "Rerun": { "properties": { "reason": { "type": "string", "maxLength": 4096, "minLength": 1, "pattern": "\\S", "title": "Reason" }, "with_downstream": { "type": "boolean", "title": "With Downstream", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "Rerun", "description": "Whether to rerun downstream tasks as well." }, "TokenInput": { "properties": { "name": { "type": "string", "title": "Name" }, "role": { "type": "string", "title": "Role" }, "expires": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires" } }, "additionalProperties": false, "type": "object", "required": [ "name", "role" ], "title": "TokenInput", "description": "The name, role and optional day lifetime of a new credential." }, "Trigger": { "properties": { "run_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Run Date" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "title": "Trigger", "description": "A pipeline trigger with optional logical date and audit reason." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }