uranusjr commented on a change in pull request #19203:
URL: https://github.com/apache/airflow/pull/19203#discussion_r736952598
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2700,20 +2860,29 @@ components:
- $ref: '#/components/schemas/CollectionInfo'
Role:
- description: Role item
+ description: |
+ Role item
+
+ *New in version 2.1.0*
type: object
properties:
name:
type: string
- description: The name of the role
+ description: |
+ The name of the role
+
+ *Changed in version 2.3.0: A minimum character length
requirement('minLength') has been added.
Review comment:
```suggestion
*Changed in version 2.3.0*: A minimum character length
requirement ('minLength') is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3226,7 +3419,10 @@ components:
- removed
DagState:
- description: DAG State.
+ description: |
+ DAG State.
+
+ *Changed in version 2.1.3:'queued' added to Enum
Review comment:
```suggestion
*Changed in version 2.1.3*: 'queued' is added as a possible
value.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1576,6 +1612,10 @@ paths:
patch:
summary: Update a role
+ description: |
+ Update a role
Review comment:
```suggestion
Update a role.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1528,6 +1556,10 @@ paths:
post:
summary: Create a role
+ description: |
+ Create a new role
Review comment:
```suggestion
Create a new role.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1715,6 +1775,10 @@ paths:
patch:
summary: Update a user
+ description: |
+ Update fields for a user
Review comment:
```suggestion
Update fields for a user.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3208,7 +3394,14 @@ components:
# Enums
TaskState:
- description: Task state.
+ description: |
+ Task state.
+
+ *Changed in version 2.0.2:'removed' added to Enum
+
+ *Changed in version 2.2.0:'deferred' added to Enum
+
+ *Changed in version 2.2.0:'sensing' added to Enum
Review comment:
```suggestion
*Changed in version 2.0.2*: 'removed' is added as a possible
value.
*Changed in version 2.2.0*: 'deferred' and 'sensing' is added as
a possible value.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2029,13 +2136,19 @@ components:
The execution date. This is the same as logical_date, kept for
backwards compatibility.
If both this field and logical_date are provided but with
different values, the request
will fail with an BAD_REQUEST error.
+
+ *Changed in version 2.2.0*: Field becomes nullable
+
+ *Deprecated since version 2.2.0*: Use 'logical_date' instead
Review comment:
```suggestion
*Changed in version 2.2.0*: Field becomes nullable.
*Deprecated since version 2.2.0*: Use 'logical_date' instead.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1481,9 +1500,14 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/VersionInfo'
+
/plugins:
get:
summary: Get a list of loaded plugins
+ description: |
+ Get all loaded plugins
Review comment:
```suggestion
Get a list of loaded plugins.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -705,7 +717,10 @@ paths:
patch:
summary: Modify a DAG run
- description: Modify a DAG run
+ description: |
+ Modify a DAG run
Review comment:
```suggestion
Modify a DAG run.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1696,6 +1752,10 @@ paths:
- $ref: '#/components/parameters/Username'
get:
summary: Get a user
+ description: |
+ Get a user with a specific username
Review comment:
```suggestion
Get a user with a specific username.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1764,25 +1832,39 @@ components:
schemas:
# Database entities
UserCollectionItem:
- description: >
+ description: |
A user object
+
+ *New in version 2.1.0*
type: object
properties:
first_name:
type: string
- description: The user firstname
+ description: |
+ The user firstname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
minLength: 1
last_name:
type: string
- description: The user lastname
+ description: |
+ The user lastname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
minLength: 1
username:
type: string
- description: The username
+ description: |
+ The username
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
minLength: 1
email:
type: string
- description: The user's email
+ description: |
+ The user's email
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
Review comment:
```suggestion
The user's email.
*Changed in version 2.2.0*: A minimum character length
requirement ('minLength') is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2447,7 +2591,10 @@ components:
XComCollection:
type: object
- description: Collection of XCom entries.
+ description: |
+ Collection of XCom entries.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2510,6 +2659,10 @@ components:
params:
type: object
readOnly: true
+ description: |
+ Params
Review comment:
```suggestion
User-specified DAG params.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2689,7 +2846,10 @@ components:
PluginCollection:
type: object
- description: Plugin Collection
+ description: |
+ Plugin Collection
Review comment:
```suggestion
A collection of plugin.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2497,6 +2644,8 @@ components:
format: 'date-time'
readOnly: true
nullable: true
+ description: |
+ *Changed in version 2.0.1*: Field becomes nullable.
Review comment:
```suggestion
description: |
The DAG's start date.
*Changed in version 2.0.1*: Field becomes nullable.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2734,7 +2906,10 @@ components:
nullable: false
ActionCollection:
- description: Action Collection
+ description: |
+ Action Collection
Review comment:
```suggestion
A collection of actions.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1937,7 +2034,12 @@ components:
nullable: true
description: Whether the DAG is paused.
is_active:
- description: Whether the DAG is currently seen by the scheduler(s).
+ description: |
+ Whether the DAG is currently seen by the scheduler(s).
+
+ *New in version 2.1.1*
+
+ *Changed in version 2.2.0: Field is read-only.*
Review comment:
```suggestion
*Changed in version 2.2.0*: Field is read-only.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3292,7 +3491,10 @@ components:
schema:
type: string
required: true
- description: The username of the user
+ description: |
+ The username of the user
Review comment:
```suggestion
The username of the user.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1645,6 +1693,10 @@ paths:
/users:
get:
summary: List users
+ description: |
+ Get users
Review comment:
```suggestion
Get a list of users.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2746,7 +2921,10 @@ components:
- $ref: '#/components/schemas/CollectionInfo'
Resource:
- description: A "resource" on which permissions are granted.
+ description: |
+ A `resource` on which permissions are granted.
Review comment:
```suggestion
A resource on which permissions are granted.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1507,6 +1531,10 @@ paths:
/roles:
get:
summary: List roles
+ description: |
+ Get roles
Review comment:
```suggestion
Get a list of roles.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1606,6 +1646,10 @@ paths:
delete:
summary: Delete a role
+ description: |
+ Delete a role
Review comment:
```suggestion
Delete a role.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3235,7 +3431,10 @@ components:
- failed
TriggerRule:
- description: Trigger rule.
+ description: |
+ Trigger rule.
+
+ *Changed in version 2.2.0*: 'none_failed_min_one_success' added to
Enum
Review comment:
```suggestion
*Changed in version 2.2.0*: 'none_failed_min_one_success' is
added as a possible value.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1744,6 +1808,10 @@ paths:
delete:
summary: Delete a user
+ description: |
+ Delete a user with a specific username
Review comment:
```suggestion
Delete a user with a specific username.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1624,6 +1668,10 @@ paths:
/permissions:
get:
summary: List permissions
+ description: |
+ Get permissions
Review comment:
```suggestion
Get a list of permissions.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1764,25 +1832,39 @@ components:
schemas:
# Database entities
UserCollectionItem:
- description: >
+ description: |
A user object
+
+ *New in version 2.1.0*
Review comment:
```suggestion
description: |
A user object.
*New in version 2.1.0*
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1557,6 +1589,10 @@ paths:
get:
summary: Get a role
+ description: |
+ Get role
Review comment:
```suggestion
Get a role.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1807,7 +1889,10 @@ components:
nullable: true
roles:
type: array
- description: User roles
+ description: |
+ User roles
Review comment:
```suggestion
User roles.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2072,7 +2189,10 @@ components:
DAGRunCollection:
type: object
- description: Collection of DAG runs.
+ description: |
+ Collection of DAG runs.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1764,25 +1832,39 @@ components:
schemas:
# Database entities
UserCollectionItem:
- description: >
+ description: |
A user object
+
+ *New in version 2.1.0*
type: object
properties:
first_name:
type: string
- description: The user firstname
+ description: |
+ The user firstname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
minLength: 1
last_name:
type: string
- description: The user lastname
+ description: |
+ The user lastname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
minLength: 1
username:
type: string
- description: The username
+ description: |
+ The username
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
Review comment:
```suggestion
description: |
The username.
*Changed in version 2.2.0*: A minimum character length
requirement ('minLength') is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1764,25 +1832,39 @@ components:
schemas:
# Database entities
UserCollectionItem:
- description: >
+ description: |
A user object
+
+ *New in version 2.1.0*
type: object
properties:
first_name:
type: string
- description: The user firstname
+ description: |
+ The user firstname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
Review comment:
```suggestion
The user's first name.
*Changed in version 2.2.0*: A minimum character length
requirement ('minLength') is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1882,7 +1973,10 @@ components:
ConnectionCollection:
type: object
- description: Collection of connections.
+ description: |
+ Collection of connections.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1764,25 +1832,39 @@ components:
schemas:
# Database entities
UserCollectionItem:
- description: >
+ description: |
A user object
+
+ *New in version 2.1.0*
type: object
properties:
first_name:
type: string
- description: The user firstname
+ description: |
+ The user firstname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
minLength: 1
last_name:
type: string
- description: The user lastname
+ description: |
+ The user lastname
+
+ *Changed in version 2.2.0*: A minimum character length
requirement('minLength') has been added.
Review comment:
```suggestion
The user's last name.
*Changed in version 2.2.0*: A minimum character length
requirement ('minLength') is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2162,7 +2285,10 @@ components:
ImportErrorCollection:
type: object
- description: Collection of import errors.
+ description: |
+ Collection of import errors.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2405,7 +2546,10 @@ components:
VariableCollection:
type: object
- description: Collection of variables.
+ description: |
+ Collection of variables.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2339,6 +2475,8 @@ components:
operator:
type: string
nullable: true
+ description: |
+ *Changed in version 2.1.1*: Field becomes nullable
Review comment:
```suggestion
*Changed in version 2.1.1*: Field becomes nullable.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2353,7 +2491,10 @@ components:
TaskInstanceCollection:
type: object
- description: Collection of task instances.
+ description: |
+ Collection of task instances.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1979,7 +2081,10 @@ components:
readOnly: true
DAGCollection:
- description: Collection of DAGs.
+ description: |
+ Collection of DAGs.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1828,7 +1913,10 @@ components:
nullable: true
User:
type: object
- description: A user object with sensitive data
+ description: |
+ A user object with sensitive data
Review comment:
```suggestion
A user object with sensitive data.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2129,7 +2249,10 @@ components:
EventLogCollection:
type: object
- description: Collection of event logs.
+ description: |
+ Collection of event logs.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2232,7 +2358,10 @@ components:
PoolCollection:
type: object
- description: Collection of pools.
+ description: |
+ Collection of pools.
+
+ *Changed in version 2.1.0*: 'total_entries' field was added.
Review comment:
```suggestion
*Changed in version 2.1.0*: 'total_entries' field is added.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2029,13 +2136,19 @@ components:
The execution date. This is the same as logical_date, kept for
backwards compatibility.
If both this field and logical_date are provided but with
different values, the request
will fail with an BAD_REQUEST error.
+
+ *Changed in version 2.2.0*: Field becomes nullable
+
+ *Deprecated since version 2.2.0*: Use 'logical_date' instead
format: date-time
deprecated: true
start_date:
type: string
format: date-time
description: |
The start time. The time when DAG run was actually created.
+
+ *Changed in version 2.1.3*: Field becomes nullable
Review comment:
```suggestion
*Changed in version 2.1.3*: Field becomes nullable.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2700,20 +2860,29 @@ components:
- $ref: '#/components/schemas/CollectionInfo'
Role:
- description: Role item
+ description: |
+ Role item
+
+ *New in version 2.1.0*
type: object
properties:
name:
type: string
- description: The name of the role
+ description: |
+ The name of the role
+
+ *Changed in version 2.3.0: A minimum character length
requirement('minLength') has been added.
minLength: 1
actions:
type: array
items:
$ref: '#/components/schemas/ActionResource'
RoleCollection:
- description: Role Collections
+ description: |
+ Role Collections
Review comment:
```suggestion
A collection of roles.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2755,7 +2933,10 @@ components:
nullable: false
ActionResource:
- description: The Action-Resource item
+ description: |
+ The Action-Resource item
Review comment:
```suggestion
The Action-Resource item.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2700,20 +2860,29 @@ components:
- $ref: '#/components/schemas/CollectionInfo'
Role:
- description: Role item
+ description: |
+ Role item
Review comment:
```suggestion
a role item.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2623,10 +2776,14 @@ components:
type: array
items:
$ref: '#/components/schemas/Task'
+
# Plugin
PluginCollectionItem:
type: object
- description: Plugin Item
+ description: |
+ Plugin Item
Review comment:
```suggestion
A plugin Item.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -3525,8 +3727,10 @@ components:
type: array
items:
type: string
- description:
- List of tags to filter results
+ description: |
+ List of tags to filter results
Review comment:
```suggestion
List of tags to filter results.
```
##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -2725,7 +2894,10 @@ components:
- $ref: '#/components/schemas/CollectionInfo'
Action:
- description: Action Item
+ description: |
+ Action Item
Review comment:
```suggestion
An action Item.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
