openapi: 3.2.0
info:
  title: 'Automation Hub Content: Collection_Marks 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: 'Content: Collection_Marks'
paths:
  /api/automation-hub/pulp/api/v3/content/ansible/collection_marks/:
    get:
      operationId: content_ansible_collection_marks_list
      description: ViewSet for looking at mark objects for CollectionVersion content.
      summary: List collection version marks
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: marked_collection
        schema:
          type: string
          format: uuid
        description: Filter marks for collection version
      - 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:
            - -pk
            - -pulp_created
            - -pulp_id
            - -pulp_last_updated
            - -pulp_type
            - -timestamp_of_interest
            - -upstream_id
            - -value
            - pk
            - pulp_created
            - pulp_id
            - pulp_last_updated
            - pulp_type
            - timestamp_of_interest
            - upstream_id
            - value
        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)

          * `upstream_id` - Upstream id

          * `-upstream_id` - Upstream id (descending)

          * `timestamp_of_interest` - Timestamp of interest

          * `-timestamp_of_interest` - Timestamp of interest (descending)

          * `value` - Value

          * `-value` - Value (descending)

          * `pk` - Pk

          * `-pk` - Pk (descending)'
        explode: false
        style: form
      - in: query
        name: orphaned_for
        schema:
          type: number
        description: Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
      - 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: q
        schema:
          type: string
      - in: query
        name: repository_version
        schema:
          type: string
        description: Repository Version referenced by HREF
      - in: query
        name: repository_version_added
        schema:
          type: string
        description: Repository Version referenced by HREF
      - in: query
        name: repository_version_removed
        schema:
          type: string
        description: Repository Version referenced by HREF
      - in: query
        name: value
        schema:
          type: string
        description: Filter marks by value
      - in: query
        name: value__in
        schema:
          type: array
          items:
            type: string
        description: Filter results where value is in a comma-separated list of values
        explode: false
        style: form
      - 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:
      - 'Content: Collection_Marks'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginatedansible.CollectionVersionMarkResponseList'
          description: ''
    post:
      operationId: content_ansible_collection_marks_create
      description: ViewSet for looking at mark objects for CollectionVersion content.
      summary: Create a collection version mark
      tags:
      - 'Content: Collection_Marks'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ansible.CollectionVersionMark'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ansible.CollectionVersionMark'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ansible.CollectionVersionMark'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ansible.CollectionVersionMarkResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/content/ansible/collection_marks/{pulp_id}/:
    get:
      operationId: content_ansible_collection_marks_read
      description: ViewSet for looking at mark objects for CollectionVersion content.
      summary: Inspect a collection version mark
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this collection version mark.
        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:
      - 'Content: Collection_Marks'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ansible.CollectionVersionMarkResponse'
          description: ''
components:
  schemas:
    ansible.CollectionVersionMark:
      type: object
      description: A serializer for mark models.
      properties:
        marked_collection:
          type: string
          format: uri
          description: The content this mark is pointing to.
        value:
          type: string
          minLength: 1
          description: The string value of this mark.
          pattern: ^[-a-zA-Z0-9_]+$
      required:
      - marked_collection
      - value
    ansible.CollectionVersionMarkResponse:
      type: object
      description: A serializer for mark models.
      properties:
        pulp_created:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of creation.
        pulp_href:
          type: string
          format: uri
          readOnly: true
        marked_collection:
          type: string
          format: uri
          description: The content this mark is pointing to.
        value:
          type: string
          description: The string value of this mark.
          pattern: ^[-a-zA-Z0-9_]+$
      required:
      - marked_collection
      - value
    Paginatedansible.CollectionVersionMarkResponseList:
      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/ansible.CollectionVersionMarkResponse'