Red Hat Ansible Automation Platform Task Groups API

openapi: 3.2.0
info:
  title: Automation Hub Task Groups API
  version: v3
  description: Fetch, Upload, Organize, and Distribute Ansible Collections
  contact:
    name: Automation Hub Team
    email: ansible-galaxy-team@redhat.com
    url: https://www.ansible.com/products/automation-hub
  license:
    name: GPLv2+
    url: https://raw.githubusercontent.com/ansible/galaxy_ng/main/LICENSE
  x-logo:
    url: https://pulp.plan.io/attachments/download/517478/pulp_logo_word_rectangle.svg
  x-pulp-app-versions:
    core: 3.49.40
    galaxy: 4.12.0dev
    ansible: 0.25.1
    container: 2.19.5
    certguard: 3.49.40
    file: 3.49.40
  x-pulp-domain-enabled: false
servers:
- url: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/
tags:
- name: Task-Groups
paths:
  /api/automation-hub/pulp/api/v3/task-groups/:
    get:
      operationId: task_groups_list
      description: 'A customized named ModelViewSet that knows how to register itself with the Pulp API router.


        This viewset is discoverable by its name.

        "Normal" Django Models and Master/Detail models are supported by the ``register_with`` method.


        Attributes:

        lookup_field (str): The name of the field by which an object should be looked up, in

        addition to any parent lookups if this ViewSet is nested. Defaults to ''pk''

        endpoint_name (str): The name of the final path segment that should identify the ViewSet''s

        collection endpoint.

        nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must

        correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin.

        None indicates this ViewSet should not be nested.

        parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs

        to django model filter expressions that can be used with the corresponding value from

        self.kwargs, used only by a nested ViewSet to filter based on the parent object''s

        identity.

        schema (DefaultSchema): The schema class to use by default in a viewset.'
      summary: List task groups
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - Task-Groups
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTaskGroupResponseList'
          description: ''
  /api/automation-hub/pulp/api/v3/task-groups/{pulp_id}/:
    get:
      operationId: task_groups_read
      description: 'A customized named ModelViewSet that knows how to register itself with the Pulp API router.


        This viewset is discoverable by its name.

        "Normal" Django Models and Master/Detail models are supported by the ``register_with`` method.


        Attributes:

        lookup_field (str): The name of the field by which an object should be looked up, in

        addition to any parent lookups if this ViewSet is nested. Defaults to ''pk''

        endpoint_name (str): The name of the final path segment that should identify the ViewSet''s

        collection endpoint.

        nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must

        correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin.

        None indicates this ViewSet should not be nested.

        parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs

        to django model filter expressions that can be used with the corresponding value from

        self.kwargs, used only by a nested ViewSet to filter based on the parent object''s

        identity.

        schema (DefaultSchema): The schema class to use by default in a viewset.'
      summary: Inspect a task group
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task group.
        required: true
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - Task-Groups
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskGroupResponse'
          description: ''
components:
  schemas:
    GroupProgressReportResponse:
      type: object
      description: 'Base serializer for use with :class:`pulpcore.app.models.Model`


        This ensures that all Serializers provide values for the ''pulp_href` field.


        The class provides a default for the ``ref_name`` attribute in the

        ModelSerializers''s ``Meta`` class. This ensures that the OpenAPI definitions

        of plugins are namespaced properly.'
      properties:
        message:
          type: string
          readOnly: true
          description: The message shown to the user for the group progress report.
        code:
          type: string
          readOnly: true
          description: Identifies the type of group progress report'.
        total:
          type: integer
          format: int64
          readOnly: true
          description: The total count of items.
        done:
          type: integer
          format: int64
          readOnly: true
          description: The count of items already processed. Defaults to 0.
        suffix:
          type:
          - string
          - 'null'
          readOnly: true
          description: The suffix to be shown with the group progress report.
    PaginatedTaskGroupResponseList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/TaskGroupResponse'
    MinimalTaskResponse:
      type: object
      description: 'Base serializer for use with :class:`pulpcore.app.models.Model`


        This ensures that all Serializers provide values for the ''pulp_href` field.


        The class provides a default for the ``ref_name`` attribute in the

        ModelSerializers''s ``Meta`` class. This ensures that the OpenAPI definitions

        of plugins are namespaced properly.'
      properties:
        pulp_href:
          type: string
          format: uri
          readOnly: true
        pulp_created:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of creation.
        pulp_last_updated:
          type: string
          format: date-time
          readOnly: true
          description: 'Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.'
        name:
          type: string
          description: The name of task.
        state:
          type: string
          readOnly: true
          description: 'The current state of the task. The possible values include: ''waiting'', ''skipped'', ''running'', ''completed'', ''failed'', ''canceled'' and ''canceling''.'
        unblocked_at:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of when this task was identified ready for pickup.
        started_at:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of when this task started execution.
        finished_at:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of when this task stopped execution.
        worker:
          type: string
          format: uri
          readOnly: true
          description: The worker associated with this task. This field is empty if a worker is not yet assigned.
      required:
      - name
    TaskGroupResponse:
      type: object
      description: 'Base serializer for use with :class:`pulpcore.app.models.Model`


        This ensures that all Serializers provide values for the ''pulp_href` field.


        The class provides a default for the ``ref_name`` attribute in the

        ModelSerializers''s ``Meta`` class. This ensures that the OpenAPI definitions

        of plugins are namespaced properly.'
      properties:
        pulp_href:
          type: string
          format: uri
          readOnly: true
        description:
          type: string
          description: A description of the task group.
        all_tasks_dispatched:
          type: boolean
          description: Whether all tasks have been spawned for this task group.
        waiting:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'waiting' state
        skipped:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'skipped' state
        running:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'running' state
        completed:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'completed' state
        canceled:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'canceled' state
        failed:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'failed' state
        canceling:
          type: integer
          format: int64
          readOnly: true
          description: Number of tasks in the 'canceling' state
        group_progress_reports:
          type: array
          items:
            $ref: '#/components/schemas/GroupProgressReportResponse'
          readOnly: true
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/MinimalTaskResponse'
          readOnly: true
      required:
      - all_tasks_dispatched
      - description