Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
under the License.
-->

# v2.5.0

Apache Airflow API version: 2.5.x
# v2.7.0

Apache Airflow API version: 2.7.x

### Major changes:

Expand All @@ -31,11 +32,4 @@ Apache Airflow API version: 2.5.x

### New API supported:

- GET /datasets/events | Get dataset events
- GET /datasets | Get datasets
- GET /datasets/{id} | Get a dataset
- POST /dags/{dag_id}/dagRuns/{dag_run_id}/clear | Clear a dagrun endpoint
- GET /dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents | Get dataset events for a DAG run
- PATCH /dags | Update DAGs
- GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} | Get a mapped task instance
- GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped | List mapped task instances
- Enable pools to consider deferred tasks
4 changes: 4 additions & 0 deletions airflow/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ docs/DAGRun.md
docs/DAGRunApi.md
docs/DAGRunCollection.md
docs/DAGRunCollectionAllOf.md
docs/DagProcessorStatus.md
docs/DagScheduleDatasetReference.md
docs/DagState.md
docs/DagWarning.md
Expand Down Expand Up @@ -123,6 +124,7 @@ docs/TaskState.md
docs/TimeDelta.md
docs/Trigger.md
docs/TriggerRule.md
docs/TriggererStatus.md
docs/UpdateDagRunState.md
docs/UpdateTaskInstance.md
docs/UpdateTaskInstancesState.md
Expand Down Expand Up @@ -173,6 +175,7 @@ model_dag_collection.go
model_dag_collection_all_of.go
model_dag_detail.go
model_dag_detail_all_of.go
model_dag_processor_status.go
model_dag_run.go
model_dag_run_collection.go
model_dag_run_collection_all_of.go
Expand Down Expand Up @@ -236,6 +239,7 @@ model_task_state.go
model_time_delta.go
model_trigger.go
model_trigger_rule.go
model_triggerer_status.go
model_update_dag_run_state.go
model_update_task_instance.go
model_update_task_instances_state.go
Expand Down
2 changes: 1 addition & 1 deletion airflow/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.3.0
5.4.0
35 changes: 20 additions & 15 deletions airflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ resource in the response body.

### Delete

Deleting a resource requires the resource `id` and is typically executing via an HTTP `DELETE` request.
Deleting a resource requires the resource `id` and is typically executed via an HTTP `DELETE` request.
The response usually returns a `204 No Content` response code upon success.

## Conventions
Expand All @@ -96,12 +96,14 @@ The response usually returns a `204 No Content` response code upon success.
- Field names are in snake_case.
```json
{
\"description\": \"string\",
\"name\": \"string\",
\"slots\": 0,
\"occupied_slots\": 0,
\"used_slots\": 0,
\"queued_slots\": 0,
\"open_slots\": 0
\"queued_slots\": 0,
\"running_slots\": 0,
\"scheduled_slots\": 0,
\"slots\": 0,
}
```

Expand Down Expand Up @@ -147,7 +149,7 @@ curl -X PATCH 'https://example.com/api/v1/dags/{dag_id}?update_mask=is_paused' \
Using a graphical tool such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/),
it is possible to import the API specifications directly:

1. Download the API specification by clicking the **Download** button at top of this document
1. Download the API specification by clicking the **Download** button at the top of this document
2. Import the JSON specification in the graphical tool of your choice.
- In *Postman*, you can click the **import** button at the top
- With *Insomnia*, you can just drag-and-drop the file on the UI
Expand Down Expand Up @@ -232,7 +234,7 @@ fulfilling the request.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 2.5.0
- API version: 2.7.0
- Package version: 2.5.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://airflow.apache.org](https://airflow.apache.org)
Expand All @@ -250,7 +252,7 @@ go get golang.org/x/net/context
Put the package under your project folder and add the following in import:

```golang
import sw "./airflow"
import airflow "github.com/apache/airflow-client-go/airflow"
```

To use a proxy, set the environment variable `HTTP_PROXY`:
Expand All @@ -268,15 +270,15 @@ Default configuration comes with `Servers` field that contains server objects as
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.

