[airflow] branch master updated: Improve descriptions in OpenAPI Spec file (#10539)

[ka...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kaxilnaik pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/master by this push:
     new 49cce8b  Improve descriptions in OpenAPI Spec file (#10539)
49cce8b is described below

commit 49cce8b9f5995178d714e26fa4afc60ee59ca702
Author: Kaxil Naik <ka...@gmail.com>
AuthorDate: Tue Aug 25 01:08:35 2020 +0100

    Improve descriptions in OpenAPI Spec file (#10539)
---
 airflow/api_connexion/openapi/v1.yaml | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/airflow/api_connexion/openapi/v1.yaml b/airflow/api_connexion/openapi/v1.yaml
index 5496f06..798b275 100644
--- a/airflow/api_connexion/openapi/v1.yaml
+++ b/airflow/api_connexion/openapi/v1.yaml
@@ -229,7 +229,7 @@ paths:
       - $ref: '#/components/parameters/DAGID'
 
     post:
-      summary: Clear a task instances
+      summary: Clear a set of task instances
       description: >
         Clears a set of task instances associated with the DAG for a specified date range.
       x-openapi-router-controller: airflow.api_connexion.endpoints.task_instance_endpoint
@@ -1098,7 +1098,7 @@ paths:
       summary: Get a instance status
       description: |
         Get the status of Airflow's metadatabase and scheduler. It incluse info about
-        metadatabase and last heart beat of scheduler.
+        metadatabase and last heartbeat of scheduler.
       x-openapi-router-controller: airflow.api_connexion.endpoints.health_endpoint
       operationId: get_health
       tags: [Monitoring]
@@ -1112,7 +1112,7 @@ paths:
 
   /version:
     get:
-      summary: Get a version information
+      summary: Get version information
       x-openapi-router-controller: airflow.api_connexion.endpoints.version_endpoint
       operationId: get_version
       tags: [Monitoring]
@@ -1240,7 +1240,7 @@ components:
           readOnly: true
 
     DAGCollection:
-      description: Colllection of DAGs
+      description: Collection of DAGs
       type: object
       properties:
         dags:
@@ -1360,7 +1360,7 @@ components:
 
     EventLogCollection:
       type: object
-      description: Collecttion of event log
+      description: Collection of event log
       properties:
         event_logs:
           type: array
@@ -1694,7 +1694,7 @@ components:
 
     ExtraLinkCollection:
       type: object
-      description: The colelction of extra links.
+      description: The collection of extra links.
       properties:
         extra_links:
           type: array
@@ -1785,7 +1785,7 @@ components:
 
     TaskCollection:
       type: object
-      description: Collelction of tasks.
+      description: Collection of tasks.
       properties:
         tasks:
           type: array