openapi: 3.2.0
info:
  title: 'Automation Hub Exporters: Filesystem 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: Filesystem Exports'
paths:
  /api/automation-hub/pulp/api/v3/exporters/core/filesystem/{exporter_pk}/exports/:
    get:
      operationId: exporters_core_filesystem_exports_list
      description: Endpoint for managing FilesystemExports.
      summary: List filesystem 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: Filesystem Exports'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFilesystemExportResponseList'
          description: ''
    post:
      operationId: exporters_core_filesystem_exports_create
      description: Trigger an asynchronous task to export files to the filesystem
      summary: Create a filesystem export
      parameters:
      - in: path
        name: exporter_pk
        schema:
          type: string
        required: true
      tags:
      - 'Exporters: Filesystem Exports'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilesystemExport'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FilesystemExport'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FilesystemExport'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/exporters/core/filesystem/{exporter_pk}/exports/{pulp_id}/:
    get:
      operationId: exporters_core_filesystem_exports_read
      description: Endpoint for managing FilesystemExports.
      summary: Inspect a filesystem 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 filesystem 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: Filesystem Exports'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesystemExportResponse'
          description: ''
    delete:
      operationId: exporters_core_filesystem_exports_delete
      description: Endpoint for managing FilesystemExports.
      summary: Delete a filesystem 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 filesystem export.
        required: true
      tags:
      - 'Exporters: Filesystem Exports'
      responses:
        '204':
          description: No response body
components:
  schemas:
    AsyncOperationResponse:
      type: object
      description: Serializer for asynchronous operations.
      properties:
        task:
          type: string
          format: uri
          description: The href of the task.
      required:
      - task
    FilesystemExportResponse:
      type: object
      description: Serializer for FilesystemExports.
      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.
    PaginatedFilesystemExportResponseList:
      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/FilesystemExportResponse'
    FilesystemExport:
      type: object
      description: Serializer for FilesystemExports.
      properties:
        task:
          type:
          - string
          - 'null'
          format: uri
          description: A URI of the task that ran the Export.
        publication:
          type: string
          format: uri
          writeOnly: true
          description: A URI of the publication to be exported.
        repository_version:
          type: string
          format: uri
          writeOnly: true
          description: A URI of the repository version export.
        start_repository_version:
          type: string
          format: uri
          writeOnly: true
          description: The URI of the last-exported-repo-version.