Red Hat Ansible Automation Platform Api: V3 Plugin Ansible Content Collections Index API

openapi: 3.2.0
info:
  title: 'Automation Hub Api: V3 Plugin Ansible Content Collections…'
  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: 'Api: V3 Plugin Ansible Content Collections Index'
paths:
  /api/automation-hub/v3/plugin/ansible/content/{distro_base_path}/collections/index/:
    get:
      operationId: api_automation_hub_v3_plugin_ansible_content_collections_index_list
      description: ViewSet for Collections.
      parameters:
      - in: query
        name: deprecated
        schema:
          type: boolean
      - in: path
        name: distro_base_path
        schema:
          type: string
        required: true
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: namespace
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: ordering
        schema:
          type: array
          items:
            type: string
            enum:
            - -name
            - -namespace
            - -pk
            - -pulp_created
            - -pulp_id
            - -pulp_last_updated
            - name
            - namespace
            - pk
            - pulp_created
            - pulp_id
            - pulp_last_updated
        description: 'Ordering


          * `pulp_id` - Pulp id

          * `-pulp_id` - Pulp id (descending)

          * `pulp_created` - Pulp created

          * `-pulp_created` - Pulp created (descending)

          * `pulp_last_updated` - Pulp last updated

          * `-pulp_last_updated` - Pulp last updated (descending)

          * `namespace` - Namespace

          * `-namespace` - Namespace (descending)

          * `name` - Name

          * `-name` - Name (descending)

          * `pk` - Pk

          * `-pk` - Pk (descending)'
        explode: false
        style: form
      - in: query
        name: pulp_href__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: pulp_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: q
        schema:
          type: string
      - 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:
      - 'Api: V3 Plugin Ansible Content Collections Index'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCollectionResponseList'
          description: ''
      summary: Api automation hub v3 plugin ansible content collections index list
      x-summary-source: derived
  /api/automation-hub/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/:
    get:
      operationId: api_automation_hub_v3_plugin_ansible_content_collections_index_read
      description: ViewSet for Collections.
      parameters:
      - in: path
        name: distro_base_path
        schema:
          type: string
        required: true
      - in: path
        name: name
        schema:
          type: string
        required: true
      - in: path
        name: namespace
        schema:
          type: string
        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:
      - 'Api: V3 Plugin Ansible Content Collections Index'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponse'
          description: ''
      summary: Api automation hub v3 plugin ansible content collections index read
      x-summary-source: derived
    patch:
      operationId: api_automation_hub_v3_plugin_ansible_content_collections_index_update
      description: Trigger an asynchronous update task
      parameters:
      - in: path
        name: distro_base_path
        schema:
          type: string
        required: true
      - in: path
        name: name
        schema:
          type: string
        required: true
      - in: path
        name: namespace
        schema:
          type: string
        required: true
      tags:
      - 'Api: V3 Plugin Ansible Content Collections Index'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCollection'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCollection'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCollection'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
      summary: Api automation hub v3 plugin ansible content collections index update
      x-summary-source: derived
    delete:
      operationId: api_automation_hub_v3_plugin_ansible_content_collections_index_delete
      description: Trigger an asynchronous delete task
      parameters:
      - in: path
        name: distro_base_path
        schema:
          type: string
        required: true
      - in: path
        name: name
        schema:
          type: string
        required: true
      - in: path
        name: namespace
        schema:
          type: string
        required: true
      tags:
      - 'Api: V3 Plugin Ansible Content Collections Index'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
      summary: Api automation hub v3 plugin ansible content collections index delete
      x-summary-source: derived
components:
  schemas:
    AsyncOperationResponse:
      type: object
      description: Serializer for asynchronous operations.
      properties:
        task:
          type: string
          format: uri
          description: The href of the task.
      required:
      - task
    CollectionResponse:
      type: object
      description: A serializer for a Collection.
      properties:
        href:
          type: string
          description: Get href.
          readOnly: true
        namespace:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        deprecated:
          type: boolean
        versions_url:
          type: string
          description: Get a link to a collection versions list.
          readOnly: true
        highest_version:
          type: object
          description: Get a highest version and its link.
          readOnly: true
        created_at:
          type: string
          format: date-time
          description: Get the timestamp of the lowest version CollectionVersion's created timestamp.
          readOnly: true
        updated_at:
          type: string
          format: date-time
          description: Get the timestamp of the latest version CollectionVersion's created timestamp.
          readOnly: true
        download_count:
          type: integer
          description: Get the download count of the collection
          readOnly: true
      required:
      - deprecated
    PaginatedCollectionResponseList:
      type: object
      properties:
        meta:
          type: object
          properties:
            count:
              type: integer
              example: 123
        links:
          type: object
          properties:
            first:
              type:
              - string
              - 'null'
            previous:
              type:
              - string
              - 'null'
            next:
              type:
              - string
              - 'null'
            last:
              type:
              - string
              - 'null'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CollectionResponse'
    PatchedCollection:
      type: object
      description: A serializer for a Collection.
      properties:
        deprecated:
          type: boolean