Skip to content

Node.js based forum software built for the modern web

8.9 KB
Raw Blame
get:
  tags:
    - topics
  summary: Get unread topics
  description: Returns a list of the current user's unread topics, sorted by the
    last post's timestamp.
  responses:
    "200":
      description: An array of unread topic objects sorted by the last post's timestamp.
      content:
        application/json:
          schema:
            allOf:
              - type: object
                properties:
                  canPost:
                    type: boolean
                  showSelect:
                    type: boolean
                  showTopicTools:
                    type: boolean
                  reputation:disabled:
                    type: number
                  nextStart:
                    type: number
                  topics:
                    type: array
                    items:
                      allOf:
                        - $ref: ../components/schemas/TopicObject.yaml#/TopicObjectSlim
                        - type: object
                          properties:
                            title:
                              type: string
                            slug:
                              type: string
                            teaserPid:
                              type: number
                              nullable: true
                            titleRaw:
                              type: string
                            category:
                              type: object
                              properties:
                                cid:
                                  type: number
                                  description: A category identifier
                                name:
                                  type: string
                                slug:
                                  type: string
                                icon:
                                  type: string
                                backgroundImage:
                                  type: string
                                  nullable: true
                                imageClass:
                                  type: string
                                  nullable: true
                                bgColor:
                                  type: string
                                color:
                                  type: string
                                disabled:
                                  type: number
                            user:
                              type: object
                              properties:
                                uid:
                                  type: number
                                  description: A user identifier
                                isLocal:
                                  type: boolean
                                  description: Whether the user belongs to the local installation or not.
                                username:
                                  type: string
                                  description: A friendly name for a given user account
                                displayname:
                                  type: string
                                  description: This is either username or fullname depending on forum and user settings
                                fullname:
                                  type: string
                                userslug:
                                  type: string
                                  description: An URL-safe variant of the username (i.e. lower-cased, spaces
                                    removed, etc.)
                                reputation:
                                  type: number
                                postcount:
                                  type: number
                                picture:
                                  nullable: true
                                  type: string
                                banned:
                                  type: boolean
                                status:
                                  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"
                                banned_until:
                                  type: number
                                banned_until_readable:
                                  type: string
                              required:
                                - uid
                                - username
                                - userslug
                                - reputation
                                - postcount
                                - picture
                                - banned
                                - status
                                - icon:text
                                - icon:bgColor
                                - banned_until_readable
                            teaser:
                              $ref: ../components/schemas/TeaserObject.yaml#/TeaserObject
                            tags:
                              type: array
                              items:
                                $ref: ../components/schemas/TagObject.yaml#/TagObject
                            isOwner:
                              type: boolean
                            ignored:
                              type: boolean
                            followed:
                              type: boolean
                            unread:
                              type: boolean
                            bookmark:
                              type: boolean
                              nullable: true
                            unreplied:
                              type: boolean
                            icons:
                              type: array
                              items:
                                type: string
                            index:
                              type: number
                  topicCount:
                    type: number
                  title:
                    type: string
                  pageCount:
                    type: number
                  allCategoriesUrl:
                    type: string
                  selectedCategory:
                    type: object
                    properties:
                      icon:
                        type: string
                      name:
                        type: string
                      bgColor:
                        type: string
                    nullable: true
                  selectCategoryLabel:
                    type: string
                  selectCategoryIcon:
                    type: string
                  showCategorySelectLabel:
                    type: boolean
                  selectedCids:
                    type: array
                    items:
                      type: number
                  selectedTag:
                    type: object
                    properties:
                      label:
                        type: string
                    nullable: true
                  selectedTags:
                    type: array
                    items:
                      type: string
                  filters:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        url:
                          type: string
                        selected:
                          type: boolean
                        filter:
                          type: string
                        icon:
                          type: string
                  selectedFilter:
                    type: object
                    properties:
                      name:
                        type: string
                      url:
                        type: string
                      selected:
                        type: boolean
                      filter:
                        type: string
                      icon:
                        type: string
              - $ref: ../components/schemas/Pagination.yaml#/Pagination
              - $ref: ../components/schemas/Breadcrumbs.yaml#/Breadcrumbs
              - $ref: ../components/schemas/CommonProps.yaml#/CommonProps