openapi: 3.2.0
info:
  title: Magnite Supply Labels API
  version: '1.0'
  description: 'Operations tagged Supply Labels across 2 of this provider''s published API definitions: magnite-springserve-v0-openapi.yml, magnite-springserve-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://console.springserve.com
  description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
- url: https://api.springserve.com
  description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
security:
- api_key: []
- bearer_token: []
tags:
- name: Supply Labels
paths:
  /api/v0/supply_labels:
    get:
      summary: Index
      description: List all supply labels. Supports pagination via page, per, and ids params.
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: List of supply labels
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Supply Labels
      operationId: supply_labels_get
    post:
      summary: Create
      description: Creating a Supply Label
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/supply_label_create_simple'
              full:
                $ref: '#/components/examples/supply_label_create_full'
        required: true
      responses:
        '201':
          description: Created supply label
          content:
            application/json:
              schema:
                type: object
              example:
                id: 353
                name: API Docs label
                account_id: 1
      tags:
      - Supply Labels
      operationId: supply_labels_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/supply_labels/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Show
      description: Get a Supply Label
      responses:
        '200':
          description: Supply label details
          content:
            application/json:
              schema:
                type: object
              example:
                id: 1764
                name: API Docs label
                account_id: 1
      tags:
      - Supply Labels
      operationId: supply_labels_id_get
    put:
      summary: Update
      description: Edit a Supply Label
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/supply_label_update_simple'
              full:
                $ref: '#/components/examples/supply_label_update_full'
      responses:
        '200':
          description: Updated supply label
          content:
            application/json:
              schema:
                type: object
              example:
                id: 353
                name: I want to change the name
                account_id: 1
      tags:
      - Supply Labels
      operationId: supply_labels_id_put
    delete:
      summary: Destroy
      description: Delete a supply label
      responses:
        '204':
          description: No content
      tags:
      - Supply Labels
      operationId: supply_labels_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/supply_labels:
    get:
      summary: Index
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/sortParam
      - $ref: ref/params.yaml#/components/parameters/searchParam
      - $ref: ref/params.yaml#/components/parameters/filterParams
      - $ref: ref/params.yaml#/components/parameters/includeParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyLabelIndexResponse'
      tags:
      - Supply Labels
      operationId: supply_labels_get
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/supply_label_create_simple'
              full:
                $ref: '#/components/examples/supply_label_create_full'
        required: true
      responses:
        '201':
          description: Successfully created a new supply label
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyLabel'
        '422':
          $ref: ref/errors.yaml#/components/responses/validationError
      tags:
      - Supply Labels
      operationId: supply_labels_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/supply_labels/{id}:
    get:
      summary: Show
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyLabel'
      tags:
      - Supply Labels
      operationId: supply_labels_id_get
    patch:
      summary: Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/supply_label_update_simple'
              full:
                $ref: '#/components/examples/supply_label_update_full'
        required: true
      responses:
        '200':
          description: Successfully updated a supply label
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyLabel'
        '422':
          $ref: ref/errors.yaml#/components/responses/validationError
      tags:
      - Supply Labels
      operationId: supply_labels_id_patch
    delete:
      summary: Delete
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      tags:
      - Supply Labels
      operationId: supply_labels_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/supply_labels/permissions:
    get:
      summary: Collection Permissions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Supply Labels
      operationId: supply_labels_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/supply_labels/{id}/permissions:
    get:
      summary: Permissions Member
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Supply Labels
      operationId: supply_labels_id_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
components:
  examples:
    supply_label_update_simple:
      summary: Simple
      value:
        name: Supply Label Name
    supply_label_create_simple:
      summary: Simple
      value:
        name: Supply Label Name
    supply_label_update_full:
      summary: Full
      value:
        name: Supply Label Name
        supply_tag_ids:
        - 1
    supply_label_create_full:
      summary: Full
      value:
        name: Supply Label Name
        supply_tag_ids:
        - 1
  schemas:
    SupplyLabelIndexResponse:
      allOf:
      - $ref: ref/params.yaml#/components/schemas/ParamsResponse
      - type: object
        properties:
          results:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/SupplyLabel'
    SupplyLabel:
      type: object
      properties:
        id:
          type: number
        account_id:
          type: number
        name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        supply_tag_ids:
          type: array
          items:
            type: number
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth
x-refined-from:
- magnite-springserve-v0-openapi.yml
- magnite-springserve-v1-openapi.yml