openapi.yaml

# This file has been generated using OpenApiSpex. Do not edit manually!
# Run `mix api.spec` to regenerate

---
components:
  responses: {}
  schemas:
    AuthToken:
      description: Token for authorizing websocket connection
      example: 5cdac726-57a3-4ecb-b1d5-72a3d62ec242
      title: AuthToken
      type: string
      x-struct: Elixir.JellyfishWeb.ApiSpec.Peer.Token
    Component:
      description: Describes component
      properties:
        id:
          description: Assigned component id
          example: component-1
          type: string
        metadata:
          $ref: '#/components/schemas/ComponentMetadata'
        type:
          $ref: '#/components/schemas/ComponentType'
      required:
        - id
        - type
        - metadata
      title: Component
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Component
    ComponentDetailsResponse:
      description: Response containing component details
      properties:
        data:
          $ref: '#/components/schemas/Component'
      required:
        - data
      title: ComponentDetailsResponse
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.ComponentDetailsResponse
    ComponentMetadata:
      description: Component-specific metadata
      properties:
        playable:
          type: boolean
      title: ComponentMetadata
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Component.Metadata
    ComponentOptions:
      description: Component-specific options
      oneOf:
        - $ref: '#/components/schemas/ComponentOptionsHLS'
        - $ref: '#/components/schemas/ComponentOptionsRTSP'
      title: ComponentOptions
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Component.Options
    ComponentOptionsHLS:
      description: Options specific to the HLS component
      properties: {}
      title: ComponentOptionsHLS
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Component.HLS
    ComponentOptionsRTSP:
      description: Options specific to the RTSP component
      properties:
        keepAliveInterval:
          default: 15000
          description: Interval (in ms) in which keep-alive RTSP messages will be sent to the remote stream source
          minimum: 0
          type: integer
        pierceNat:
          default: true
          description: Whether to attempt to create client-side NAT binding by sending an empty datagram from client to source, after the completion of RTSP setup
          type: boolean
        reconnectDelay:
          default: 15000
          description: Delay (in ms) between successive reconnect attempts
          minimum: 0
          type: integer
        rtpPort:
          default: 20000
          description: Local port RTP stream will be received at
          maximum: 65535
          minimum: 1
          type: integer
        sourceUri:
          description: URI of RTSP source stream
          example: rtsp://localhost:554/stream
          type: string
      required:
        - sourceUri
      title: ComponentOptionsRTSP
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Component.RTSP
    ComponentType:
      description: Component type
      example: hls
      title: ComponentType
      type: string
      x-struct: Elixir.JellyfishWeb.ApiSpec.Component.Type
    Error:
      description: Error message
      properties:
        errors:
          description: Error details
          example: Token has expired
          type: string
      required:
        - errors
      title: Error
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Error
    HlsMsn:
      description: Segment sequence number
      example: 10
      minimum: 0
      nullable: true
      title: HlsMsn
      type: integer
      x-struct: Elixir.JellyfishWeb.ApiSpec.HLS.Params.HlsMsn
    HlsPart:
      description: Partial segment sequence number
      example: 10
      minimum: 0
      nullable: true
      title: HlsPart
      type: integer
      x-struct: Elixir.JellyfishWeb.ApiSpec.HLS.Params.HlsPart
    HlsResponse:
      description: Requested file
      title: HlsResponse
      type: string
      x-struct: Elixir.JellyfishWeb.ApiSpec.HLS.Response
    HlsSkip:
      description: Is delta manifest requested
      enum:
        - YES
      example: YES
      nullable: true
      title: HlsSkip
      type: string
      x-struct: Elixir.JellyfishWeb.ApiSpec.HLS.Params.HlsSkip
    Peer:
      description: Describes peer status
      properties:
        id:
          description: Assigned peer id
          example: peer-1
          type: string
        status:
          $ref: '#/components/schemas/PeerStatus'
        type:
          $ref: '#/components/schemas/PeerType'
      required:
        - id
        - type
        - status
      title: Peer
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Peer
    PeerDetailsResponse:
      description: Response containing peer details and their token
      properties:
        data:
          properties:
            peer:
              $ref: '#/components/schemas/Peer'
            token:
              $ref: '#/components/schemas/AuthToken'
          required:
            - peer
            - token
          type: object
      required:
        - data
      title: PeerDetailsResponse
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.PeerDetailsResponse
    PeerOptions:
      description: Peer-specific options
      oneOf:
        - $ref: '#/components/schemas/PeerOptionsWebRTC'
      title: PeerOptions
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Peer.Options
    PeerOptionsWebRTC:
      description: Options specific to the WebRTC peer
      properties:
        enableSimulcast:
          default: true
          description: Enables the peer to use simulcast
          type: boolean
      title: PeerOptionsWebRTC
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Peer.WebRTC
    PeerStatus:
      description: Informs about the peer status
      enum:
        - connected
        - disconnected
      example: disconnected
      title: PeerStatus
      type: string
      x-struct: Elixir.JellyfishWeb.ApiSpec.Peer.Status
    PeerType:
      description: Peer type
      example: webrtc
      title: PeerType
      type: string
      x-struct: Elixir.JellyfishWeb.ApiSpec.Peer.Type
    Room:
      description: Description of the room state
      properties:
        components:
          items:
            $ref: '#/components/schemas/Component'
          type: array
        config:
          $ref: '#/components/schemas/RoomConfig'
        id:
          description: Room ID
          example: room-1
          type: string
        peers:
          items:
            $ref: '#/components/schemas/Peer'
          type: array
      required:
        - id
        - config
        - components
        - peers
      title: Room
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Room
    RoomConfig:
      description: Room configuration
      properties:
        maxPeers:
          description: Maximum amount of peers allowed into the room
          example: 10
          minimum: 1
          nullable: true
          type: integer
        videoCodec:
          description: Enforces video codec for each peer in the room
          enum:
            - h264
            - vp8
          nullable: true
          type: string
      title: RoomConfig
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.Room.Config
    RoomCreateDetailsResponse:
      description: Response containing room details
      properties:
        data:
          properties:
            jellyfish_address:
              description: Jellyfish instance address where the room was created. This might be different than the address of Jellyfish where the request was sent only when running a cluster of Jellyfishes.
              example: jellyfish1:5003
              type: string
            room:
              $ref: '#/components/schemas/Room'
          required:
            - room
            - jellyfish_address
          type: object
      required:
        - data
      title: RoomCreateDetailsResponse
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.RoomCreateDetailsResponse
    RoomDetailsResponse:
      description: Response containing room details
      properties:
        data:
          $ref: '#/components/schemas/Room'
      required:
        - data
      title: RoomDetailsResponse
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.RoomDetailsResponse
    RoomsListingResponse:
      description: Response containing list of all rooms
      properties:
        data:
          items:
            $ref: '#/components/schemas/Room'
          type: array
      required:
        - data
      title: RoomsListingResponse
      type: object
      x-struct: Elixir.JellyfishWeb.ApiSpec.RoomsListingResponse
  securitySchemes:
    authorization:
      scheme: bearer
      type: http
