openapi: 3.2.0
info:
  title: 'Automation Hub Content: Manifests 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: 'Content: Manifests'
paths:
  /api/automation-hub/pulp/api/v3/content/container/manifests/:
    get:
      operationId: content_container_manifests_list
      description: ViewSet for Manifest.
      summary: List manifests
      parameters:
      - in: query
        name: digest
        schema:
          type: string
        description: Filter results where digest matches value
      - in: query
        name: digest__in
        schema:
          type: array
          items:
            type: string
        description: Filter results where digest is in a comma-separated list of values
        explode: false
        style: form
      - in: query
        name: is_bootable
        schema:
          type: boolean
        description: Filter results where is_bootable matches value
      - in: query
        name: is_flatpak
        schema:
          type: boolean
        description: Filter results where is_flatpak matches value
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: media_type
        schema:
          type: array
          items:
            type: string
            enum:
            - application/vnd.docker.distribution.manifest.list.v2+json
            - application/vnd.docker.distribution.manifest.v1+json
            - application/vnd.docker.distribution.manifest.v2+json
            - application/vnd.oci.image.index.v1+json
            - application/vnd.oci.image.manifest.v1+json
        description: '* `application/vnd.docker.distribution.manifest.v1+json` - application/vnd.docker.distribution.manifest.v1+json

          * `application/vnd.docker.distribution.manifest.v2+json` - application/vnd.docker.distribution.manifest.v2+json

          * `application/vnd.docker.distribution.manifest.list.v2+json` - application/vnd.docker.distribution.manifest.list.v2+json

          * `application/vnd.oci.image.manifest.v1+json` - application/vnd.oci.image.manifest.v1+json

          * `application/vnd.oci.image.index.v1+json` - application/vnd.oci.image.index.v1+json'
        explode: true
        style: form
      - 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:
            - -annotations
            - -digest
            - -is_bootable
            - -is_flatpak
            - -labels
            - -media_type
            - -pk
            - -pulp_created
            - -pulp_id
            - -pulp_last_updated
            - -pulp_type
            - -schema_version
            - -timestamp_of_interest
            - -upstream_id
            - annotations
            - digest
            - is_bootable
            - is_flatpak
            - labels
            - media_type
            - pk
            - pulp_created
            - pulp_id
            - pulp_last_updated
            - pulp_type
            - schema_version
            - timestamp_of_interest
            - upstream_id
        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)

          * `pulp_type` - Pulp type

          * `-pulp_type` - Pulp type (descending)

          * `upstream_id` - Upstream id

          * `-upstream_id` - Upstream id (descending)

          * `timestamp_of_interest` - Timestamp of interest

          * `-timestamp_of_interest` - Timestamp of interest (descending)

          * `digest` - Digest

          * `-digest` - Digest (descending)

          * `schema_version` - Schema version

          * `-schema_version` - Schema version (descending)

          * `media_type` - Media type

          * `-media_type` - Media type (descending)

          * `annotations` - Annotations

          * `-annotations` - Annotations (descending)

          * `labels` - Labels

          * `-labels` - Labels (descending)

          * `is_bootable` - Is bootable

          * `-is_bootable` - Is bootable (descending)

          * `is_flatpak` - Is flatpak

          * `-is_flatpak` - Is flatpak (descending)

          * `pk` - Pk

          * `-pk` - Pk (descending)'
        explode: false
        style: form
      - in: query
        name: orphaned_for
        schema:
          type: number
        description: Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
      - 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: repository_version
        schema:
          type: string
        description: Repository Version referenced by HREF
      - in: query
        name: repository_version_added
        schema:
          type: string
        description: Repository Version referenced by HREF
      - in: query
        name: repository_version_removed
        schema:
          type: string
        description: Repository Version referenced by HREF
      - 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:
      - 'Content: Manifests'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginatedcontainer.ManifestResponseList'
          description: ''
  /api/automation-hub/pulp/api/v3/content/container/manifests/{pulp_id}/:
    get:
      operationId: content_container_manifests_read
      description: ViewSet for Manifest.
      summary: Inspect a manifest
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this manifest.
        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:
      - 'Content: Manifests'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/container.ManifestResponse'
          description: ''
components:
  schemas:
    container.ManifestResponse:
      type: object
      description: Serializer for Manifests.
      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.'
        artifact:
          type: string
          format: uri
          description: Artifact file representing the physical content
        digest:
          type: string
          description: sha256 of the Manifest file
        schema_version:
          type: integer
          format: int64
          description: Manifest schema version
        media_type:
          type: string
          description: Manifest media type of the file
        listed_manifests:
          type: array
          items:
            type: string
            format: uri
          description: Manifests that are referenced by this Manifest List
        config_blob:
          type: string
          format: uri
          description: Blob that contains configuration for this Manifest
        blobs:
          type: array
          items:
            type: string
            format: uri
          description: Blobs that are referenced by this Manifest
        annotations:
          type: object
          readOnly: true
          description: Property that contains arbitrary metadata stored inside the image manifest.
        labels:
          type: object
          readOnly: true
          description: Property describing metadata stored inside the image configuration
        is_bootable:
          type: boolean
          default: false
          description: A boolean determining whether users can boot from an image or not.
        is_flatpak:
          type: boolean
          default: false
          description: A boolean determining whether the image bundles a Flatpak application
      required:
      - artifact
      - blobs
      - digest
      - listed_manifests
      - media_type
      - schema_version
    Paginatedcontainer.ManifestResponseList:
      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/container.ManifestResponse'