openapi: 3.2.0
info:
  title: 'Automation Hub Api: _Ui V1 My-Synclists 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: 'Api: _Ui V1 My-Synclists'
paths:
  /api/automation-hub/_ui/v1/my-synclists/:
    get:
      operationId: api_automation_hub__ui_v1_my_synclists_list
      summary: List sync lists
      parameters:
      - 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:
      - 'Api: _Ui V1 My-Synclists'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSyncListResponseList'
          description: ''
    post:
      operationId: api_automation_hub__ui_v1_my_synclists_create
      summary: Create a sync list
      tags:
      - 'Api: _Ui V1 My-Synclists'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncList'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SyncList'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SyncList'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncListResponse'
          description: ''
  /api/automation-hub/_ui/v1/my-synclists/{id}/:
    get:
      operationId: api_automation_hub__ui_v1_my_synclists_read
      summary: Inspect a sync list
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this sync list.
        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:
      - 'Api: _Ui V1 My-Synclists'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncListResponse'
          description: ''
    put:
      operationId: api_automation_hub__ui_v1_my_synclists_update
      summary: Update a sync list
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this sync list.
        required: true
      tags:
      - 'Api: _Ui V1 My-Synclists'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncList'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SyncList'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SyncList'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncListResponse'
          description: ''
    patch:
      operationId: api_automation_hub__ui_v1_my_synclists_partial_update
      summary: Update a sync list
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this sync list.
        required: true
      tags:
      - 'Api: _Ui V1 My-Synclists'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSyncList'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSyncList'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSyncList'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncListResponse'
          description: ''
    delete:
      operationId: api_automation_hub__ui_v1_my_synclists_delete
      summary: Delete a sync list
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this sync list.
        required: true
      tags:
      - 'Api: _Ui V1 My-Synclists'
      responses:
        '204':
          description: No response body
components:
  schemas:
    Policy8baEnum:
      enum:
      - exclude
      - include
      type: string
      description: '* `exclude` - exclude

        * `include` - include'
    SyncList:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 64
        policy:
          $ref: '#/components/schemas/Policy8baEnum'
        upstream_repository:
          type:
          - string
          - 'null'
          format: uuid
        distribution:
          type:
          - string
          - 'null'
          format: uuid
        collections:
          type: array
          items:
            $ref: '#/components/schemas/SyncListCollectionSummary'
        namespaces:
          type: array
          items:
            type: string
            minLength: 1
        groups:
          type: string
      required:
      - collections
      - groups
      - name
      - namespaces
    SyncListResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        name:
          type: string
          maxLength: 64
        policy:
          $ref: '#/components/schemas/Policy8baEnum'
        upstream_repository:
          type:
          - string
          - 'null'
          format: uuid
        repository:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        distribution:
          type:
          - string
          - 'null'
          format: uuid
        collections:
          type: array
          items:
            $ref: '#/components/schemas/SyncListCollectionSummaryResponse'
        namespaces:
          type: array
          items:
            type: string
        groups:
          type: string
      required:
      - collections
      - groups
      - name
      - namespaces
    SyncListCollectionSummaryResponse:
      type: object
      properties:
        namespace:
          type: string
          maxLength: 64
        name:
          type: string
          maxLength: 64
      required:
      - name
      - namespace
    PaginatedSyncListResponseList:
      type: object
      properties:
        meta:
          type: object
          properties:
            count:
              type: integer
              example: 123
        links:
          type: object
          properties:
            first:
              type:
              - string
              - 'null'
            previous:
              type:
              - string
              - 'null'
            next:
              type:
              - string
              - 'null'
            last:
              type:
              - string
              - 'null'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SyncListResponse'
    PatchedSyncList:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 64
        policy:
          $ref: '#/components/schemas/Policy8baEnum'
        upstream_repository:
          type:
          - string
          - 'null'
          format: uuid
        distribution:
          type:
          - string
          - 'null'
          format: uuid
        collections:
          type: array
          items:
            $ref: '#/components/schemas/SyncListCollectionSummary'
        namespaces:
          type: array
          items:
            type: string
            minLength: 1
        groups:
          type: string
    SyncListCollectionSummary:
      type: object
      properties:
        namespace:
          type: string
          minLength: 1
          maxLength: 64
        name:
          type: string
          minLength: 1
          maxLength: 64
      required:
      - name
      - namespace