openapi: 3.2.0
info:
  title: 'Automation Hub Importers: Pulp Import-Check 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: 'Importers: Pulp Import-Check'
paths:
  /api/automation-hub/pulp/api/v3/importers/core/pulp/import-check/:
    post:
      operationId: pulp_import_check_post
      description: 'Evaluates validity of proposed PulpImport parameters ''toc'', ''path'', and ''repo_mapping''.


        * Checks that toc, path are in ALLOWED_IMPORT_PATHS

        * if ALLOWED:

        * Checks that toc, path exist and are readable

        * If toc specified, checks that containing dir is writeable

        * Checks that repo_mapping is valid JSON'
      summary: Validate the parameters to be used for a PulpImport call
      tags:
      - 'Importers: Pulp Import-Check'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PulpImportCheck'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PulpImportCheck'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PulpImportCheck'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PulpImportCheckResponse'
          description: ''
components:
  schemas:
    PulpImportCheck:
      type: object
      description: 'Check validity of provided import-options.


        Provides the ability to check that an import is ''sane'' without having to actually

        create an importer.'
      properties:
        path:
          type: string
          minLength: 1
          description: Path to export-tar-gz that will be imported.
        toc:
          type: string
          minLength: 1
          description: Path to a table-of-contents file describing chunks to be validated, reassembled, and imported.
        repo_mapping:
          type: string
          minLength: 1
          description: 'Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named ''foo'' and the repo to import content into was ''bar'', the mapping would be "{''foo'': ''bar''}".'
    EvaluationResponse:
      type: object
      description: Results from evaluating a proposed parameter to a PulpImport call.
      properties:
        context:
          type: string
          description: Parameter value being evaluated.
        is_valid:
          type: boolean
          description: True if evaluation passed, false otherwise.
        messages:
          type: array
          items:
            type: string
          description: Messages describing results of all evaluations done. May be an empty list.
      required:
      - context
      - is_valid
      - messages
    PulpImportCheckResponse:
      type: object
      description: Return the response to a PulpImport import-check call.
      properties:
        toc:
          allOf:
          - $ref: '#/components/schemas/EvaluationResponse'
          description: Evaluation of proposed 'toc' file for PulpImport
        path:
          allOf:
          - $ref: '#/components/schemas/EvaluationResponse'
          description: Evaluation of proposed 'path' file for PulpImport
        repo_mapping:
          allOf:
          - $ref: '#/components/schemas/EvaluationResponse'
          description: Evaluation of proposed 'repo_mapping' file for PulpImport