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



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -1324,59 +1397,81 @@ components:
           items:
             $ref: '#/components/schemas/ImportError'
 
+    HealthInfo:
+      type: object
+      description: Instance status information.
+      properties:
+        metadatabase:
+          $ref: '#/components/schemas/MetadatabaseStatus'
+        scheduler:
+          $ref: '#/components/schemas/SchedulerStatus'
+
     MetadatabaseStatus:
       type: object
-      description: Returns the status of the metadatabase
+      description: The status of the metadatabase
+      properties:
+        status:
+          $ref: '#/components/schemas/HealthStatus'
+
+    SchedulerStatus:
+      type: object
+      description: The status and the latest scheduler heartbeat
       properties:
         status:
           $ref: '#/components/schemas/HealthStatus'
+        latest_scheduler_heartbeat:
+          description: The time the scheduler last do a heartbeat.
+          type: string
+          format: datetime
+          readOnly: true
+          nullable: true
+
 
     Pool:
+      description: The pool
       type: object
       properties:
         name:
           type: string
+          description: The name of pool.
         slots:
           type: integer
+          description: |
+            The maximum number of slots that can be assigned to tasks. One job 
may occupy one or more slots.
         occupied_slots:
           type: integer
           readOnly: true
+          description: The number of slots used by running/queued tasks at the 
moment.
         used_slots:
           type: integer
           readOnly: true
+          description: The number of slots used by running tasks at the moment.
         queued_slots:
           type: integer
           readOnly: true
+          description: The number of slots used by queued tasks at the moment.
         open_slots:
           type: integer
           readOnly: true
+          description: The number of free slots at the moment.
 
     PoolCollection:
       type: object
+      description: Collection of pool
       properties:
         pools:
           type: array
           items:
             $ref: '#/components/schemas/Pool'
 
-    SchedulerStatus:
-      type: object
-      description: Returns the status and the latest scheduler heartbeat
-      properties:
-        status:
-          $ref: '#/components/schemas/HealthStatus'
-        latest_scheduler_heartbeat:
-          type: string
-          format: datetime
-          readOnly: true
-          nullable: true
 
     SLAMiss:
       type: object
       properties:
         task_id:
           type: string
           readOnly: true
+          description: The Task ID

Review comment:
       Sometimes there is full stop at the end of the sentence and sometimes 
isn't.




----------------------------------------------------------------
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:
[email protected]


Reply via email to