openapi: 3.2.0
info:
  title: Istreamplanet Channels API
  version: v1.52.0
  contact:
    email: live-control-plane-devs@wbd.com
    name: ChannelAPI Support
    url: https://warnermedia.enterprise.slack.com/archives/C0648UND8SD
  description: 'Operations tagged Channels across 2 of this provider''s published API definitions: istreamplanet-aventus-channels-openapi.json, istreamplanet-aventus-channels-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: prod
  url: https://api.istreamplanet.com
security:
- authcode: []
  m2m: []
tags:
- name: Channels
paths:
  /v2/channels:
    get:
      description: Get a list of your channels.
      operationId: list-channels
      parameters:
      - description: Current page cursor
        explode: false
        in: query
        name: cursor
        schema:
          description: Current page cursor
          type: string
      - description: Number of items to return
        explode: false
        in: query
        name: page_size
        schema:
          default: 100
          description: Number of items to return
          format: int32
          maximum: 100
          minimum: 1
          type: integer
      - description: Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.
        explode: false
        in: query
        name: q
        schema:
          description: Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.
          maxLength: 256
          minLength: 3
          pattern: ^[\w -]+$
          type: string
      - description: List channels that are ON or OFF
        explode: false
        in: query
        name: desired_state
        schema:
          description: List channels that are ON or OFF
          enum:
          - 'ON'
          - 'OFF'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Summary'
                type:
                - array
                - 'null'
          description: OK
          headers:
            Link:
              schema:
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unauthorized
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '499':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: List channels
      tags:
      - Channels
    servers:
    - description: prod
      url: https://api.istreamplanet.com
components:
  schemas:
    Summary:
      additionalProperties: false
      properties:
        desired_state:
          description: Desired state of channel
          enum:
          - 'ON'
          - 'OFF'
          examples:
          - 'ON'
          type: string
        etag:
          description: Content hash
          examples:
          - 4bc54fd8
          type: string
        id:
          description: Unique channel ID
          examples:
          - hbo-west
          type: string
        labels:
          description: Channel Labels
          items:
            type: string
          type:
          - array
          - 'null'
        name:
          description: Friendly channel description
          examples:
          - HBO West
          type: string
        org:
          description: Organization
          type: string
        self:
          description: Link to this resource
          format: uri
          readOnly: true
          type: string
        source:
          $ref: '#/components/schemas/SourceSummary'
          description: Channel source
      required:
      - org
      - id
      - etag
      - source
      - desired_state
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    SourceSummary:
      additionalProperties: false
      properties:
        id:
          description: Station source ID
          examples:
          - stn-knc54ts9kazynm97
          type: string
        name:
          description: Source name
          examples:
          - HBO
          type: string
        self:
          description: Link to this resource
          format: uri
          readOnly: true
          type: string
      required:
      - id
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://api.istreamplanet.com/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
  securitySchemes:
    authcode:
      flows:
        authorizationCode:
          authorizationUrl: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/authorize
          scopes: null
          tokenUrl: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/token
      type: oauth2
    m2m:
      flows:
        clientCredentials:
          scopes: null
          tokenUrl: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/token
      type: oauth2
x-refined-from:
- istreamplanet-aventus-channels-openapi.json
- istreamplanet-aventus-channels-openapi.yml
x-cli-config:
  params:
    authorize_url: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/authorize
    client_id: 0oa125bj1lwLZRxjD0x8
    redirect_url: http://auth.rest.sh:8484
    scopes: offline_access,Groups
    state: non-empty
    token_url: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/token
  security: authcode