Red Hat Ansible Automation Platform Distributions: File API

openapi: 3.2.0
info:
  title: 'Automation Hub Distributions: File 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: 'Distributions: File'
paths:
  /api/automation-hub/pulp/api/v3/distributions/file/file/:
    get:
      operationId: distributions_file_file_list
      description: 'FileDistributions host File

        Publications which makes the metadata and the referenced File Content available to HTTP

        clients. Additionally, a FileDistribution with an associated FilePublication can be the target

        url of a File Remote , allowing

        another instance of Pulp to sync the content.'
      summary: List file distributions
      parameters:
      - in: query
        name: base_path
        schema:
          type: string
        description: Filter results where base_path matches value
      - in: query
        name: base_path__contains
        schema:
          type: string
        description: Filter results where base_path contains value
      - in: query
        name: base_path__icontains
        schema:
          type: string
        description: Filter results where base_path contains value
      - in: query
        name: base_path__in
        schema:
          type: array
          items:
            type: string
        description: Filter results where base_path is in a comma-separated list of values
        explode: false
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
        description: Filter results where name matches value
      - in: query
        name: name__contains
        schema:
          type: string
        description: Filter results where name contains value
      - in: query
        name: name__icontains
        schema:
          type: string
        description: Filter results where name contains value
      - in: query
        name: name__iexact
        schema:
          type: string
        description: Filter results where name matches value
      - in: query
        name: name__in
        schema:
          type: array
          items:
            type: string
        description: Filter results where name is in a comma-separated list of values
        explode: false
        style: form
      - in: query
        name: name__iregex
        schema:
          type: string
        description: Filter results where name matches regex value
      - in: query
        name: name__istartswith
        schema:
          type: string
        description: Filter results where name starts with value
      - in: query
        name: name__regex
        schema:
          type: string
        description: Filter results where name matches regex value
      - in: query
        name: name__startswith
        schema:
          type: string
        description: Filter results where name starts with value
      - 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:
            - -base_path
            - -hidden
            - -name
            - -pk
            - -pulp_created
            - -pulp_id
            - -pulp_labels
            - -pulp_last_updated
            - -pulp_type
            - base_path
            - hidden
            - name
            - pk
            - pulp_created
            - pulp_id
            - pulp_labels
            - pulp_last_updated
            - pulp_type
        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)

          * `name` - Name

          * `-name` - Name (descending)

          * `pulp_labels` - Pulp labels

          * `-pulp_labels` - Pulp labels (descending)

          * `base_path` - Base path

          * `-base_path` - Base path (descending)

          * `hidden` - Hidden

          * `-hidden` - Hidden (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: pulp_label_select
        schema:
          type: string
        description: Filter labels by search string
      - in: query
        name: q
        schema:
          type: string
      - in: query
        name: repository
        schema:
          type: string
          format: uuid
        description: Filter results where repository matches value
      - in: query
        name: repository__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Filter results where repository is in a comma-separated list of values
        explode: false
        style: form
      - in: query
        name: with_content
        schema:
          type: string
        description: Filter distributions based on the content served by them
      - 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:
      - 'Distributions: File'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginatedfile.FileDistributionResponseList'
          description: ''
    post:
      operationId: distributions_file_file_create
      description: Trigger an asynchronous create task
      summary: Create a file distribution
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/file.FileDistribution'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/file.FileDistribution'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/file.FileDistribution'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/:
    get:
      operationId: distributions_file_file_read
      description: 'FileDistributions host File

        Publications which makes the metadata and the referenced File Content available to HTTP

        clients. Additionally, a FileDistribution with an associated FilePublication can be the target

        url of a File Remote , allowing

        another instance of Pulp to sync the content.'
      summary: Inspect a file distribution
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        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:
      - 'Distributions: File'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/file.FileDistributionResponse'
          description: ''
    put:
      operationId: distributions_file_file_update
      description: Trigger an asynchronous update task
      summary: Update a file distribution
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/file.FileDistribution'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/file.FileDistribution'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/file.FileDistribution'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
    patch:
      operationId: distributions_file_file_partial_update
      description: Trigger an asynchronous partial update task
      summary: Update a file distribution
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Patchedfile.FileDistribution'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Patchedfile.FileDistribution'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Patchedfile.FileDistribution'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
    delete:
      operationId: distributions_file_file_delete
      description: Trigger an asynchronous delete task
      summary: Delete a file distribution
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/add_role/:
    post:
      operationId: distributions_file_file_add_role
      description: Add a role for this object to users/groups.
      summary: Add a role
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NestedRole'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NestedRole'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NestedRole'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NestedRoleResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/list_roles/:
    get:
      operationId: distributions_file_file_list_roles
      description: List roles assigned to this object.
      summary: List roles
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        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:
      - 'Distributions: File'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectRolesResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/my_permissions/:
    get:
      operationId: distributions_file_file_my_permissions
      description: List permissions available to the current user on this object.
      summary: List user permissions
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        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:
      - 'Distributions: File'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyPermissionsResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/remove_role/:
    post:
      operationId: distributions_file_file_remove_role
      description: Remove a role for this object from users/groups.
      summary: Remove a role
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NestedRole'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NestedRole'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NestedRole'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NestedRoleResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/set_label/:
    post:
      operationId: distributions_file_file_set_label
      description: Set a single pulp_label on the object to a specific value or null.
      summary: Set a label
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetLabel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetLabel'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SetLabel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetLabelResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/distributions/file/file/{pulp_id}/unset_label/:
    post:
      operationId: distributions_file_file_unset_label
      description: Unset a single pulp_label on the object.
      summary: Unset a label
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file distribution.
        required: true
      tags:
      - 'Distributions: File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnsetLabel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UnsetLabel'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UnsetLabel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsetLabelResponse'
          description: ''
components:
  schemas:
    NestedRoleResponse:
      type: object
      description: 'Serializer to add/remove object roles to/from users/groups.


        This is used in conjunction with ``pulpcore.app.viewsets.base.RolesMixin`` and requires the

        underlying object to be passed as ``content_object`` in the context.'
      properties:
        users:
          type: array
          items:
            type: string
            description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          default: []
        groups:
          type: array
          items:
            type: string
          default: []
        role:
          type: string
      required:
      - role
    SetLabel:
      type: object
      description: Serializer for synchronously setting a label.
      properties:
        key:
          type: string
          minLength: 1
          pattern: ^[-a-zA-Z0-9_]+$
        value:
          type:
          - string
          - 'null'
      required:
      - key
      - value
    NestedRole:
      type: object
      description: 'Serializer to add/remove object roles to/from users/groups.


        This is used in conjunction with ``pulpcore.app.viewsets.base.RolesMixin`` and requires the

        underlying object to be passed as ``content_object`` in the context.'
      properties:
        users:
          type: array
          items:
            type: string
            minLength: 1
            description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          default: []
        groups:
          type: array
          items:
            type: string
            minLength: 1
          default: []
        role:
          type: string
          minLength: 1
      required:
      - role
    Patchedfile.FileDistribution:
      type: object
      description: Serializer for File Distributions.
      properties:
        base_path:
          type: string
          minLength: 1
          description: The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. "foo" and "foo/bar")
        content_guard:
          type:
          - string
          - 'null'
          format: uri
          description: An optional content-guard.
        hidden:
          type: boolean
          default: false
          description: Whether this distribution should be shown in the content app.
        pulp_labels:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
        name:
          type: string
          minLength: 1
          description: A unique name. Ex, `rawhide` and `stable`.
        repository:
          type:
          - string
          - 'null'
          format: uri
          description: The latest RepositoryVersion for this Repository will be served.
        publication:
          type:
          - string
          - 'null'
          format: uri
          description: Publication to be served
    file.FileDistribution:
      type: object
      description: Serializer for File Distributions.
      properties:
        base_path:
          type: string
          minLength: 1
          description: The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. "foo" and "foo/bar")
        content_guard:
          type:
          - string
          - 'null'
          format: uri
          description: An optional content-guard.
        hidden:
          type: boolean
          default: false
          description: Whether this distribution should be shown in the content app.
        pulp_labels:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
        name:
          type: string
          minLength: 1
          description: A unique name. Ex, `rawhide` and `stable`.
        repository:
          type:
          - string
          - 'null'
          format: uri
          description: The latest RepositoryVersion for this Repository will be served.
        publication:
          type:
          - string
          - 'null'
          format: uri
          description: Publication to be served
      required:
      - base_path
      - name
    MyPermissionsResponse:
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
      required:
      - permissions
    Paginatedfile.FileDistributionResponseList:
      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/file.FileDistributionResponse'
    UnsetLabelResponse:
      type: object
      description: Serializer for synchronously setting a label.
      properties:
        key:
          type: string
          pattern: ^[-a-zA-Z0-9_]+$
        value:
          type: string
          readOnly: true
      required:
      - key
    file.FileDistributionResponse:
      type: object
      description: Serializer for File Distributions.
      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.'
        base_path:
          type: string
          description: The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. "foo" and "foo/bar")
        base_url:
          type: string
          readOnly: true
          description: The URL for accessing the publication as defined by this distribution.
        content_guard:
          type:
          - string
          - 'null'
          format: uri
          description: An optional content-guard.
        hidden:
          type: boolean
          default: false
          description: Whether this distribution should be shown in the content app.
        pulp_labels:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
        name:
          type: string
          description: A unique name. Ex, `rawhide` and `stable`.
        repository:
          type:
          - string
          - 'null'
          format: uri
          description: The latest RepositoryVersion for this Repository will be served.
        publication:
          type:
          - string
          - 'null'
          format: uri
          description: Publication to be served
      required:
      - base_path
      - name
    AsyncOperationResponse:
      type: object
      description: Serializer for asynchronous operations.
      properties:
        task:
          type: string
          format: uri
          description: The href of the task.
      required:
      - task
    ObjectRolesResponse:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/NestedRoleResponse'
      required:
      - roles
    SetLabelResponse:
      type: object
      description: Serializer for synchronously setting a label.
      properties:
        key:
          type: string
          pattern: ^[-a-zA-Z0-9_]+$
        value:
          type:
          - string
          - 'null'
      required:
      - key
      - value
    UnsetLabel:
      type: object
      description: Serializer for synchronously setting a label.
      properties:
        key:
          type: string
          minLength: 1
          pattern: ^[-a-zA-Z0-9_]+$
      required:
      - key