openapi: 3.2.0
info:
  title: 'Automation Hub Exporters: Pulp Exports 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: 'Exporters: Pulp Exports'
paths:
  /api/automation-hub/pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/:
    get:
      operationId: exporters_core_pulp_exports_list
      description: ViewSet for viewing exports from a PulpExporter.
      summary: List pulp exports
      parameters:
      - in: path
        name: exporter_pk
        schema:
          type: string
        required: true
      - 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:
      - 'Exporters: Pulp Exports'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPulpExportResponseList'
          description: ''
    post:
      operationId: exporters_core_pulp_exports_create
      description: Trigger an asynchronous task to export a set of repositories
      summary: Create a pulp export
      parameters:
      - in: path
        name: exporter_pk
        schema:
          type: string
        required: true
      tags:
      - 'Exporters: Pulp Exports'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PulpExport'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PulpExport'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PulpExport'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/{pulp_id}/:
    get:
      operationId: exporters_core_pulp_exports_read
      description: ViewSet for viewing exports from a PulpExporter.
      summary: Inspect a pulp export
      parameters:
      - in: path
        name: exporter_pk
        schema:
          type: string
        required: true
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this pulp export.
        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:
      - 'Exporters: Pulp Exports'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PulpExportResponse'
          description: ''
    delete:
      operationId: exporters_core_pulp_exports_delete
      description: ViewSet for viewing exports from a PulpExporter.
      summary: Delete a pulp export
      parameters:
      - in: path
        name: exporter_pk
        schema:
          type: string
        required: true
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this pulp export.
        required: true
      tags:
      - 'Exporters: Pulp Exports'
      responses:
        '204':
          description: No response body
components:
  schemas:
    PulpExportResponse:
      type: object
      description: Serializer for PulpExports.
      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.'
        task:
          type:
          - string
          - 'null'
          format: uri
          description: A URI of the task that ran the Export.
        exported_resources:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
          description: Resources that were exported.
        params:
          type: object
          readOnly: true
          description: Any additional parameters that were used to create the export.
        output_file_info:
          type: object
          readOnly: true
          description: 'Dictionary of filename: sha256hash entries for export-output-file(s)'
        toc_info:
          type: object
          readOnly: true
          description: Filename and sha256-checksum of table-of-contents for this export
    AsyncOperationResponse:
      type: object
      description: Serializer for asynchronous operations.
      properties:
        task:
          type: string
          format: uri
          description: The href of the task.
      required:
      - task
    PulpExport:
      type: object
      description: Serializer for PulpExports.
      properties:
        task:
          type:
          - string
          - 'null'
          format: uri
          description: A URI of the task that ran the Export.
        full:
          type: boolean
          writeOnly: true
          default: true
          description: Do a Full (true) or Incremental (false) export.
        dry_run:
          type: boolean
          writeOnly: true
          default: false
          description: Generate report on what would be exported and disk-space required.
        versions:
          type: array
          items:
            type: string
            format: uri
            writeOnly: true
          writeOnly: true
          description: List of explicit repo-version hrefs to export (replaces current_version).
        chunk_size:
          type: string
          writeOnly: true
          minLength: 1
          description: Chunk export-tarfile into pieces of chunk_size bytes. Recognizes units of B/KB/MB/GB/TB. A chunk has a maximum size of 1TB.
        start_versions:
          type: array
          items:
            type: string
            format: uri
            writeOnly: true
          writeOnly: true
          description: List of explicit last-exported-repo-version hrefs (replaces last_export).
    PaginatedPulpExportResponseList:
      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/PulpExportResponse'