You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/06/01 15:49:16 UTC
[GitHub] [airflow] houqp commented on a change in pull request #8721: Add OpenAPI specification (II)
houqp commented on a change in pull request #8721:
URL: https://github.com/apache/airflow/pull/8721#discussion_r433323200
##########
File path: openapi.yaml
##########
@@ -0,0 +1,2412 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+---
+openapi: 3.0.3
+
+info:
+ title: "Airflow API (Stable)"
+ description: Apache Airflow management API.
+ version: '1.0.0'
+ license:
+ name: Apache 2.0
+ url: http://www.apache.org/licenses/LICENSE-2.0.html
+ contact:
+ name: Apache Software Foundation
+ url: https://airflow.apache.org
+ email: dev@airflow.apache.org
+
+servers:
+ - url: /api/v1
+ description: Apache Airflow Stable API.
+
+paths:
+ # Database entities
+ /connections:
+ get:
+ summary: Get all connection entries
+ operationId: getConnections
+ tags: [Connection]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of connection entry.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ post:
+ summary: Create connection entry
+ operationId: createConnection
+ tags: [Connection]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Connection'
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Connection'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /connections/{connection_id}:
+ parameters:
+ - $ref: '#/components/parameters/ConnectionID'
+
+ get:
+ summary: Get a connection entry
+ operationId: getConnection
+ tags: [Connection]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Connection'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ patch:
+ summary: Update a connection entry
+ operationId: updateConnection
+ tags: [Connection]
+ parameters:
+ - $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Connection'
+
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Connection'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ delete:
+ summary: Delete a connection entry
+ operationId: deleteConnection
+ tags: [Connection]
+ responses:
+ '204':
+ description: No content.
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags:
+ get:
+ summary: Get all DAGs
+ operationId: getDags
+ tags: [DAG]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of DAGs.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/DAGCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+
+ /dags/{dag_id}:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+
+ get:
+ summary: Get basic information about a DAG
+ description: >
+ Presents only information available in database (DAGModel).
+
+ If you need detailed information, consider using GET /dags/{dag_id}/detail.
+ operationId: getDag
+ tags: [DAG]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAG'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ patch:
+ summary: Update a DAG
+ operationId: updateDag
+ tags: [DAG]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAG'
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAG'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/{dag_id}/clearTaskInstances:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+
+ post:
+ summary: Clears a set of task instances associated with the DAG for a specified date range.
+ operationId: clearTaskInstance
+ tags: [DAG]
+ requestBody:
+ description: Parameters of action
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClearTaskInstance'
+
+ responses:
+ '200':
+ description: A list of cleared task references
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TaskInstanceReferenceCollection'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/{dag_id}/dagRuns:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+
+ get:
+ summary: Get all DAG Runs
+ description: >
+ This endpoint allows specifying `~` as the dag_id to retrieve DAG Runs for all DAGs.
+ operationId: getDagRuns
+ tags: [DAGRun]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ - $ref: '#/components/parameters/FilterExecutionDateGTE'
+ - $ref: '#/components/parameters/FilterExecutionDateLTE'
+ - $ref: '#/components/parameters/FilterStartDateGTE'
+ - $ref: '#/components/parameters/FilterStartDateLTE'
+ - $ref: '#/components/parameters/FilterEndDateGTE'
+ - $ref: '#/components/parameters/FilterEndDateLTE'
+ responses:
+ '200':
+ description: List of DAG Runs.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/DAGRunCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+
+ /dags/~/dagRuns/list:
+ post:
+ summary: Get all DAG Runs from aall DAGs.
+ description: >
+ This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it
+ would run in to maximum HTTP request URL lengthlimits
+ operationId: getDagRunsBatch
+ tags: [DAGRun]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListDagRunsForm'
+ responses:
+ '200':
+ description: List of DAG Runs.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/DAGRunCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags/{dag_id}/dagRuns/{dag_run_id}:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+
+ get:
+ summary: Get a DAG Run
+ operationId: getDagRun
+ tags: [DAGRun]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ post:
+ summary: Trigger a DAG Run
+ operationId: createDagRun
+ tags: [DAGRun]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '409':
+ $ref: '#/components/responses/AlreadyExists'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ patch:
+ summary: Update a DAG Run
+ operationId: updateDagRun
+ tags: [DAGRun]
+ parameters:
+ - $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ delete:
+ summary: Delete a DAG Run
+ operationId: deleteDagRun
+ tags: [DAGRun]
+ responses:
+ '204':
+ description: No content.
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /eventLogs:
+ get:
+ summary: Get all log entries from event log
+ operationId: getEventLog
+ tags: [EventLog]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of log entries.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/EventLogCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /eventLogs/{event_log_id}:
+ parameters:
+ - $ref: '#/components/parameters/EventLogID'
+
+ get:
+ summary: Get a log entry
+ operationId: getEventLogEntry
+ tags: [EventLog]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/EventLog'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /importErrors:
+ get:
+ summary: Get all import errors
+ operationId: getImportErrors
+ tags: [ImportError]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of import errors.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/ImportErrorCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /importErrors/{import_error_id}:
+ parameters:
+ - $ref: '#/components/parameters/ImportErrorID'
+
+ get:
+ summary: Get an import error
+ operationId: getImportError
+ tags: [ImportError]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ImportError'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ delete:
+ summary: Delete an import error
+ operationId: deleteImportError
+ tags: [ImportError]
+ responses:
+ '204':
+ description: No content.
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /pools:
+ get:
+ summary: Get all pools
+ operationId: getPools
+ tags: [Pool]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of pools.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/PoolCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ post:
+ summary: Create a pool
+ operationId: createPool
+ tags: [Pool]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Pool'
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Pool'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /pools/{pool_name}:
+ parameters:
+ - $ref: '#/components/parameters/PoolName'
+
+ get:
+ summary: Get a pool
+ operationId: getPool
+ tags: [Pool]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Pool'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ patch:
+ summary: Update a pool
+ operationId: updatePool
+ tags: [Pool]
+ parameters:
+ - $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Pool'
+
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Pool'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ delete:
+ summary: Delete a pool
+ operationId: deletePool
+ tags: [Pool]
+ responses:
+ '204':
+ description: No content.
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+ - $ref: '#/components/parameters/FilterExecutionDateGTE'
+ - $ref: '#/components/parameters/FilterExecutionDateLTE'
+ - $ref: '#/components/parameters/FilterStartDateGTE'
+ - $ref: '#/components/parameters/FilterStartDateLTE'
+ - $ref: '#/components/parameters/FilterEndDateGTE'
+ - $ref: '#/components/parameters/FilterEndDateLTE'
+ - $ref: '#/components/parameters/FilterDurationGTE'
+ - $ref: '#/components/parameters/FilterDurationLTE'
+ - $ref: '#/components/parameters/FilterState'
+ - $ref: '#/components/parameters/FilterPool'
+ - $ref: '#/components/parameters/FilterQueue'
+ get:
+ summary: Get a list of task instance of DAG.
+ description: >
+ This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve DAG Runs for all DAGs
+ and DAG Runs.
+ operationId: getTaskInstances
+ tags: [TaskInstance]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of task instances.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/TaskInstanceCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+ - $ref: '#/components/parameters/TaskID'
+
+ get:
+ summary: Get a task instance
+ operationId: getTaskInstance
+ tags: [TaskInstance]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TaskInstance'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/~/dagRuns/~/taskInstances/list:
+ post:
+ summary: Get list of task instances from all DAGs and DAG Runs.
+ description: >
+ This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it
+ would run in to maximum HTTP request URL lengthlimits
+ operationId: getTaskInstancesBatch
+ tags: [TaskInstance]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListTaskInstanceForm'
+
+ responses:
+ '200':
+ description: List of task instances.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/TaskInstanceCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /variables:
+ get:
+ summary: Get all variables
+ description: The collection does not contain data. To get data, you must get a single entity.
+ operationId: getVariables
+ tags: [Variable]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of variables.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/VariableCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ post:
+ summary: Create a variable
+ operationId: createVariable
+ tags: [Variable]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Variable'
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Variable'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /variables/{variable_key}:
+ parameters:
+ - $ref: '#/components/parameters/VariableKey'
+
+ get:
+ summary: Get a variable by key
+ operationId: getVariable
+ tags: [Variable]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Variable'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ patch:
+ summary: Update a variable by key
+ operationId: updateVariable
+ tags: [Variable]
+ parameters:
+ - $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Variable'
+
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Variable'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ delete:
+ summary: Delete variable
+ operationId: deleteVariable
+ tags: [Variable]
+ responses:
+ '204':
+ description: No content.
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+ - $ref: '#/components/parameters/TaskID'
+
+ get:
+ summary: Get all XCom entries
+ description:
+ This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCOM entries for
+ for all DAGs, DAG Runs and task instances.
+ operationId: getXComEntry
+ tags: [XCom]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: List of XCom entries.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/XComCollection'
+ - $ref: '#/components/schemas/CollectionInfo'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ post:
+ summary: Create an XCom entry
+ operationId: updateXComEntry
+ tags: [XCom]
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XCom'
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XCom'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{key}:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+ - $ref: '#/components/parameters/TaskID'
+ - $ref: '#/components/parameters/XComKey'
+
+ get:
+ summary: Get an XCom entry
+ operationId: getXComValue
+ tags: [XCom]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XCom'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ patch:
+ summary: Update an XCom entry
+ operationId: updateXComValue
+ tags: [XCom]
+ parameters:
+ - $ref: '#/components/parameters/UpdateMask'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XCom'
+
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/XCom'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ delete:
+ summary: Delete an XCom entry
+ operationId: deleteXComValue
+ tags: [XCom]
+ responses:
+ '204':
+ description: No content.
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+ # Non-database resources
+ /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+ - $ref: '#/components/parameters/TaskID'
+
+ get:
+ summary: Get extra links for task instance
+ operationId: getExtraLinks
+ tags: [TaskInstance]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ExtraLinkCollection'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/DAGRunID'
+ - $ref: '#/components/parameters/TaskID'
+ - $ref: '#/components/parameters/TaskTryNumber'
+ - $ref: '#/components/parameters/FullContent'
+ - $ref: '#/components/parameters/ContinuationToken'
+
+ get:
+ summary: Get logs for a task instance
+ description: Get logs for a specific task instance and its try number
+ operationId: getLogs
+ tags: [TaskInstance]
+ responses:
+ '200':
+ description: Content of logs.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ continuation_token:
+ type: string
+ content:
+ type: string
+ text/plain:
+ schema:
+ type: string
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/{dag_id}/details:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+
+ get:
+ summary: Get a simplified representation of DAG.
+ operationId: getDagDetail
+ description: >
+ The response contains many DAG attributes, so the response can be large.
+ If possible, consider using GET /dags/{dag_id}.
+ tags: [DAG]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGDetail'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/{dag_id}/tasks:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+
+ get:
+ summary: Get tasks for DAG
+ operationId: getTasks
+ tags: [DAG]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TaskCollection'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dags/{dag_id}/tasks/{task_id}:
+ parameters:
+ - $ref: '#/components/parameters/DAGID'
+ - $ref: '#/components/parameters/TaskID'
+
+ get:
+ summary: Get simplified representation of a task.
+ operationId: getTask
+ tags: [DAG]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Task'
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /dagSources/{file_token}:
+ parameters:
+ - $ref: '#/components/parameters/FileToken'
+
+ get:
+ summary: Get source code using file token
+ operationId: getDagSource
+ tags: [DAG]
+ responses:
+ '200':
+ description: Successful response.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ content:
+ type: string
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+ '404':
+ $ref: '#/components/responses/NotFound'
+
+ /config:
+ get:
+ summary: Get current configuration
+ operationId: getConfig
+ tags: [Config]
+ parameters:
+ - $ref: '#/components/parameters/PageLimit'
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ description: Return current configuration.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Config'
+ text/plain:
+ schema:
+ type: string
+ '401':
+ $ref: '#/components/responses/Unauthenticated'
+ '403':
+ $ref: '#/components/responses/PermissionDenied'
+
+components:
+ # Reusable schemas (data models)
+ schemas:
+ # Database entities
+ ConnectionCollectionItem:
+ type: object
+ properties:
+ connection_id:
+ type: string
+ conn_type:
+ type: string
+ host:
+ type: string
+ login:
+ type: string
+ schema:
+ type: string
+ port:
+ type: integer
+
+ ConnectionCollection:
+ type: object
+ properties:
+ connections:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConnectionCollectionItem'
+
+ Connection:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionCollectionItem'
+ - type: object
+ properties:
+ password:
+ type: string
+ format: password
+ writeOnly: true
+ extra:
+ type: string
+
+ DAG:
+ type: object
+ properties:
+ dag_id:
+ type: string
+ readOnly: true
+ root_dag_id:
+ type: string
+ readOnly: true
+ is_paused:
+ type: boolean
+ is_subdag:
+ type: boolean
+ readOnly: true
+ fileloc:
+ type: string
+ readOnly: true
+ file_token:
+ type: string
+ readOnly: true
+ description: >
+ The key containing the encrypted path to the file. Encryption and decryption take place only on
+ the server. This prevents the client from reading an non-DAG file. This also ensures API
+ extensibility, because the format of encrypted data may change.
+ owners:
+ type: array
+ items:
+ type: string
+ readOnly: true
+ description:
+ type: string
+ readOnly: true
+ schedule_interval:
+ oneOf:
Review comment:
if you need to merge attribute (readonly) with predefined schema in openapi, you will need to use allOf unfortunately :(
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org