openapi: 3.2.0
info:
  title: Mef Topic API
  version: 1.0.0
  description: 'Operations tagged topic across 6 of this provider''s published API definitions: mef-lso-allegro-streaming-management-all-in-one-openapi.yml, mef-lso-allegro-streaming-management-openapi.yml, mef-lso-interlude-streaming-management-all-in-one-openapi.yml, mef-lso-interlude-streaming-management-openapi.yml, mef-lso-legato-streaming-management-all-in-one-openapi.yml, mef-lso-legato-streaming-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{serverBase}/mefApi/allegro/streamingManagement/v1
  variables:
    serverBase:
      default: mplify.net
      description: The base of SOF's URL.
- url: https://{serverBase}/mefApi/interlude/streamingManagement/v1
  variables:
    serverBase:
      default: mplify.net
      description: The base of SOF's URL.
- url: https://{serverBase}/mefApi/legato/streamingManagement/v1
  variables:
    serverBase:
      default: mplify.net
      description: The base of SOF's URL.
tags:
- description: Groups all operations related to the available topic.
  name: topic
paths:
  /topic:
    get:
      description: List topics available for subscription to performance monitoring data
      operationId: topicList
      parameters:
      - description: Category of the available topic
        in: query
        name: category
        required: false
        schema:
          type: string
      - description: A communication protocol supported by the available topic
        in: query
        name: protocol
        required: false
        schema:
          type: string
      - description: Requested number of elements to be provided in response requested by client
        in: query
        name: limit
        required: false
        schema:
          format: int32
          type: integer
      - description: Requested index for the start of elements to be provided in response requested by the client. Note that the index starts with "0".
        in: query
        name: offset
        required: false
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Topic'
                type: array
          description: Success
          headers:
            X-Pagination-Throttled:
              description: 'Used to indicate that the result page was throttled to a maximum possible size  and there are additional results that can be fetched

                '
              schema:
                type: boolean
            X-Result-Count:
              description: 'Actual number of items returned in the response body E.g. if there are 50 matching items in total,  but the request has offset=10 and limit=10, then the X-Total-Count is 50.

                '
              schema:
                type: integer
            X-Total-Count:
              description: Total number of items included in the response
              schema:
                type: integer
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '405':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
          description: Method Not Allowed
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Retrieve Available Topics
      tags:
      - topic
    servers:
    - url: https://{serverBase}/mefApi/allegro/streamingManagement/v1
      variables:
        serverBase:
          default: mplify.net
          description: The base of SOF's URL.
  /topic/{id}:
    get:
      description: Information about the topic available for subscription
      operationId: topicById
      parameters:
      - description: Identifier of the topic
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Topic'
          description: Success
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '404':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
          description: Not Found
        '405':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
          description: Method Not Allowed
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Retrieve Available Topic by an Identifier
      tags:
      - topic
    servers:
    - url: https://{serverBase}/mefApi/allegro/streamingManagement/v1
      variables:
        serverBase:
          default: mplify.net
          description: The base of SOF's URL.
components:
  schemas:
    Error400Code:
      description: 'One of the following error codes:

        - missingQueryParameter: The URI is missing a required query-string parameter

        - missingQueryValue: The URI is missing a required query-string parameter value

        - invalidQuery: The query section of the URI is invalid.

        - invalidBody: The request has an invalid body'
      enum:
      - missingQueryParameter
      - missingQueryValue
      - invalidQuery
      - invalidBody
      type: string
    Topic:
      additionalProperties: true
      description: 'Provides metadata describing a topic available for subscription. This object is used to define available consumption mechanisms and the data model.

        '
      properties:
        id:
          description: 'An identifier for the topic. This can be used to uniquely identify the topic within the Server system.

            '
          type: string
        category:
          $ref: '#/components/schemas/Category'
          description: 'The category of the topic. This can be used to group topics based on their characteristics.

            '
        modelRef:
          description: 'A reference to a model that describes the structure of the data associated with the topic.

            '
          format: uri
          type: string
        availableChannels:
          description: 'An array of channel descriptions that provide information about the channels through which the topic can be accessed.

            '
          items:
            $ref: '#/components/schemas/ChannelDescription'
          minItems: 1
          type: array
      required:
      - id
      type: object
    Error404:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          code:
            description: 'The following error code:

              - notFound: A current representation for the target resource not found'
            enum:
            - notFound
            type: string
        required:
        - code
        type: object
      description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4)
    ChannelDescription:
      properties:
        protocol:
          description: Name of technical protocol allowing for consumption
          type: string
        description:
          description: Human-friendly description of the protocol
          type: string
      required:
      - protocol
      type: object
    Error403:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          code:
            $ref: '#/components/schemas/Error403Code'
        required:
        - code
        type: object
      description: Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3)
    Error401:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          code:
            $ref: '#/components/schemas/Error401Code'
        required:
        - code
        type: object
      description: Unauthorized.  (https://tools.ietf.org/html/rfc7235#section-3.1)
    Error401Code:
      description: 'One of the following error codes:

        - missingCredentials: No credentials provided.

        - invalidCredentials: Provided credentials are invalid or expired'
      enum:
      - missingCredentials
      - invalidCredentials
      type: string
    Error400:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          code:
            $ref: '#/components/schemas/Error400Code'
        required:
        - code
        type: object
      description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)
    Category:
      description: 'The category of the topic. This can be used to group topics based on their characteristics.

        '
      enum:
      - Layer 1
      - Ethernet
      - IP
      - SD-WAN
      - Computing
      - Storage
      - Memory
      type: string
    Error500:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          code:
            description: 'The following error code:

              - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.'
            enum:
            - internalError
            type: string
        required:
        - code
        type: object
      description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1)
    Error403Code:
      description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes:

        - accessDenied: Access denied

        - forbiddenRequester: Forbidden requester

        - tooManyUsers: Too many users'
      enum:
      - accessDenied
      - forbiddenRequester
      - tooManyUsers
      type: string
    Error:
      description: Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime.
      properties:
        message:
          description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user.
          type: string
        reason:
          description: Text that explains the reason for the error. This can be shown to a client user.
          maxLength: 255
          type: string
        referenceError:
          description: URL pointing to documentation describing the error
          format: uri
          type: string
      required:
      - reason
      type: object
    Topic_2:
      $ref: models/Topic.yaml
    Topic_3:
      $ref: models/Topic.yaml
    Topic_4:
      $ref: models/Topic.yaml
  responses:
    '403':
      description: Forbidden
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error403'
    '401':
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error401'
      description: Unauthorized
    '500':
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error500'
      description: Internal Server Error
    '404':
      description: Not Found
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error404'
    '405':
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error'
      description: Method Not Allowed
    '400':
      description: Bad Request
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error400'
  parameters:
    Offset:
      description: Requested index for the start of elements to be provided in response requested by the client. Note that the index starts with "0".
      in: query
      name: offset
      schema:
        format: int32
        type: integer
    Limit:
      description: Requested number of elements to be provided in response requested by client
      in: query
      name: limit
      schema:
        format: int32
        type: integer
x-refined-from:
- mef-lso-allegro-streaming-management-all-in-one-openapi.yml
- mef-lso-allegro-streaming-management-openapi.yml
- mef-lso-interlude-streaming-management-all-in-one-openapi.yml
- mef-lso-interlude-streaming-management-openapi.yml
- mef-lso-legato-streaming-management-all-in-one-openapi.yml
- mef-lso-legato-streaming-management-openapi.yml