This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow-client-go.git
The following commit(s) were added to refs/heads/master by this push:
new c85a1a1 fix package path in go module and catch up to latest openapi
spec (#3)
c85a1a1 is described below
commit c85a1a131cd3171ba093905619dd29580dbe124b
Author: QP Hou <[email protected]>
AuthorDate: Tue Jul 21 23:35:13 2020 -0700
fix package path in go module and catch up to latest openapi spec (#3)
---
airflow/README.md | 19 +-
airflow/api/openapi.yaml | 417 ++++++---------------
airflow/api_dag.go | 16 +-
airflow/api_dag_run.go | 255 +++++++------
airflow/api_monitoring.go | 10 +-
airflow/api_task_instance.go | 4 +-
airflow/api_x_com.go | 357 ------------------
airflow/docs/DAGApi.md | 10 +-
airflow/docs/DAGRunApi.md | 75 ++--
airflow/docs/DagRun.md | 2 +-
airflow/docs/Error.md | 2 +-
airflow/docs/{Error.md => HealthInfo.md} | 9 +-
airflow/docs/{Error.md => HealthStatus.md} | 7 +-
airflow/docs/{Error.md => MetadatabaseStatus.md} | 8 +-
airflow/docs/MonitoringApi.md | 10 +-
airflow/docs/{Error.md => SchedulerStatus.md} | 9 +-
airflow/docs/TaskInstanceApi.md | 6 +-
airflow/docs/XComApi.md | 124 ------
airflow/go.mod | 2 +-
airflow/model_dag_run.go | 2 +-
airflow/model_error.go | 2 +-
.../{model_task_state.go => model_health_info.go} | 21 +-
...{model_task_state.go => model_health_status.go} | 18 +-
..._task_state.go => model_metadatabase_status.go} | 20 +-
...del_task_state.go => model_scheduler_status.go} | 21 +-
airflow/model_task_state.go | 2 +-
26 files changed, 367 insertions(+), 1061 deletions(-)
diff --git a/airflow/README.md b/airflow/README.md
index 62fe361..406ff71 100644
--- a/airflow/README.md
+++ b/airflow/README.md
@@ -59,23 +59,23 @@ Class | Method | HTTP request | Description
*ConnectionApi* | [**PatchConnection**](docs/ConnectionApi.md#patchconnection)
| **Patch** /connections/{connection_id} | Update a connection entry
*ConnectionApi* | [**PostConnection**](docs/ConnectionApi.md#postconnection) |
**Post** /connections | Create connection entry
*DAGApi* | [**GetDag**](docs/DAGApi.md#getdag) | **Get** /dags/{dag_id} | Get
basic information about a DAG
-*DAGApi* | [**GetDagDetails**](docs/DAGApi.md#getdagdetails) | **Get**
/dags/{dag_id}/details | Get a simplified representation of DAG.
+*DAGApi* | [**GetDagDetails**](docs/DAGApi.md#getdagdetails) | **Get**
/dags/{dag_id}/details | Get a simplified representation of DAG
*DAGApi* | [**GetDagSource**](docs/DAGApi.md#getdagsource) | **Get**
/dagSources/{file_token} | Get source code using file token
*DAGApi* | [**GetDags**](docs/DAGApi.md#getdags) | **Get** /dags | Get all DAGs
-*DAGApi* | [**GetTask**](docs/DAGApi.md#gettask) | **Get**
/dags/{dag_id}/tasks/{task_id} | Get simplified representation of a task.
+*DAGApi* | [**GetTask**](docs/DAGApi.md#gettask) | **Get**
/dags/{dag_id}/tasks/{task_id} | Get simplified representation of a task
*DAGApi* | [**GetTasks**](docs/DAGApi.md#gettasks) | **Get**
/dags/{dag_id}/tasks | Get tasks for DAG
*DAGApi* | [**PatchDag**](docs/DAGApi.md#patchdag) | **Patch** /dags/{dag_id}
| Update a DAG
*DAGApi* | [**PostClearTaskInstances**](docs/DAGApi.md#postcleartaskinstances)
| **Post** /dags/{dag_id}/clearTaskInstances | Clears a set of task instances
associated with the DAG for a specified date range.
+*DAGRunApi* |
[**AirflowApiConnexionEndpointsDagRunEndpointPostDagRun**](docs/DAGRunApi.md#airflowapiconnexionendpointsdagrunendpointpostdagrun)
| **Post** /dags/{dag_id}/dagRuns | Trigger a DAG Run
*DAGRunApi* | [**DeleteDagRun**](docs/DAGRunApi.md#deletedagrun) | **Delete**
/dags/{dag_id}/dagRuns/{dag_run_id} | Delete a DAG Run
*DAGRunApi* | [**GetDagRun**](docs/DAGRunApi.md#getdagrun) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id} | Get a DAG Run
*DAGRunApi* | [**GetDagRuns**](docs/DAGRunApi.md#getdagruns) | **Get**
/dags/{dag_id}/dagRuns | Get all DAG Runs
-*DAGRunApi* | [**GetDagRunsBatch**](docs/DAGRunApi.md#getdagrunsbatch) |
**Post** /dags/~/dagRuns/list | Get all DAG Runs from aall DAGs.
-*DAGRunApi* | [**PostDagRun**](docs/DAGRunApi.md#postdagrun) | **Post**
/dags/{dag_id}/dagRuns/{dag_run_id} | Trigger a DAG Run
+*DAGRunApi* | [**GetDagRunsBatch**](docs/DAGRunApi.md#getdagrunsbatch) |
**Post** /dags/~/dagRuns/list | Get all DAG Runs from all DAGs
*EventLogApi* | [**GetEventLog**](docs/EventLogApi.md#geteventlog) | **Get**
/eventLogs/{event_log_id} | Get a log entry
*EventLogApi* | [**GetEventLogs**](docs/EventLogApi.md#geteventlogs) | **Get**
/eventLogs | Get all log entries from event log
*ImportErrorApi* | [**GetImportError**](docs/ImportErrorApi.md#getimporterror)
| **Get** /importErrors/{import_error_id} | Get an import error
*ImportErrorApi* |
[**GetImportErrors**](docs/ImportErrorApi.md#getimporterrors) | **Get**
/importErrors | Get all import errors
-*MonitoringApi* | [**GetHealth**](docs/MonitoringApi.md#gethealth) | **Get**
/health | Checks if the API works
+*MonitoringApi* | [**GetHealth**](docs/MonitoringApi.md#gethealth) | **Get**
/health | Returns the status of Airflow's metadatabase and scheduler
*MonitoringApi* | [**GetVersion**](docs/MonitoringApi.md#getversion) | **Get**
/version | Get version information
*PoolApi* | [**DeletePool**](docs/PoolApi.md#deletepool) | **Delete**
/pools/{pool_name} | Delete a pool
*PoolApi* | [**GetPool**](docs/PoolApi.md#getpool) | **Get**
/pools/{pool_name} | Get a pool
@@ -85,18 +85,15 @@ Class | Method | HTTP request | Description
*TaskInstanceApi* | [**GetExtraLinks**](docs/TaskInstanceApi.md#getextralinks)
| **Get** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links |
Get extra links for task instance
*TaskInstanceApi* | [**GetLog**](docs/TaskInstanceApi.md#getlog) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}
| Get logs for a task instance
*TaskInstanceApi* |
[**GetTaskInstance**](docs/TaskInstanceApi.md#gettaskinstance) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} | Get a task
instance
-*TaskInstanceApi* |
[**GetTaskInstances**](docs/TaskInstanceApi.md#gettaskinstances) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances | Get a list of task instance
of DAG.
+*TaskInstanceApi* |
[**GetTaskInstances**](docs/TaskInstanceApi.md#gettaskinstances) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances | Get a list of task instance
of DAG
*TaskInstanceApi* |
[**GetTaskInstancesBatch**](docs/TaskInstanceApi.md#gettaskinstancesbatch) |
**Post** /dags/~/dagRuns/~/taskInstances/list | Get list of task instances from
all DAGs and DAG Runs.
*VariableApi* | [**DeleteVariable**](docs/VariableApi.md#deletevariable) |
**Delete** /variables/{variable_key} | Delete variable
*VariableApi* | [**GetVariable**](docs/VariableApi.md#getvariable) | **Get**
/variables/{variable_key} | Get a variable by key
*VariableApi* | [**GetVariables**](docs/VariableApi.md#getvariables) | **Get**
/variables | Get all variables
*VariableApi* | [**PatchVariable**](docs/VariableApi.md#patchvariable) |
**Patch** /variables/{variable_key} | Update a variable by key
*VariableApi* | [**PostVariables**](docs/VariableApi.md#postvariables) |
**Post** /variables | Create a variable
-*XComApi* | [**DeleteXcomEntry**](docs/XComApi.md#deletexcomentry) |
**Delete**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
| Delete an XCom entry
*XComApi* | [**GetXcomEntries**](docs/XComApi.md#getxcomentries) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries | Get
all XCom entries
*XComApi* | [**GetXcomEntry**](docs/XComApi.md#getxcomentry) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
| Get an XCom entry
-*XComApi* | [**PatchXcomEntry**](docs/XComApi.md#patchxcomentry) | **Patch**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
| Update an XCom entry
-*XComApi* | [**PostXcomEntries**](docs/XComApi.md#postxcomentries) | **Post**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries |
Create an XCom entry
## Documentation For Models
@@ -124,16 +121,20 @@ Class | Method | HTTP request | Description
- [EventLogCollection](docs/EventLogCollection.md)
- [ExtraLink](docs/ExtraLink.md)
- [ExtraLinkCollection](docs/ExtraLinkCollection.md)
+ - [HealthInfo](docs/HealthInfo.md)
+ - [HealthStatus](docs/HealthStatus.md)
- [ImportError](docs/ImportError.md)
- [ImportErrorCollection](docs/ImportErrorCollection.md)
- [InlineResponse200](docs/InlineResponse200.md)
- [InlineResponse2001](docs/InlineResponse2001.md)
- [ListDagRunsForm](docs/ListDagRunsForm.md)
- [ListTaskInstanceForm](docs/ListTaskInstanceForm.md)
+ - [MetadatabaseStatus](docs/MetadatabaseStatus.md)
- [Pool](docs/Pool.md)
- [PoolCollection](docs/PoolCollection.md)
- [RelativeDelta](docs/RelativeDelta.md)
- [ScheduleInterval](docs/ScheduleInterval.md)
+ - [SchedulerStatus](docs/SchedulerStatus.md)
- [SlaMiss](docs/SlaMiss.md)
- [SlaMissCollection](docs/SlaMissCollection.md)
- [Tag](docs/Tag.md)
diff --git a/airflow/api/openapi.yaml b/airflow/api/openapi.yaml
index 56afe38..c4cb0c6 100644
--- a/airflow/api/openapi.yaml
+++ b/airflow/api/openapi.yaml
@@ -56,7 +56,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -287,7 +286,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -483,7 +481,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -582,10 +579,68 @@ paths:
tags:
- DAGRun
x-openapi-router-controller:
airflow.api_connexion.endpoints.dag_run_endpoint
+ post:
+ operationId:
airflow.api_connexion.endpoints.dag_run_endpoint.post_dag_run
+ parameters:
+ - description: The DAG ID.
+ explode: false
+ in: path
+ name: dag_id
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DAGRun'
+ description: Successful response.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: Client specified an invalid argument.
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: Request not authenticated due to missing, invalid,
authentication
+ info.
+ "409":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: The resource that a client tried to create already
exists.
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: Client does not have sufficient permission.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: A specified resource is not found.
+ summary: Trigger a DAG Run
+ tags:
+ - DAGRun
/dags/~/dagRuns/list:
post:
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
+ 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 length
limit.
operationId: get_dag_runs_batch
requestBody:
content:
@@ -621,7 +676,7 @@ paths:
schema:
$ref: '#/components/schemas/Error'
description: Client does not have sufficient permission.
- summary: Get all DAG Runs from aall DAGs.
+ summary: Get all DAG Runs from all DAGs
tags:
- DAGRun
x-openapi-router-controller:
airflow.api_connexion.endpoints.dag_run_endpoint
@@ -720,67 +775,6 @@ paths:
tags:
- DAGRun
x-openapi-router-controller:
airflow.api_connexion.endpoints.dag_run_endpoint
- post:
- operationId: post_dag_run
- parameters:
- - description: The DAG ID.
- explode: false
- in: path
- name: dag_id
- required: true
- schema:
- type: string
- style: simple
- - description: The DAG Run ID.
- explode: false
- in: path
- name: dag_run_id
- required: true
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DAGRun'
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DAGRun'
- description: Successful response.
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client specified an invalid argument.
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Request not authenticated due to missing, invalid,
authentication
- info.
- "409":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: The resource that a client tried to create already
exists.
- "403":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client does not have sufficient permission.
- summary: Trigger a DAG Run
- tags:
- - DAGRun
- x-openapi-router-controller:
airflow.api_connexion.endpoints.dag_run_endpoint
/eventLogs:
get:
operationId: get_event_logs
@@ -792,7 +786,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -884,7 +877,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -976,7 +968,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -1356,7 +1347,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -1391,7 +1381,7 @@ paths:
schema:
$ref: '#/components/schemas/Error'
description: Client does not have sufficient permission.
- summary: Get a list of task instance of DAG.
+ summary: Get a list of task instance of DAG
tags:
- TaskInstance
x-openapi-router-controller:
airflow.api_connexion.endpoints.task_instance_endpoint
@@ -1456,7 +1446,7 @@ paths:
/dags/~/dagRuns/~/taskInstances/list:
post:
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
+ 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 length
limits.
operationId: get_task_instances_batch
requestBody:
content:
@@ -1509,7 +1499,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -1766,7 +1755,6 @@ paths:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
- description: The number of items to skip before starting to collect
the result
@@ -1805,131 +1793,7 @@ paths:
tags:
- XCom
x-openapi-router-controller:
airflow.api_connexion.endpoints.xcom_endpoint
- post:
- operationId: post_xcom_entries
- parameters:
- - description: The DAG ID.
- explode: false
- in: path
- name: dag_id
- required: true
- schema:
- type: string
- style: simple
- - description: The DAG Run ID.
- explode: false
- in: path
- name: dag_run_id
- required: true
- schema:
- type: string
- style: simple
- - description: The Task ID.
- explode: false
- in: path
- name: task_id
- required: true
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XCom'
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XCom'
- description: Successful response.
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client specified an invalid argument.
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Request not authenticated due to missing, invalid,
authentication
- info.
- "403":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client does not have sufficient permission.
- summary: Create an XCom entry
- tags:
- - XCom
- x-openapi-router-controller:
airflow.api_connexion.endpoints.xcom_endpoint
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}:
- delete:
- operationId: delete_xcom_entry
- parameters:
- - description: The DAG ID.
- explode: false
- in: path
- name: dag_id
- required: true
- schema:
- type: string
- style: simple
- - description: The DAG Run ID.
- explode: false
- in: path
- name: dag_run_id
- required: true
- schema:
- type: string
- style: simple
- - description: The Task ID.
- explode: false
- in: path
- name: task_id
- required: true
- schema:
- type: string
- style: simple
- - description: The XCom Key.
- explode: false
- in: path
- name: xcom_key
- required: true
- schema:
- type: string
- style: simple
- responses:
- "204":
- description: No content.
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client specified an invalid argument.
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Request not authenticated due to missing, invalid,
authentication
- info.
- "403":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client does not have sufficient permission.
- summary: Delete an XCom entry
- tags:
- - XCom
- x-openapi-router-controller:
airflow.api_connexion.endpoints.xcom_endpoint
get:
operationId: get_xcom_entry
parameters:
@@ -1995,94 +1859,6 @@ paths:
tags:
- XCom
x-openapi-router-controller:
airflow.api_connexion.endpoints.xcom_endpoint
- patch:
- operationId: patch_xcom_entry
- parameters:
- - description: The DAG ID.
- explode: false
- in: path
- name: dag_id
- required: true
- schema:
- type: string
- style: simple
- - description: The DAG Run ID.
- explode: false
- in: path
- name: dag_run_id
- required: true
- schema:
- type: string
- style: simple
- - description: The Task ID.
- explode: false
- in: path
- name: task_id
- required: true
- schema:
- type: string
- style: simple
- - description: The XCom Key.
- explode: false
- in: path
- name: xcom_key
- required: true
- schema:
- type: string
- style: simple
- - description: |
- The fields to update on the connection (connection, pool etc). If
absent or empty, all modifiable fields are updated. A comma-separated list of
fully qualified names of fields.
- explode: false
- in: query
- name: update_mask
- required: false
- schema:
- items:
- type: string
- type: array
- style: form
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XCom'
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/XCom'
- description: Successful response.
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client specified an invalid argument.
- "401":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Request not authenticated due to missing, invalid,
authentication
- info.
- "403":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: Client does not have sufficient permission.
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- description: A specified resource is not found.
- summary: Update an XCom entry
- tags:
- - XCom
- x-openapi-router-controller:
airflow.api_connexion.endpoints.xcom_endpoint
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links:
get:
operationId: get_extra_links
@@ -2275,7 +2051,7 @@ paths:
schema:
$ref: '#/components/schemas/Error'
description: A specified resource is not found.
- summary: Get a simplified representation of DAG.
+ summary: Get a simplified representation of DAG
tags:
- DAG
x-openapi-router-controller: airflow.api_connexion.endpoints.dag_endpoint
@@ -2367,7 +2143,7 @@ paths:
schema:
$ref: '#/components/schemas/Error'
description: A specified resource is not found.
- summary: Get simplified representation of a task.
+ summary: Get simplified representation of a task
tags:
- DAG
x-openapi-router-controller:
airflow.api_connexion.endpoints.task_endpoint
@@ -2390,6 +2166,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_1'
+ plain/text:
+ schema:
+ $ref: '#/components/schemas/inline_response_200_1'
description: Successful response.
"401":
content:
@@ -2410,6 +2189,12 @@ paths:
schema:
$ref: '#/components/schemas/Error'
description: A specified resource is not found.
+ "406":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: A specified Accept header is not allowed.
summary: Get source code using file token
tags:
- DAG
@@ -2450,11 +2235,11 @@ paths:
responses:
"200":
content:
- text/plain:
+ application/json:
schema:
- type: string
- description: It should always return "OK"
- summary: Checks if the API works
+ $ref: '#/components/schemas/HealthInfo'
+ description: Returns info about metadatabase and last heart beat.
+ summary: Returns the status of Airflow's metadatabase and scheduler
tags:
- Monitoring
x-openapi-router-controller:
airflow.api_connexion.endpoints.health_endpoint
@@ -2497,7 +2282,6 @@ components:
required: false
schema:
default: 100
- minimum: 1
type: integer
style: form
ConnectionID:
@@ -2789,6 +2573,12 @@ components:
schema:
$ref: '#/components/schemas/Error'
description: A specified resource is not found.
+ NotAcceptable:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ description: A specified Accept header is not allowed.
AlreadyExists:
content:
application/json:
@@ -2911,6 +2701,7 @@ components:
If not provided, a value will be generated based on execution_date.
If the specified dag_run_id is in use, the creation request fails
with an ALREADY_EXISTS error.
This together with DAG_ID are a unique key.
+ nullable: true
type: string
dag_id:
readOnly: true
@@ -2998,6 +2789,17 @@ components:
$ref: '#/components/schemas/EventLog'
type: array
type: object
+ HealthInfo:
+ example:
+ scheduler:
+ latest_scheduler_heartbeat: latest_scheduler_heartbeat
+ metadatabase: {}
+ properties:
+ metadatabase:
+ $ref: '#/components/schemas/MetadatabaseStatus'
+ scheduler:
+ $ref: '#/components/schemas/SchedulerStatus'
+ type: object
ImportError:
example:
filename: filename
@@ -3026,6 +2828,13 @@ components:
$ref: '#/components/schemas/ImportError'
type: array
type: object
+ MetadatabaseStatus:
+ description: Returns the status of the metadatabase
+ example: {}
+ properties:
+ status:
+ $ref: '#/components/schemas/HealthStatus'
+ type: object
Pool:
example:
queued_slots: 5
@@ -3059,6 +2868,19 @@ components:
$ref: '#/components/schemas/Pool'
type: array
type: object
+ SchedulerStatus:
+ description: Returns the status and the latest scheduler heartbeat
+ example:
+ latest_scheduler_heartbeat: latest_scheduler_heartbeat
+ properties:
+ status:
+ $ref: '#/components/schemas/HealthStatus'
+ latest_scheduler_heartbeat:
+ format: datetime
+ nullable: true
+ readOnly: true
+ type: string
+ type: object
SLAMiss:
example:
notification_sent: true
@@ -3952,7 +3774,7 @@ components:
A URI reference [RFC3986] that identifies the problem type. This
specification encourages that, when dereferenced, it provide human-readable
documentation for the problem type.
type: string
title:
- description: A short, human-readable summary of the problem type.
+ description: A short, human-readable summary of the problem type.
type: string
status:
description: The HTTP status code generated by the API server for
this occurrence
@@ -3979,7 +3801,7 @@ components:
type: object
TaskState:
enum:
- - succcess
+ - success
- running
- failed
- upstream_failed
@@ -4014,6 +3836,11 @@ components:
- upstream
- absolute
type: string
+ HealthStatus:
+ enum:
+ - healthy
+ - unhealthy
+ type: string
inline_response_200:
example:
continuation_token: continuation_token
diff --git a/airflow/api_dag.go b/airflow/api_dag.go
index cea606b..bdf443c 100644
--- a/airflow/api_dag.go
+++ b/airflow/api_dag.go
@@ -152,7 +152,7 @@ func (a *DAGApiService) GetDag(ctx _context.Context, dagId
string) (Dag, *_netht
}
/*
-GetDagDetails Get a simplified representation of DAG.
+GetDagDetails Get a simplified representation of DAG
The response contains many DAG attributes, so the response can be large. If
possible, consider using GET /dags/{dag_id}.
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param dagId The DAG ID.
@@ -292,7 +292,7 @@ func (a *DAGApiService) GetDagSource(ctx _context.Context,
fileToken string) (In
}
// to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/json"}
+ localVarHTTPHeaderAccepts := []string{"application/json", "plain/text"}
// set Accept header
localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
@@ -348,6 +348,16 @@ func (a *DAGApiService) GetDagSource(ctx _context.Context,
fileToken string) (In
return localVarReturnValue,
localVarHTTPResponse, newErr
}
newErr.model = v
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+ if localVarHTTPResponse.StatusCode == 406 {
+ var v Error
+ err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue,
localVarHTTPResponse, newErr
+ }
+ newErr.model = v
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
@@ -463,7 +473,7 @@ func (a *DAGApiService) GetDags(ctx _context.Context,
localVarOptionals *GetDags
}
/*
-GetTask Get simplified representation of a task.
+GetTask Get simplified representation of a task
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param dagId The DAG ID.
* @param taskId The Task ID.
diff --git a/airflow/api_dag_run.go b/airflow/api_dag_run.go
index ef5f300..1c61b5c 100644
--- a/airflow/api_dag_run.go
+++ b/airflow/api_dag_run.go
@@ -45,6 +45,135 @@ var (
type DAGRunApiService service
/*
+AirflowApiConnexionEndpointsDagRunEndpointPostDagRun Trigger a DAG Run
+ * @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
+ * @param dagId The DAG ID.
+ * @param dagRun
+@return DagRun
+*/
+func (a *DAGRunApiService)
AirflowApiConnexionEndpointsDagRunEndpointPostDagRun(ctx _context.Context,
dagId string, dagRun DagRun) (DagRun, *_nethttp.Response, error) {
+ var (
+ localVarHTTPMethod = _nethttp.MethodPost
+ localVarPostBody interface{}
+ localVarFormFileName string
+ localVarFileName string
+ localVarFileBytes []byte
+ localVarReturnValue DagRun
+ )
+
+ // create path and map variables
+ localVarPath := a.client.cfg.BasePath + "/dags/{dag_id}/dagRuns"
+ localVarPath = strings.Replace(localVarPath, "{"+"dag_id"+"}",
_neturl.QueryEscape(parameterToString(dagId, "")) , -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := _neturl.Values{}
+ localVarFormParams := _neturl.Values{}
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{"application/json"}
+
+ // set Content-Type header
+ localVarHTTPContentType :=
selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header
+ localVarHTTPHeaderAccepts := []string{"application/json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ // body params
+ localVarPostBody = &dagRun
+ r, err := a.client.prepareRequest(ctx, localVarPath,
localVarHTTPMethod, localVarPostBody, localVarHeaderParams,
localVarQueryParams, localVarFormParams, localVarFormFileName,
localVarFileName, localVarFileBytes)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(r)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body)
+ localVarHTTPResponse.Body.Close()
+ if err != nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := GenericOpenAPIError{
+ body: localVarBody,
+ error: localVarHTTPResponse.Status,
+ }
+ if localVarHTTPResponse.StatusCode == 400 {
+ var v Error
+ err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue,
localVarHTTPResponse, newErr
+ }
+ newErr.model = v
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+ if localVarHTTPResponse.StatusCode == 401 {
+ var v Error
+ err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue,
localVarHTTPResponse, newErr
+ }
+ newErr.model = v
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+ if localVarHTTPResponse.StatusCode == 409 {
+ var v Error
+ err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue,
localVarHTTPResponse, newErr
+ }
+ newErr.model = v
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+ if localVarHTTPResponse.StatusCode == 403 {
+ var v Error
+ err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue,
localVarHTTPResponse, newErr
+ }
+ newErr.model = v
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+ if localVarHTTPResponse.StatusCode == 404 {
+ var v Error
+ err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue,
localVarHTTPResponse, newErr
+ }
+ newErr.model = v
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr := GenericOpenAPIError{
+ body: localVarBody,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
+/*
DeleteDagRun Delete a DAG Run
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param dagId The DAG ID.
@@ -384,8 +513,8 @@ func (a *DAGRunApiService) GetDagRuns(ctx _context.Context,
dagId string, localV
}
/*
-GetDagRunsBatch Get all DAG Runs from aall DAGs.
-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
+GetDagRunsBatch Get all DAG Runs from all DAGs
+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 length limit.
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param listDagRunsForm
@return DagRunCollection
@@ -489,125 +618,3 @@ func (a *DAGRunApiService) GetDagRunsBatch(ctx
_context.Context, listDagRunsForm
return localVarReturnValue, localVarHTTPResponse, nil
}
-
-/*
-PostDagRun Trigger a DAG Run
- * @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param dagId The DAG ID.
- * @param dagRunId The DAG Run ID.
- * @param dagRun
-@return DagRun
-*/
-func (a *DAGRunApiService) PostDagRun(ctx _context.Context, dagId string,
dagRunId string, dagRun DagRun) (DagRun, *_nethttp.Response, error) {
- var (
- localVarHTTPMethod = _nethttp.MethodPost
- localVarPostBody interface{}
- localVarFormFileName string
- localVarFileName string
- localVarFileBytes []byte
- localVarReturnValue DagRun
- )
-
- // create path and map variables
- localVarPath := a.client.cfg.BasePath +
"/dags/{dag_id}/dagRuns/{dag_run_id}"
- localVarPath = strings.Replace(localVarPath, "{"+"dag_id"+"}",
_neturl.QueryEscape(parameterToString(dagId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"dag_run_id"+"}",
_neturl.QueryEscape(parameterToString(dagRunId, "")) , -1)
-
- localVarHeaderParams := make(map[string]string)
- localVarQueryParams := _neturl.Values{}
- localVarFormParams := _neturl.Values{}
-
- // to determine the Content-Type header
- localVarHTTPContentTypes := []string{"application/json"}
-
- // set Content-Type header
- localVarHTTPContentType :=
selectHeaderContentType(localVarHTTPContentTypes)
- if localVarHTTPContentType != "" {
- localVarHeaderParams["Content-Type"] = localVarHTTPContentType
- }
-
- // to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/json"}
-
- // set Accept header
- localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
- if localVarHTTPHeaderAccept != "" {
- localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
- }
- // body params
- localVarPostBody = &dagRun
- r, err := a.client.prepareRequest(ctx, localVarPath,
localVarHTTPMethod, localVarPostBody, localVarHeaderParams,
localVarQueryParams, localVarFormParams, localVarFormFileName,
localVarFileName, localVarFileBytes)
- if err != nil {
- return localVarReturnValue, nil, err
- }
-
- localVarHTTPResponse, err := a.client.callAPI(r)
- if err != nil || localVarHTTPResponse == nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body)
- localVarHTTPResponse.Body.Close()
- if err != nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- if localVarHTTPResponse.StatusCode >= 300 {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: localVarHTTPResponse.Status,
- }
- if localVarHTTPResponse.StatusCode == 400 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 401 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 409 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 403 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- err = a.client.decode(&localVarReturnValue, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: err.Error(),
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- return localVarReturnValue, localVarHTTPResponse, nil
-}
diff --git a/airflow/api_monitoring.go b/airflow/api_monitoring.go
index da6fde2..4186211 100644
--- a/airflow/api_monitoring.go
+++ b/airflow/api_monitoring.go
@@ -43,18 +43,18 @@ var (
type MonitoringApiService service
/*
-GetHealth Checks if the API works
+GetHealth Returns the status of Airflow's metadatabase and scheduler
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
-@return string
+@return HealthInfo
*/
-func (a *MonitoringApiService) GetHealth(ctx _context.Context) (string,
*_nethttp.Response, error) {
+func (a *MonitoringApiService) GetHealth(ctx _context.Context) (HealthInfo,
*_nethttp.Response, error) {
var (
localVarHTTPMethod = _nethttp.MethodGet
localVarPostBody interface{}
localVarFormFileName string
localVarFileName string
localVarFileBytes []byte
- localVarReturnValue string
+ localVarReturnValue HealthInfo
)
// create path and map variables
@@ -73,7 +73,7 @@ func (a *MonitoringApiService) GetHealth(ctx
_context.Context) (string, *_nethtt
}
// to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"text/plain"}
+ localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
diff --git a/airflow/api_task_instance.go b/airflow/api_task_instance.go
index 75b6463..91254cb 100644
--- a/airflow/api_task_instance.go
+++ b/airflow/api_task_instance.go
@@ -428,7 +428,7 @@ type GetTaskInstancesOpts struct {
}
/*
-GetTaskInstances Get a list of task instance of DAG.
+GetTaskInstances Get a list of task instance of DAG
This endpoint allows specifying `~` as the dag_id, dag_run_id to
retrieve DAG Runs for all DAGs and DAG Runs.
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param dagId The DAG ID.
@@ -606,7 +606,7 @@ func (a *TaskInstanceApiService) GetTaskInstances(ctx
_context.Context, dagId st
/*
GetTaskInstancesBatch Get list of task instances from all DAGs and DAG Runs.
-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
+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 length limits.
* @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param listTaskInstanceForm
@return TaskInstanceCollection
diff --git a/airflow/api_x_com.go b/airflow/api_x_com.go
index b6a5725..1238664 100644
--- a/airflow/api_x_com.go
+++ b/airflow/api_x_com.go
@@ -44,110 +44,6 @@ var (
// XComApiService XComApi service
type XComApiService service
-/*
-DeleteXcomEntry Delete an XCom entry
- * @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param dagId The DAG ID.
- * @param dagRunId The DAG Run ID.
- * @param taskId The Task ID.
- * @param xcomKey The XCom Key.
-*/
-func (a *XComApiService) DeleteXcomEntry(ctx _context.Context, dagId string,
dagRunId string, taskId string, xcomKey string) (*_nethttp.Response, error) {
- var (
- localVarHTTPMethod = _nethttp.MethodDelete
- localVarPostBody interface{}
- localVarFormFileName string
- localVarFileName string
- localVarFileBytes []byte
- )
-
- // create path and map variables
- localVarPath := a.client.cfg.BasePath +
"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}"
- localVarPath = strings.Replace(localVarPath, "{"+"dag_id"+"}",
_neturl.QueryEscape(parameterToString(dagId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"dag_run_id"+"}",
_neturl.QueryEscape(parameterToString(dagRunId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"task_id"+"}",
_neturl.QueryEscape(parameterToString(taskId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"xcom_key"+"}",
_neturl.QueryEscape(parameterToString(xcomKey, "")) , -1)
-
- localVarHeaderParams := make(map[string]string)
- localVarQueryParams := _neturl.Values{}
- localVarFormParams := _neturl.Values{}
-
- // to determine the Content-Type header
- localVarHTTPContentTypes := []string{}
-
- // set Content-Type header
- localVarHTTPContentType :=
selectHeaderContentType(localVarHTTPContentTypes)
- if localVarHTTPContentType != "" {
- localVarHeaderParams["Content-Type"] = localVarHTTPContentType
- }
-
- // to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/json"}
-
- // set Accept header
- localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
- if localVarHTTPHeaderAccept != "" {
- localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
- }
- r, err := a.client.prepareRequest(ctx, localVarPath,
localVarHTTPMethod, localVarPostBody, localVarHeaderParams,
localVarQueryParams, localVarFormParams, localVarFormFileName,
localVarFileName, localVarFileBytes)
- if err != nil {
- return nil, err
- }
-
- localVarHTTPResponse, err := a.client.callAPI(r)
- if err != nil || localVarHTTPResponse == nil {
- return localVarHTTPResponse, err
- }
-
- localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body)
- localVarHTTPResponse.Body.Close()
- if err != nil {
- return localVarHTTPResponse, err
- }
-
- if localVarHTTPResponse.StatusCode >= 300 {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: localVarHTTPResponse.Status,
- }
- if localVarHTTPResponse.StatusCode == 400 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 401 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 403 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarHTTPResponse, newErr
- }
- newErr.model = v
- }
- return localVarHTTPResponse, newErr
- }
-
- return localVarHTTPResponse, nil
-}
-
// GetXcomEntriesOpts Optional parameters for the method 'GetXcomEntries'
type GetXcomEntriesOpts struct {
Limit optional.Int32
@@ -380,256 +276,3 @@ func (a *XComApiService) GetXcomEntry(ctx
_context.Context, dagId string, dagRun
return localVarReturnValue, localVarHTTPResponse, nil
}
-
-// PatchXcomEntryOpts Optional parameters for the method 'PatchXcomEntry'
-type PatchXcomEntryOpts struct {
- UpdateMask optional.Interface
-}
-
-/*
-PatchXcomEntry Update an XCom entry
- * @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param dagId The DAG ID.
- * @param dagRunId The DAG Run ID.
- * @param taskId The Task ID.
- * @param xcomKey The XCom Key.
- * @param xCom
- * @param optional nil or *PatchXcomEntryOpts - Optional Parameters:
- * @param "UpdateMask" (optional.Interface of []string) - The fields to
update on the connection (connection, pool etc). If absent or empty, all
modifiable fields are updated. A comma-separated list of fully qualified names
of fields.
-@return XCom
-*/
-func (a *XComApiService) PatchXcomEntry(ctx _context.Context, dagId string,
dagRunId string, taskId string, xcomKey string, xCom XCom, localVarOptionals
*PatchXcomEntryOpts) (XCom, *_nethttp.Response, error) {
- var (
- localVarHTTPMethod = _nethttp.MethodPatch
- localVarPostBody interface{}
- localVarFormFileName string
- localVarFileName string
- localVarFileBytes []byte
- localVarReturnValue XCom
- )
-
- // create path and map variables
- localVarPath := a.client.cfg.BasePath +
"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}"
- localVarPath = strings.Replace(localVarPath, "{"+"dag_id"+"}",
_neturl.QueryEscape(parameterToString(dagId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"dag_run_id"+"}",
_neturl.QueryEscape(parameterToString(dagRunId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"task_id"+"}",
_neturl.QueryEscape(parameterToString(taskId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"xcom_key"+"}",
_neturl.QueryEscape(parameterToString(xcomKey, "")) , -1)
-
- localVarHeaderParams := make(map[string]string)
- localVarQueryParams := _neturl.Values{}
- localVarFormParams := _neturl.Values{}
-
- if localVarOptionals != nil && localVarOptionals.UpdateMask.IsSet() {
- localVarQueryParams.Add("update_mask",
parameterToString(localVarOptionals.UpdateMask.Value(), "csv"))
- }
- // to determine the Content-Type header
- localVarHTTPContentTypes := []string{"application/json"}
-
- // set Content-Type header
- localVarHTTPContentType :=
selectHeaderContentType(localVarHTTPContentTypes)
- if localVarHTTPContentType != "" {
- localVarHeaderParams["Content-Type"] = localVarHTTPContentType
- }
-
- // to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/json"}
-
- // set Accept header
- localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
- if localVarHTTPHeaderAccept != "" {
- localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
- }
- // body params
- localVarPostBody = &xCom
- r, err := a.client.prepareRequest(ctx, localVarPath,
localVarHTTPMethod, localVarPostBody, localVarHeaderParams,
localVarQueryParams, localVarFormParams, localVarFormFileName,
localVarFileName, localVarFileBytes)
- if err != nil {
- return localVarReturnValue, nil, err
- }
-
- localVarHTTPResponse, err := a.client.callAPI(r)
- if err != nil || localVarHTTPResponse == nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body)
- localVarHTTPResponse.Body.Close()
- if err != nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- if localVarHTTPResponse.StatusCode >= 300 {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: localVarHTTPResponse.Status,
- }
- if localVarHTTPResponse.StatusCode == 400 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 401 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 403 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 404 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- err = a.client.decode(&localVarReturnValue, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: err.Error(),
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- return localVarReturnValue, localVarHTTPResponse, nil
-}
-
-/*
-PostXcomEntries Create an XCom entry
- * @param ctx _context.Context - for authentication, logging, cancellation,
deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param dagId The DAG ID.
- * @param dagRunId The DAG Run ID.
- * @param taskId The Task ID.
- * @param xCom
-@return XCom
-*/
-func (a *XComApiService) PostXcomEntries(ctx _context.Context, dagId string,
dagRunId string, taskId string, xCom XCom) (XCom, *_nethttp.Response, error) {
- var (
- localVarHTTPMethod = _nethttp.MethodPost
- localVarPostBody interface{}
- localVarFormFileName string
- localVarFileName string
- localVarFileBytes []byte
- localVarReturnValue XCom
- )
-
- // create path and map variables
- localVarPath := a.client.cfg.BasePath +
"/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries"
- localVarPath = strings.Replace(localVarPath, "{"+"dag_id"+"}",
_neturl.QueryEscape(parameterToString(dagId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"dag_run_id"+"}",
_neturl.QueryEscape(parameterToString(dagRunId, "")) , -1)
-
- localVarPath = strings.Replace(localVarPath, "{"+"task_id"+"}",
_neturl.QueryEscape(parameterToString(taskId, "")) , -1)
-
- localVarHeaderParams := make(map[string]string)
- localVarQueryParams := _neturl.Values{}
- localVarFormParams := _neturl.Values{}
-
- // to determine the Content-Type header
- localVarHTTPContentTypes := []string{"application/json"}
-
- // set Content-Type header
- localVarHTTPContentType :=
selectHeaderContentType(localVarHTTPContentTypes)
- if localVarHTTPContentType != "" {
- localVarHeaderParams["Content-Type"] = localVarHTTPContentType
- }
-
- // to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/json"}
-
- // set Accept header
- localVarHTTPHeaderAccept :=
selectHeaderAccept(localVarHTTPHeaderAccepts)
- if localVarHTTPHeaderAccept != "" {
- localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
- }
- // body params
- localVarPostBody = &xCom
- r, err := a.client.prepareRequest(ctx, localVarPath,
localVarHTTPMethod, localVarPostBody, localVarHeaderParams,
localVarQueryParams, localVarFormParams, localVarFormFileName,
localVarFileName, localVarFileBytes)
- if err != nil {
- return localVarReturnValue, nil, err
- }
-
- localVarHTTPResponse, err := a.client.callAPI(r)
- if err != nil || localVarHTTPResponse == nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body)
- localVarHTTPResponse.Body.Close()
- if err != nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- if localVarHTTPResponse.StatusCode >= 300 {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: localVarHTTPResponse.Status,
- }
- if localVarHTTPResponse.StatusCode == 400 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 401 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- if localVarHTTPResponse.StatusCode == 403 {
- var v Error
- err = a.client.decode(&v, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue,
localVarHTTPResponse, newErr
- }
- newErr.model = v
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- err = a.client.decode(&localVarReturnValue, localVarBody,
localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr := GenericOpenAPIError{
- body: localVarBody,
- error: err.Error(),
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- return localVarReturnValue, localVarHTTPResponse, nil
-}
diff --git a/airflow/docs/DAGApi.md b/airflow/docs/DAGApi.md
index 68377b4..1dbae54 100644
--- a/airflow/docs/DAGApi.md
+++ b/airflow/docs/DAGApi.md
@@ -24,10 +24,10 @@ All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**GetDag**](DAGApi.md#GetDag) | **Get** /dags/{dag_id} | Get basic
information about a DAG
-[**GetDagDetails**](DAGApi.md#GetDagDetails) | **Get** /dags/{dag_id}/details
| Get a simplified representation of DAG.
+[**GetDagDetails**](DAGApi.md#GetDagDetails) | **Get** /dags/{dag_id}/details
| Get a simplified representation of DAG
[**GetDagSource**](DAGApi.md#GetDagSource) | **Get** /dagSources/{file_token}
| Get source code using file token
[**GetDags**](DAGApi.md#GetDags) | **Get** /dags | Get all DAGs
-[**GetTask**](DAGApi.md#GetTask) | **Get** /dags/{dag_id}/tasks/{task_id} |
Get simplified representation of a task.
+[**GetTask**](DAGApi.md#GetTask) | **Get** /dags/{dag_id}/tasks/{task_id} |
Get simplified representation of a task
[**GetTasks**](DAGApi.md#GetTasks) | **Get** /dags/{dag_id}/tasks | Get tasks
for DAG
[**PatchDag**](DAGApi.md#PatchDag) | **Patch** /dags/{dag_id} | Update a DAG
[**PostClearTaskInstances**](DAGApi.md#PostClearTaskInstances) | **Post**
/dags/{dag_id}/clearTaskInstances | Clears a set of task instances associated
with the DAG for a specified date range.
@@ -72,7 +72,7 @@ No authorization required
> DagDetail GetDagDetails(ctx, dagId)
-Get a simplified representation of DAG.
+Get a simplified representation of DAG
The response contains many DAG attributes, so the response can be large. If
possible, consider using GET /dags/{dag_id}.
@@ -127,7 +127,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
-- **Accept**: application/json
+- **Accept**: application/json, plain/text
[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
@@ -180,7 +180,7 @@ No authorization required
> Task GetTask(ctx, dagId, taskId)
-Get simplified representation of a task.
+Get simplified representation of a task
### Required Parameters
diff --git a/airflow/docs/DAGRunApi.md b/airflow/docs/DAGRunApi.md
index f068abf..064e7ce 100644
--- a/airflow/docs/DAGRunApi.md
+++ b/airflow/docs/DAGRunApi.md
@@ -23,14 +23,47 @@ All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
+[**AirflowApiConnexionEndpointsDagRunEndpointPostDagRun**](DAGRunApi.md#AirflowApiConnexionEndpointsDagRunEndpointPostDagRun)
| **Post** /dags/{dag_id}/dagRuns | Trigger a DAG Run
[**DeleteDagRun**](DAGRunApi.md#DeleteDagRun) | **Delete**
/dags/{dag_id}/dagRuns/{dag_run_id} | Delete a DAG Run
[**GetDagRun**](DAGRunApi.md#GetDagRun) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id} | Get a DAG Run
[**GetDagRuns**](DAGRunApi.md#GetDagRuns) | **Get** /dags/{dag_id}/dagRuns |
Get all DAG Runs
-[**GetDagRunsBatch**](DAGRunApi.md#GetDagRunsBatch) | **Post**
/dags/~/dagRuns/list | Get all DAG Runs from aall DAGs.
-[**PostDagRun**](DAGRunApi.md#PostDagRun) | **Post**
/dags/{dag_id}/dagRuns/{dag_run_id} | Trigger a DAG Run
+[**GetDagRunsBatch**](DAGRunApi.md#GetDagRunsBatch) | **Post**
/dags/~/dagRuns/list | Get all DAG Runs from all DAGs
+## AirflowApiConnexionEndpointsDagRunEndpointPostDagRun
+
+> DagRun AirflowApiConnexionEndpointsDagRunEndpointPostDagRun(ctx, dagId,
dagRun)
+
+Trigger a DAG Run
+
+### Required Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+**ctx** | **context.Context** | context for authentication, logging,
cancellation, deadlines, tracing, etc.
+**dagId** | **string**| The DAG ID. |
+**dagRun** | [**DagRun**](DagRun.md)| |
+
+### Return type
+
+[**DagRun**](DAGRun.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
+
+
## DeleteDagRun
> DeleteDagRun(ctx, dagId, dagRunId)
@@ -153,9 +186,9 @@ No authorization required
> DagRunCollection GetDagRunsBatch(ctx, listDagRunsForm)
-Get all DAG Runs from aall DAGs.
+Get all DAG Runs from all DAGs
-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
+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 length limit.
### Required Parameters
@@ -182,37 +215,3 @@ No authorization required
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
-
-## PostDagRun
-
-> DagRun PostDagRun(ctx, dagId, dagRunId, dagRun)
-
-Trigger a DAG Run
-
-### Required Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
-**ctx** | **context.Context** | context for authentication, logging,
cancellation, deadlines, tracing, etc.
-**dagId** | **string**| The DAG ID. |
-**dagRunId** | **string**| The DAG Run ID. |
-**dagRun** | [**DagRun**](DagRun.md)| |
-
-### Return type
-
-[**DagRun**](DAGRun.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
-[[Back to Model list]](../README.md#documentation-for-models)
-[[Back to README]](../README.md)
-
diff --git a/airflow/docs/DagRun.md b/airflow/docs/DagRun.md
index a277149..41db585 100644
--- a/airflow/docs/DagRun.md
+++ b/airflow/docs/DagRun.md
@@ -23,7 +23,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**DagRunId** | **string** | Run ID. The value of this field can be set only
when creating the object. If you try to modify the field of an existing object,
the request fails with an BAD_REQUEST error. If not provided, a value will be
generated based on execution_date. If the specified dag_run_id is in use, the
creation request fails with an ALREADY_EXISTS error. This together with DAG_ID
are a unique key. | [optional]
+**DagRunId** | Pointer to **string** | Run ID. The value of this field can be
set only when creating the object. If you try to modify the field of an
existing object, the request fails with an BAD_REQUEST error. If not provided,
a value will be generated based on execution_date. If the specified dag_run_id
is in use, the creation request fails with an ALREADY_EXISTS error. This
together with DAG_ID are a unique key. | [optional]
**DagId** | **string** | | [readonly]
**ExecutionDate** | [**time.Time**](time.Time.md) | The execution date. This
is the time when the DAG run should be started according to the DAG definition.
The value of this field can be set only when creating the object. If you try to
modify the field of an existing object, the request fails with an BAD_REQUEST
error. This together with DAG_ID are a unique key. | [optional]
**StartDate** | [**time.Time**](time.Time.md) | The start time. The time when
DAG Run was actually created.. | [optional] [readonly]
diff --git a/airflow/docs/Error.md b/airflow/docs/Error.md
index 83307f9..107fd56 100644
--- a/airflow/docs/Error.md
+++ b/airflow/docs/Error.md
@@ -24,7 +24,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **string** | A URI reference [RFC3986] that identifies the problem
type. This specification encourages that, when dereferenced, it provide
human-readable documentation for the problem type. |
-**Title** | **string** | A short, human-readable summary of the problem type.
|
+**Title** | **string** | A short, human-readable summary of the problem type.
|
**Status** | **float32** | The HTTP status code generated by the API server
for this occurrence of the problem. |
**Detail** | **string** | A human-readable explanation specific to this
occurrence of the problem. | [optional]
**Instance** | **string** | A URI reference that identifies the specific
occurrence of the problem. It may or may not yield further information if
dereferenced. | [optional]
diff --git a/airflow/docs/Error.md b/airflow/docs/HealthInfo.md
similarity index 60%
copy from airflow/docs/Error.md
copy to airflow/docs/HealthInfo.md
index 83307f9..bd89453 100644
--- a/airflow/docs/Error.md
+++ b/airflow/docs/HealthInfo.md
@@ -17,17 +17,14 @@
under the License.
-->
-# Error
+# HealthInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Type** | **string** | A URI reference [RFC3986] that identifies the problem
type. This specification encourages that, when dereferenced, it provide
human-readable documentation for the problem type. |
-**Title** | **string** | A short, human-readable summary of the problem type.
|
-**Status** | **float32** | The HTTP status code generated by the API server
for this occurrence of the problem. |
-**Detail** | **string** | A human-readable explanation specific to this
occurrence of the problem. | [optional]
-**Instance** | **string** | A URI reference that identifies the specific
occurrence of the problem. It may or may not yield further information if
dereferenced. | [optional]
+**Metadatabase** | [**MetadatabaseStatus**](MetadatabaseStatus.md) | |
[optional]
+**Scheduler** | [**SchedulerStatus**](SchedulerStatus.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API
list]](../README.md#documentation-for-api-endpoints) [[Back to
README]](../README.md)
diff --git a/airflow/docs/Error.md b/airflow/docs/HealthStatus.md
similarity index 60%
copy from airflow/docs/Error.md
copy to airflow/docs/HealthStatus.md
index 83307f9..573e9be 100644
--- a/airflow/docs/Error.md
+++ b/airflow/docs/HealthStatus.md
@@ -17,17 +17,12 @@
under the License.
-->
-# Error
+# HealthStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Type** | **string** | A URI reference [RFC3986] that identifies the problem
type. This specification encourages that, when dereferenced, it provide
human-readable documentation for the problem type. |
-**Title** | **string** | A short, human-readable summary of the problem type.
|
-**Status** | **float32** | The HTTP status code generated by the API server
for this occurrence of the problem. |
-**Detail** | **string** | A human-readable explanation specific to this
occurrence of the problem. | [optional]
-**Instance** | **string** | A URI reference that identifies the specific
occurrence of the problem. It may or may not yield further information if
dereferenced. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API
list]](../README.md#documentation-for-api-endpoints) [[Back to
README]](../README.md)
diff --git a/airflow/docs/Error.md b/airflow/docs/MetadatabaseStatus.md
similarity index 60%
copy from airflow/docs/Error.md
copy to airflow/docs/MetadatabaseStatus.md
index 83307f9..a88919e 100644
--- a/airflow/docs/Error.md
+++ b/airflow/docs/MetadatabaseStatus.md
@@ -17,17 +17,13 @@
under the License.
-->
-# Error
+# MetadatabaseStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Type** | **string** | A URI reference [RFC3986] that identifies the problem
type. This specification encourages that, when dereferenced, it provide
human-readable documentation for the problem type. |
-**Title** | **string** | A short, human-readable summary of the problem type.
|
-**Status** | **float32** | The HTTP status code generated by the API server
for this occurrence of the problem. |
-**Detail** | **string** | A human-readable explanation specific to this
occurrence of the problem. | [optional]
-**Instance** | **string** | A URI reference that identifies the specific
occurrence of the problem. It may or may not yield further information if
dereferenced. | [optional]
+**Status** | [**HealthStatus**](HealthStatus.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API
list]](../README.md#documentation-for-api-endpoints) [[Back to
README]](../README.md)
diff --git a/airflow/docs/MonitoringApi.md b/airflow/docs/MonitoringApi.md
index 9e6add6..ca438a5 100644
--- a/airflow/docs/MonitoringApi.md
+++ b/airflow/docs/MonitoringApi.md
@@ -23,16 +23,16 @@ All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**GetHealth**](MonitoringApi.md#GetHealth) | **Get** /health | Checks if the
API works
+[**GetHealth**](MonitoringApi.md#GetHealth) | **Get** /health | Returns the
status of Airflow's metadatabase and scheduler
[**GetVersion**](MonitoringApi.md#GetVersion) | **Get** /version | Get version
information
## GetHealth
-> string GetHealth(ctx, )
+> HealthInfo GetHealth(ctx, )
-Checks if the API works
+Returns the status of Airflow's metadatabase and scheduler
### Required Parameters
@@ -40,7 +40,7 @@ This endpoint does not need any parameter.
### Return type
-**string**
+[**HealthInfo**](HealthInfo.md)
### Authorization
@@ -49,7 +49,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
-- **Accept**: text/plain
+- **Accept**: application/json
[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
diff --git a/airflow/docs/Error.md b/airflow/docs/SchedulerStatus.md
similarity index 60%
copy from airflow/docs/Error.md
copy to airflow/docs/SchedulerStatus.md
index 83307f9..2df21d0 100644
--- a/airflow/docs/Error.md
+++ b/airflow/docs/SchedulerStatus.md
@@ -17,17 +17,14 @@
under the License.
-->
-# Error
+# SchedulerStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Type** | **string** | A URI reference [RFC3986] that identifies the problem
type. This specification encourages that, when dereferenced, it provide
human-readable documentation for the problem type. |
-**Title** | **string** | A short, human-readable summary of the problem type.
|
-**Status** | **float32** | The HTTP status code generated by the API server
for this occurrence of the problem. |
-**Detail** | **string** | A human-readable explanation specific to this
occurrence of the problem. | [optional]
-**Instance** | **string** | A URI reference that identifies the specific
occurrence of the problem. It may or may not yield further information if
dereferenced. | [optional]
+**Status** | [**HealthStatus**](HealthStatus.md) | | [optional]
+**LatestSchedulerHeartbeat** | Pointer to **string** | | [optional]
[readonly]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API
list]](../README.md#documentation-for-api-endpoints) [[Back to
README]](../README.md)
diff --git a/airflow/docs/TaskInstanceApi.md b/airflow/docs/TaskInstanceApi.md
index 505d4c5..23742b0 100644
--- a/airflow/docs/TaskInstanceApi.md
+++ b/airflow/docs/TaskInstanceApi.md
@@ -26,7 +26,7 @@ Method | HTTP request | Description
[**GetExtraLinks**](TaskInstanceApi.md#GetExtraLinks) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links | Get extra
links for task instance
[**GetLog**](TaskInstanceApi.md#GetLog) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}
| Get logs for a task instance
[**GetTaskInstance**](TaskInstanceApi.md#GetTaskInstance) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} | Get a task
instance
-[**GetTaskInstances**](TaskInstanceApi.md#GetTaskInstances) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances | Get a list of task instance
of DAG.
+[**GetTaskInstances**](TaskInstanceApi.md#GetTaskInstances) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances | Get a list of task instance
of DAG
[**GetTaskInstancesBatch**](TaskInstanceApi.md#GetTaskInstancesBatch) |
**Post** /dags/~/dagRuns/~/taskInstances/list | Get list of task instances from
all DAGs and DAG Runs.
@@ -155,7 +155,7 @@ No authorization required
> TaskInstanceCollection GetTaskInstances(ctx, dagId, dagRunId, optional)
-Get a list of task instance of DAG.
+Get a list of task instance of DAG
This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve DAG
Runs for all DAGs and DAG Runs.
@@ -216,7 +216,7 @@ No authorization required
Get list of task instances from all DAGs and DAG Runs.
-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
+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 length limits.
### Required Parameters
diff --git a/airflow/docs/XComApi.md b/airflow/docs/XComApi.md
index 9a042c1..c5ee73e 100644
--- a/airflow/docs/XComApi.md
+++ b/airflow/docs/XComApi.md
@@ -23,49 +23,11 @@ All URIs are relative to *http://localhost/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**DeleteXcomEntry**](XComApi.md#DeleteXcomEntry) | **Delete**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
| Delete an XCom entry
[**GetXcomEntries**](XComApi.md#GetXcomEntries) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries | Get
all XCom entries
[**GetXcomEntry**](XComApi.md#GetXcomEntry) | **Get**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
| Get an XCom entry
-[**PatchXcomEntry**](XComApi.md#PatchXcomEntry) | **Patch**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}
| Update an XCom entry
-[**PostXcomEntries**](XComApi.md#PostXcomEntries) | **Post**
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries |
Create an XCom entry
-## DeleteXcomEntry
-
-> DeleteXcomEntry(ctx, dagId, dagRunId, taskId, xcomKey)
-
-Delete an XCom entry
-
-### Required Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
-**ctx** | **context.Context** | context for authentication, logging,
cancellation, deadlines, tracing, etc.
-**dagId** | **string**| The DAG ID. |
-**dagRunId** | **string**| The DAG Run ID. |
-**taskId** | **string**| The Task ID. |
-**xcomKey** | **string**| The XCom Key. |
-
-### Return type
-
- (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
-[[Back to Model list]](../README.md#documentation-for-models)
-[[Back to README]](../README.md)
-
-
## GetXcomEntries
> XComCollection GetXcomEntries(ctx, dagId, dagRunId, taskId, optional)
@@ -150,89 +112,3 @@ No authorization required
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
-
-## PatchXcomEntry
-
-> XCom PatchXcomEntry(ctx, dagId, dagRunId, taskId, xcomKey, xCom, optional)
-
-Update an XCom entry
-
-### Required Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
-**ctx** | **context.Context** | context for authentication, logging,
cancellation, deadlines, tracing, etc.
-**dagId** | **string**| The DAG ID. |
-**dagRunId** | **string**| The DAG Run ID. |
-**taskId** | **string**| The Task ID. |
-**xcomKey** | **string**| The XCom Key. |
-**xCom** | [**XCom**](XCom.md)| |
- **optional** | ***PatchXcomEntryOpts** | optional parameters | nil if no
parameters
-
-### Optional Parameters
-
-Optional parameters are passed through a pointer to a PatchXcomEntryOpts struct
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
-
-
-
-
-
- **updateMask** | [**optional.Interface of []string**](string.md)| The fields
to update on the connection (connection, pool etc). If absent or empty, all
modifiable fields are updated. A comma-separated list of fully qualified names
of fields. |
-
-### Return type
-
-[**XCom**](XCom.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
-[[Back to Model list]](../README.md#documentation-for-models)
-[[Back to README]](../README.md)
-
-
-## PostXcomEntries
-
-> XCom PostXcomEntries(ctx, dagId, dagRunId, taskId, xCom)
-
-Create an XCom entry
-
-### Required Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
-**ctx** | **context.Context** | context for authentication, logging,
cancellation, deadlines, tracing, etc.
-**dagId** | **string**| The DAG ID. |
-**dagRunId** | **string**| The DAG Run ID. |
-**taskId** | **string**| The Task ID. |
-**xCom** | [**XCom**](XCom.md)| |
-
-### Return type
-
-[**XCom**](XCom.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-[[Back to top]](#) [[Back to API
list]](../README.md#documentation-for-api-endpoints)
-[[Back to Model list]](../README.md#documentation-for-models)
-[[Back to README]](../README.md)
-
diff --git a/airflow/go.mod b/airflow/go.mod
index 49a585e..2c7d3fa 100644
--- a/airflow/go.mod
+++ b/airflow/go.mod
@@ -1,4 +1,4 @@
-module github.com/apache/airflow/clients/go/airflow
+module github.com/apache/airflow-client-go/airflow
require (
github.com/antihax/optional v1.0.0
diff --git a/airflow/model_dag_run.go b/airflow/model_dag_run.go
index 2b50c48..64f31e3 100644
--- a/airflow/model_dag_run.go
+++ b/airflow/model_dag_run.go
@@ -32,7 +32,7 @@ import (
// DagRun struct for DagRun
type DagRun struct {
// Run ID. The value of this field can be set only when creating the
object. If you try to modify the field of an existing object, the request fails
with an BAD_REQUEST error. If not provided, a value will be generated based on
execution_date. If the specified dag_run_id is in use, the creation request
fails with an ALREADY_EXISTS error. This together with DAG_ID are a unique key.
- DagRunId string `json:"dag_run_id,omitempty"`
+ DagRunId *string `json:"dag_run_id,omitempty"`
DagId string `json:"dag_id"`
// The execution date. This is the time when the DAG run should be
started according to the DAG definition. The value of this field can be set
only when creating the object. If you try to modify the field of an existing
object, the request fails with an BAD_REQUEST error. This together with DAG_ID
are a unique key.
ExecutionDate time.Time `json:"execution_date,omitempty"`
diff --git a/airflow/model_error.go b/airflow/model_error.go
index 2a935ee..0230084 100644
--- a/airflow/model_error.go
+++ b/airflow/model_error.go
@@ -30,7 +30,7 @@ package airflow
type Error struct {
// A URI reference [RFC3986] that identifies the problem type. This
specification encourages that, when dereferenced, it provide human-readable
documentation for the problem type.
Type string `json:"type"`
- // A short, human-readable summary of the problem type.
+ // A short, human-readable summary of the problem type.
Title string `json:"title"`
// The HTTP status code generated by the API server for this occurrence
of the problem.
Status float32 `json:"status"`
diff --git a/airflow/model_task_state.go b/airflow/model_health_info.go
similarity index 65%
copy from airflow/model_task_state.go
copy to airflow/model_health_info.go
index fce2051..7966f10 100644
--- a/airflow/model_task_state.go
+++ b/airflow/model_health_info.go
@@ -26,19 +26,8 @@
*/
package airflow
-// TaskState the model 'TaskState'
-type TaskState string
-
-// List of TaskState
-const (
- TASKSTATE_SUCCCESS TaskState = "succcess"
- TASKSTATE_RUNNING TaskState = "running"
- TASKSTATE_FAILED TaskState = "failed"
- TASKSTATE_UPSTREAM_FAILED TaskState = "upstream_failed"
- TASKSTATE_SKIPPED TaskState = "skipped"
- TASKSTATE_UP_FOR_RETRY TaskState = "up_for_retry"
- TASKSTATE_UP_FOR_RESCHEDULE TaskState = "up_for_reschedule"
- TASKSTATE_QUEUED TaskState = "queued"
- TASKSTATE_NONE TaskState = "none"
- TASKSTATE_SCHEDULED TaskState = "scheduled"
-)
+// HealthInfo struct for HealthInfo
+type HealthInfo struct {
+ Metadatabase MetadatabaseStatus `json:"metadatabase,omitempty"`
+ Scheduler SchedulerStatus `json:"scheduler,omitempty"`
+}
diff --git a/airflow/model_task_state.go b/airflow/model_health_status.go
similarity index 65%
copy from airflow/model_task_state.go
copy to airflow/model_health_status.go
index fce2051..678c655 100644
--- a/airflow/model_task_state.go
+++ b/airflow/model_health_status.go
@@ -26,19 +26,11 @@
*/
package airflow
-// TaskState the model 'TaskState'
-type TaskState string
+// HealthStatus the model 'HealthStatus'
+type HealthStatus string
-// List of TaskState
+// List of HealthStatus
const (
- TASKSTATE_SUCCCESS TaskState = "succcess"
- TASKSTATE_RUNNING TaskState = "running"
- TASKSTATE_FAILED TaskState = "failed"
- TASKSTATE_UPSTREAM_FAILED TaskState = "upstream_failed"
- TASKSTATE_SKIPPED TaskState = "skipped"
- TASKSTATE_UP_FOR_RETRY TaskState = "up_for_retry"
- TASKSTATE_UP_FOR_RESCHEDULE TaskState = "up_for_reschedule"
- TASKSTATE_QUEUED TaskState = "queued"
- TASKSTATE_NONE TaskState = "none"
- TASKSTATE_SCHEDULED TaskState = "scheduled"
+ HEALTHSTATUS_HEALTHY HealthStatus = "healthy"
+ HEALTHSTATUS_UNHEALTHY HealthStatus = "unhealthy"
)
diff --git a/airflow/model_task_state.go b/airflow/model_metadatabase_status.go
similarity index 65%
copy from airflow/model_task_state.go
copy to airflow/model_metadatabase_status.go
index fce2051..96db3dc 100644
--- a/airflow/model_task_state.go
+++ b/airflow/model_metadatabase_status.go
@@ -26,19 +26,7 @@
*/
package airflow
-// TaskState the model 'TaskState'
-type TaskState string
-
-// List of TaskState
-const (
- TASKSTATE_SUCCCESS TaskState = "succcess"
- TASKSTATE_RUNNING TaskState = "running"
- TASKSTATE_FAILED TaskState = "failed"
- TASKSTATE_UPSTREAM_FAILED TaskState = "upstream_failed"
- TASKSTATE_SKIPPED TaskState = "skipped"
- TASKSTATE_UP_FOR_RETRY TaskState = "up_for_retry"
- TASKSTATE_UP_FOR_RESCHEDULE TaskState = "up_for_reschedule"
- TASKSTATE_QUEUED TaskState = "queued"
- TASKSTATE_NONE TaskState = "none"
- TASKSTATE_SCHEDULED TaskState = "scheduled"
-)
+// MetadatabaseStatus Returns the status of the metadatabase
+type MetadatabaseStatus struct {
+ Status HealthStatus `json:"status,omitempty"`
+}
diff --git a/airflow/model_task_state.go b/airflow/model_scheduler_status.go
similarity index 65%
copy from airflow/model_task_state.go
copy to airflow/model_scheduler_status.go
index fce2051..e782a7f 100644
--- a/airflow/model_task_state.go
+++ b/airflow/model_scheduler_status.go
@@ -26,19 +26,8 @@
*/
package airflow
-// TaskState the model 'TaskState'
-type TaskState string
-
-// List of TaskState
-const (
- TASKSTATE_SUCCCESS TaskState = "succcess"
- TASKSTATE_RUNNING TaskState = "running"
- TASKSTATE_FAILED TaskState = "failed"
- TASKSTATE_UPSTREAM_FAILED TaskState = "upstream_failed"
- TASKSTATE_SKIPPED TaskState = "skipped"
- TASKSTATE_UP_FOR_RETRY TaskState = "up_for_retry"
- TASKSTATE_UP_FOR_RESCHEDULE TaskState = "up_for_reschedule"
- TASKSTATE_QUEUED TaskState = "queued"
- TASKSTATE_NONE TaskState = "none"
- TASKSTATE_SCHEDULED TaskState = "scheduled"
-)
+// SchedulerStatus Returns the status and the latest scheduler heartbeat
+type SchedulerStatus struct {
+ Status HealthStatus `json:"status,omitempty"`
+ LatestSchedulerHeartbeat *string
`json:"latest_scheduler_heartbeat,omitempty"`
+}
diff --git a/airflow/model_task_state.go b/airflow/model_task_state.go
index fce2051..5983a29 100644
--- a/airflow/model_task_state.go
+++ b/airflow/model_task_state.go
@@ -31,7 +31,7 @@ type TaskState string
// List of TaskState
const (
- TASKSTATE_SUCCCESS TaskState = "succcess"
+ TASKSTATE_SUCCESS TaskState = "success"
TASKSTATE_RUNNING TaskState = "running"
TASKSTATE_FAILED TaskState = "failed"
TASKSTATE_UPSTREAM_FAILED TaskState = "upstream_failed"
