get:
  summary: Get agent action status
  tags:
    - Agent actions
  parameters:
    - $ref: ../components/parameters/page_size.yaml
    - $ref: ../components/parameters/page_index.yaml
    - schema:
        type: integer
        default: 5
      in: query
      name: errorSize
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              items:
                type: array
                items:
                  type: object
                  properties:
                    actionId:
                      type: string
                    status:
                      type: string
                      enum:
                        - COMPLETE
                        - EXPIRED
                        - CANCELLED
                        - FAILED
                        - IN_PROGRESS
                        - ROLLOUT_PASSED
                    nbAgentsActioned:
                      type: number
                      description: number of agents actioned
                    nbAgentsActionCreated:
                      type: number
                      description: number of agents included in action from kibana
                    nbAgentsAck:
                      type: number
                      description: number of agents that acknowledged the action
                    nbAgentsFailed:
                      type: number
                      description: number of agents that failed to execute the action
                    version:
                      type: string
                      description: agent version number (UPGRADE action)
                    startTime:
                      type: string
                      description: start time of action (scheduled actions)
                    type:
                      type: string
                      enum:
                        - POLICY_REASSIGN
                        - UPGRADE
                        - UNENROLL
                        - FORCE_UNENROLL
                        - UPDATE_TAGS
                        - CANCEL
                        - REQUEST_DIAGNOSTICS
                        - SETTINGS
                        - POLICY_CHANGE
                        - INPUT_ACTION
                    expiration:
                      type: string
                    completionTime:
                      type: string
                    cancellationTime:
                      type: string
                    newPolicyId:
                      type: string
                      description: new policy id (POLICY_REASSIGN action)
                    policyId:
                      type: string
                      description: policy id (POLICY_CHANGE action)
                    revision:
                      type: string
                      description: new policy revision (POLICY_CHANGE action)
                    creationTime:
                      type: string
                      description: creation time of action
                    latestErrors:
                      type: array
                      description: latest errors that happened when the agents executed the action
                      items:
                        type: object
                        properties:
                          agentId:
                            type: string
                          error:
                            type: string
                          timestamp:
                            type: string
                  required:
                    - actionId
                    - complete
                    - nbAgentsActioned
                    - nbAgentsActionCreated
                    - nbAgentsAck
                    - nbAgentsFailed
                    - status
                    - creationTime
                    - type
            required:
              - items
    '400':
      $ref: ../components/responses/error.yaml
  operationId: agents-action-status