Skip to content

Node.js based forum software built for the modern web

1.6 KB
Raw Blame
TeaserObject:
  type: object
  nullable: true
  properties:
    pid:
      type: number
    url:
      type: string
    uid:
      type: number
      description: A user identifier
    timestamp:
      type: number
    tid:
      type: number
      description: A topic identifier
    content:
      type: string
    sourceContent:
      type: string
      nullable: true
    timestampISO:
      type: string
      description: An ISO 8601 formatted date string (complementing `timestamp`)
    user:
      type: object
      properties:
        uid:
          type: number
          description: A user identifier
        username:
          type: string
          description: A friendly name for a given user account
        displayname:
          type: string
        isLocal:
          type: boolean
        userslug:
          type: string
          description: An URL-safe variant of the username (i.e. lower-cased, spaces
            removed, etc.)
        picture:
          nullable: true
          type: string
        icon:text:
          type: string
          description: A single-letter representation of a username. This is used in the
            auto-generated icon given to users
            without an avatar
        icon:bgColor:
          type: string
          description: A six-character hexadecimal colour code assigned to the user. This
            value is used in conjunction with
            `icon:text` for the user's
            auto-generated icon
          example: "#f44336"
    topic:
      type: object
      additionalProperties: {}
    index:
      type: number
  required:
    - pid