```golang
ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
ctx := context.WithValue(context.Background(), airflow.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.

```golang
ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
ctx := context.WithValue(context.Background(), airflow.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Expand All @@ -290,10 +292,10 @@ An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.

```
ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
ctx := context.WithValue(context.Background(), airflow.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
ctx = context.WithValue(context.Background(), airflow.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
Expand All @@ -302,11 +304,12 @@ ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables

## Documentation for API Endpoints

All URIs are relative to *http://localhost/api/v1*
All URIs are relative to */api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConfigApi* | [**GetConfig**](docs/ConfigApi.md#getconfig) | **Get** /config | Get current configuration
*ConfigApi* | [**GetValue**](docs/ConfigApi.md#getvalue) | **Get** /config/section/{section}/option/{option} | Get a option from configuration
*ConnectionApi* | [**DeleteConnection**](docs/ConnectionApi.md#deleteconnection) | **Delete** /connections/{connection_id} | Delete a connection
*ConnectionApi* | [**GetConnection**](docs/ConnectionApi.md#getconnection) | **Get** /connections/{connection_id} | Get a connection
*ConnectionApi* | [**GetConnections**](docs/ConnectionApi.md#getconnections) | **Get** /connections | List connections
Expand All @@ -324,15 +327,13 @@ Class | Method | HTTP request | Description
*DAGApi* | [**PatchDags**](docs/DAGApi.md#patchdags) | **Patch** /dags | Update DAGs
*DAGApi* | [**PostClearTaskInstances**](docs/DAGApi.md#postcleartaskinstances) | **Post** /dags/{dag_id}/clearTaskInstances | Clear a set of task instances
*DAGApi* | [**PostSetTaskInstancesState**](docs/DAGApi.md#postsettaskinstancesstate) | **Post** /dags/{dag_id}/updateTaskInstancesState | Set a state of task instances
*DAGApi* | [**SetMappedTaskInstanceNote**](docs/DAGApi.md#setmappedtaskinstancenote) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote | Update the TaskInstance note.
*DAGApi* | [**SetTaskInstanceNote**](docs/DAGApi.md#settaskinstancenote) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNote | Update the TaskInstance note.
*DAGRunApi* | [**ClearDagRun**](docs/DAGRunApi.md#cleardagrun) | **Post** /dags/{dag_id}/dagRuns/{dag_run_id}/clear | Clear 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 | List DAG runs
*DAGRunApi* | [**GetDagRunsBatch**](docs/DAGRunApi.md#getdagrunsbatch) | **Post** /dags/~/dagRuns/list | List DAG runs (batch)
*DAGRunApi* | [**GetUpstreamDatasetEvents**](docs/DAGRunApi.md#getupstreamdatasetevents) | **Get** /dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents | Get dataset events for a DAG run
*DAGRunApi* | [**PostDagRun**](docs/DAGRunApi.md#postdagrun) | **Post** /dags/{dag_id}/dagRuns | Trigger a new DAG run
*DAGRunApi* | [**PostDagRun**](docs/DAGRunApi.md#postdagrun) | **Post** /dags/{dag_id}/dagRuns | Trigger a new DAG run.
*DAGRunApi* | [**SetDagRunNote**](docs/DAGRunApi.md#setdagrunnote) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/setNote | Update the DagRun note.
*DAGRunApi* | [**UpdateDagRunState**](docs/DAGRunApi.md#updatedagrunstate) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id} | Modify a DAG run
*DagWarningApi* | [**GetDagWarnings**](docs/DagWarningApi.md#getdagwarnings) | **Get** /dagWarnings | List dag warnings
Expand Down Expand Up @@ -368,6 +369,8 @@ Class | Method | HTTP request | Description
*TaskInstanceApi* | [**GetTaskInstancesBatch**](docs/TaskInstanceApi.md#gettaskinstancesbatch) | **Post** /dags/~/dagRuns/~/taskInstances/list | List task instances (batch)
*TaskInstanceApi* | [**PatchMappedTaskInstance**](docs/TaskInstanceApi.md#patchmappedtaskinstance) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} | Updates the state of a mapped task instance
*TaskInstanceApi* | [**PatchTaskInstance**](docs/TaskInstanceApi.md#patchtaskinstance) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} | Updates the state of a task instance
*TaskInstanceApi* | [**SetMappedTaskInstanceNote**](docs/TaskInstanceApi.md#setmappedtaskinstancenote) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote | Update the TaskInstance note.
*TaskInstanceApi* | [**SetTaskInstanceNote**](docs/TaskInstanceApi.md#settaskinstancenote) | **Patch** /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNote | Update the TaskInstance note.
*UserApi* | [**DeleteUser**](docs/UserApi.md#deleteuser) | **Delete** /users/{username} | Delete a user
*UserApi* | [**GetUser**](docs/UserApi.md#getuser) | **Get** /users/{username} | Get a user
*UserApi* | [**GetUsers**](docs/UserApi.md#getusers) | **Get** /users | List users
Expand Down Expand Up @@ -411,6 +414,7 @@ Class | Method | HTTP request | Description
- [DAGRun](docs/DAGRun.md)
- [DAGRunCollection](docs/DAGRunCollection.md)
- [DAGRunCollectionAllOf](docs/DAGRunCollectionAllOf.md)
- [DagProcessorStatus](docs/DagProcessorStatus.md)
- [DagScheduleDatasetReference](docs/DagScheduleDatasetReference.md)
- [DagState](docs/DagState.md)
- [DagWarning](docs/DagWarning.md)
Expand Down Expand Up @@ -471,6 +475,7 @@ Class | Method | HTTP request | Description
- [TimeDelta](docs/TimeDelta.md)
- [Trigger](docs/Trigger.md)
- [TriggerRule](docs/TriggerRule.md)
- [TriggererStatus](docs/TriggererStatus.md)
- [UpdateDagRunState](docs/UpdateDagRunState.md)
- [UpdateTaskInstance](docs/UpdateTaskInstance.md)
- [UpdateTaskInstancesState](docs/UpdateTaskInstancesState.md)
Expand Down
Loading