info:
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  title: Jellyfish Media Server
  version: 0.2.0
openapi: 3.0.0
paths:
  /hls/{room_id}/{filename}:
    get:
      callbacks: {}
      operationId: JellyfishWeb.HLSController.index
      parameters:
        - description: Room id
          in: path
          name: room_id
          required: true
          schema:
            type: string
        - description: Name of the file
          in: path
          name: filename
          required: true
          schema:
            type: string
        - description: Byte range of partial segment
          in: header
          name: range
          required: false
          schema:
            type: string
        - description: Segment sequence number
          in: query
          name: _HLS_msn
          required: false
          schema:
            $ref: '#/components/schemas/HlsMsn'
        - description: Partial segment sequence number
          in: query
          name: _HLS_part
          required: false
          schema:
            $ref: '#/components/schemas/HlsPart'
        - description: Is delta manifest requested
          in: query
          name: _HLS_skip
          required: false
          schema:
            $ref: '#/components/schemas/HlsSkip'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HlsResponse'
          description: File was found
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: File not found
      summary: Send file
      tags: []
  /room:
    get:
      callbacks: {}
      operationId: JellyfishWeb.RoomController.index
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoomsListingResponse'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
      summary: Show information about all rooms
      tags:
        - room
    post:
      callbacks: {}
      operationId: JellyfishWeb.RoomController.create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoomConfig'
        description: Room configuration
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoomCreateDetailsResponse'
          description: Room successfully created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request structure
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
      summary: Creates a room
      tags:
        - room
  /room/{room_id}:
    delete:
      callbacks: {}
      operationId: JellyfishWeb.RoomController.delete
      parameters:
        - description: Room id
          in: path
          name: room_id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successfully deleted room
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Room doesn't exist
      summary: Delete the room
      tags:
        - room
    get:
      callbacks: {}
      operationId: JellyfishWeb.RoomController.show
      parameters:
        - description: Room ID
          in: path
          name: room_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoomDetailsResponse'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Room doesn't exist
      summary: Shows information about the room
      tags:
        - room
  /room/{room_id}/component:
    post:
      callbacks: {}
      operationId: JellyfishWeb.ComponentController.create
      parameters:
        - description: Room ID
          in: path
          name: room_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                options:
                  $ref: '#/components/schemas/ComponentOptions'
                type:
                  $ref: '#/components/schemas/ComponentType'
              required:
                - type
                - options
              type: object
        description: Component config
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetailsResponse'
          description: Successfully added component
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Room doesn't exist
      summary: Creates the component and adds it to the room
      tags:
        - component
  /room/{room_id}/component/{id}:
    delete:
      callbacks: {}
      operationId: JellyfishWeb.ComponentController.delete
      parameters:
        - description: Room ID
          in: path
          name: room_id
          required: true
          schema:
            type: string
        - description: Component ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successfully deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Either component or the room doesn't exist
      summary: Delete the component from the room
      tags:
        - component
  /room/{room_id}/peer:
    post:
      callbacks: {}
      operationId: JellyfishWeb.PeerController.create
      parameters:
        - description: Room id
          in: path
          name: room_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                options:
                  $ref: '#/components/schemas/PeerOptions'
                type:
                  $ref: '#/components/schemas/PeerType'
              required:
                - type
                - options
              type: object
        description: Peer specification
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeerDetailsResponse'
          description: Peer successfully created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request body structure
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Room doesn't exist
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Peer limit has been reached
      summary: Create peer
      tags:
        - peer
  /room/{room_id}/peer/{id}:
    delete:
      callbacks: {}
      operationId: JellyfishWeb.PeerController.delete
      parameters:
        - description: Room ID
          in: path
          name: room_id
          required: true
          schema:
            type: string
        - description: Peer id
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Peer successfully deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Room ID or Peer ID references a resource that doesn't exist
      summary: Delete peer
      tags:
        - peer
security:
  - authorization: []
servers: []
tags: []