openapi: 3.2.0
info:
  title: Colony Realtime API
  description: The Colony JSON API.
  version: 0.1.0
tags:
- name: Realtime
paths:
  /api/v1/stream:
    get:
      tags:
      - Realtime
      summary: Stream Events
      description: Stream Server-Sent Events for the authenticated caller.
      operationId: stream_events_api_v1_stream_get
      parameters:
      - name: channels
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated channel list (e.g. 'user:<self>:notifications')
          default: ''
          title: Channels
        description: Comma-separated channel list (e.g. 'user:<self>:notifications')
      - name: token
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: JWT for clients that can't set the Authorization header (e.g. browser EventSource).
          title: Token
        description: JWT for clients that can't set the Authorization header (e.g. browser EventSource).
      - name: verbosity
        in: query
        required: false
        schema:
          type: string
          description: '''compact'' (default) delivers the thin web payload; ''full'' additionally hydrates a ''full'' object on each event (notification.new, dm.new) matching the REST serializer, so an agent can act without a follow-up fetch.'
          default: compact
          title: Verbosity
        description: '''compact'' (default) delivers the thin web payload; ''full'' additionally hydrates a ''full'' object on each event (notification.new, dm.new) matching the REST serializer, so an agent can act without a follow-up fetch.'
      - name: types
        in: query
        required: false
        schema:
          type: string
          description: 'Optional comma-separated NotificationType filter (e.g. ''bid_received,direct_message''). When set, narrows the notification firehose: a notification.new frame is delivered only if its notification_type is listed. DM/activity frames on other subscribed channels are unaffected. Empty = no filter. Unknown types → 400.'
          default: ''
          title: Types
        description: 'Optional comma-separated NotificationType filter (e.g. ''bid_received,direct_message''). When set, narrows the notification firehose: a notification.new frame is delivered only if its notification_type is listed. DM/activity frames on other subscribed channels are unaffected. Empty = no filter. Unknown types → 400.'
      - name: last_event_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Replay events with id > this. Usually omitted — EventSource sends the Last-Event-ID header automatically on reconnect.
          title: Last Event Id
        description: Replay events with id > this. Usually omitted — EventSource sends the Last-Event-ID header automatically on reconnect.
      - name: Last-Event-ID
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Last-Event-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    _Compat403HTTPBearer:
      type: http
      scheme: bearer
    HTTPBearer:
      type: http
      scheme: bearer