RomM Notifications API

openapi: 3.2.0
info:
  title: RomM Notifications API
  version: 5.4.0
tags:
- name: Notifications
paths:
  /api/notifications:
    get:
      tags:
      - Notifications
      summary: Get Notifications
      description: The caller's notifications, newest first.
      operationId: get_notifications_api_notifications_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NotificationSchema'
                type: array
                title: Response Get Notifications Api Notifications Get
      security:
      - OAuth2PasswordBearer:
        - me.read
      - HTTPBasic: []
    post:
      tags:
      - Notifications
      summary: Create Notification
      description: 'Notify the caller or, for an admin, other users; returns what was sent.


        Other users see the caller as its sender.'
      operationId: create_notification_api_notifications_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationCreatePayload'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NotificationSchema'
                type: array
                title: Response Create Notification Api Notifications Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
    delete:
      tags:
      - Notifications
      summary: Dismiss All Notifications
      operationId: dismiss_all_notifications_api_notifications_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
  /api/notifications/read:
    post:
      tags:
      - Notifications
      summary: Mark Notifications Read
      description: Mark the given notifications read, or all of them when `ids` is null.
      operationId: mark_notifications_read_api_notifications_read_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationIdsPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
  /api/notifications/{notification_id}:
    delete:
      tags:
      - Notifications
      summary: Dismiss Notification
      operationId: dismiss_notification_api_notifications__notification_id__delete
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: integer
          title: Notification Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    NotificationKind:
      type: string
      enum:
      - custom
      - scan_completed
      - scan_failed
      - task_completed
      - task_failed
      - streaming_session_ended
      - role_changed
      - channel_disabled
      - device_install_completed
      - device_install_failed
      title: NotificationKind
      description: What happened, translated by the client; any other kind shows its own title and body.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NotificationLevel:
      type: string
      enum:
      - info
      - success
      - warning
      - error
      title: NotificationLevel
    NotificationCreatePayload:
      properties:
        title:
          type: string
          maxLength: 255
          minLength: 1
          title: Title
        body:
          anyOf:
          - type: string
            maxLength: 1000
          - type: 'null'
          title: Body
        level:
          $ref: '#/components/schemas/NotificationLevel'
          default: info
        kind:
          type: string
          maxLength: 64
          pattern: ^[a-z0-9][a-z0-9_.:-]*$
          title: Kind
          default: custom
        link:
          anyOf:
          - type: string
            maxLength: 1000
          - type: 'null'
          title: Link
          description: A path inside RomM, such as `/rom/12`.
        icon:
          anyOf:
          - type: string
            maxLength: 64
            pattern: ^mdi-[a-z0-9-]+$
          - type: 'null'
          title: Icon
          description: A Material Design Icons name, such as `mdi-sync`.
        data:
          additionalProperties: true
          type: object
          title: Data
        recipients:
          anyOf:
          - items:
              type: integer
            type: array
          - type: string
            enum:
            - admins
            - all
          - type: 'null'
          title: Recipients
          description: User ids, `admins` or `all`; only an admin may notify anyone but themselves. Null notifies the caller.
      type: object
      required:
      - title
      title: NotificationCreatePayload
      description: A notification sent through the API, shown with its own title and body.
    NotificationActorSchema:
      properties:
        id:
          type: integer
          title: Id
        username:
          type: string
          title: Username
        avatar_path:
          type: string
          title: Avatar Path
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - username
      - avatar_path
      - updated_at
      title: NotificationActorSchema
    NotificationIdsPayload:
      properties:
        ids:
          anyOf:
          - items:
              type: integer
            type: array
            maxItems: 200
          - type: 'null'
          title: Ids
      type: object
      title: NotificationIdsPayload
      description: Targets some of the caller's notifications, or all of them when `ids` is null.
    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
    NotificationSchema:
      properties:
        id:
          type: integer
          title: Id
        kind:
          anyOf:
          - $ref: '#/components/schemas/NotificationKind'
          - type: string
          title: Kind
        level:
          $ref: '#/components/schemas/NotificationLevel'
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
        link:
          anyOf:
          - type: string
          - type: 'null'
          title: Link
        icon:
          anyOf:
          - type: string
          - type: 'null'
          title: Icon
        data:
          additionalProperties: true
          type: object
          title: Data
        actor:
          anyOf:
          - $ref: '#/components/schemas/NotificationActorSchema'
          - type: 'null'
        read_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Read At
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - kind
      - level
      - title
      - body
      - link
      - icon
      - data
      - actor
      - read_at
      - created_at
      title: NotificationSchema
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            me.read: View your profile
            roms.read: View ROMs
            platforms.read: View platforms
            assets.read: View assets
            devices.read: View devices
            firmware.read: View firmware
            roms.user.read: View user-rom properties
            collections.read: View collections
            playlists.read: View music playlists
            me.write: Modify your profile
            assets.write: Modify assets
            devices.write: Modify devices
            roms.user.write: Modify user-rom properties
            collections.write: Modify collections
            playlists.write: Modify music playlists
            roms.write: Modify ROMs
            platforms.write: Modify platforms
            firmware.write: Modify firmware
            users.read: View users
            users.write: Modify users
            tasks.run: Run tasks
            logs.read: View backend logs
          tokenUrl: /token
    HTTPBasic:
      type: http
      scheme: basic