[GitHub] [airflow] michalslowikowski00 commented on a change in pull request #10417: Improving descriptions in OpenAPI

[GitBox <gi...@apache.org>]

michalslowikowski00 commented on a change in pull request #10417:
URL: https://github.com/apache/airflow/pull/10417#discussion_r473727909



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1256,65 +1319,75 @@ components:
 
     EventLog:
       type: object
+      description: Log of user operations via CLI or Web UI.
       properties:
         event_log_id:
+          description: The evnet log ID
           type: integer
           readOnly: true
         when:
+          description: The time when these events happened.
+          format: date-time
           type: string
           readOnly: true
         dag_id:
+          description: The DAG ID
           type: string
           readOnly: true
         task_id:
+          description: The DAG ID
           type: string
           readOnly: true
         event:
+          description: A key describing the type of event
           type: string
           readOnly: true
         execution_date:
+          description: |
+            When the event was dispatched for an object having execution_date, the value of this field.
+          format: date-time
           type: string
           readOnly: true
         owner:
+          description: Name of the user who triggered these events a.
           type: string
           readOnly: true
         extra:
+          description: |
+            Other information that was not included in the other fields, e.g. the complete CLI command
           type: string
           readOnly: true
           nullable: true
 
     EventLogCollection:
       type: object
+      description: Collecttion of event log
       properties:
         event_logs:
           type: array
           items:
             $ref: '#/components/schemas/EventLog'
 
-    HealthInfo:
-      type: object
-      properties:
-        metadatabase:
-          $ref: '#/components/schemas/MetadatabaseStatus'
-        scheduler:
-          $ref: '#/components/schemas/SchedulerStatus'
-
     ImportError:
       type: object
       properties:
         import_error_id:
           type: integer
           readOnly: true
+          description: The import error ID
         timestamp:
           type: string
           format: datetime
           readOnly: true
+          description: The time when this error was created,

Review comment:
       ```suggestion
             description: The time when this error was created
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org