Skip to content

Node.js based forum software built for the modern web

5.9 KB
Raw Blame
get:
  tags:
    - admin
  summary: Get forum settings and admin only settings
  description: This route retrieves forum settings and user-specific settings for client-side and admin-side options on the forum.
  responses:
    "200":
      description: ""
      content:
        application/json:
          schema:
            type: object
            properties:
              url:
                type: string
              relative_path:
                type: string
              upload_url:
                type: string
              assetBaseUrl:
                type: string
              asset_base_url:
                type: string
              siteTitle:
                type: string
              browserTitle:
                type: string
              description:
                type: string
              keywords:
                type: string
              brand:logo:
                type: string
              titleLayout:
                type: string
              showSiteTitle:
                type: boolean
              maintenanceMode:
                type: boolean
              postQueue:
                type: number
              minimumTitleLength:
                type: number
              maximumTitleLength:
                type: number
              minimumPostLength:
                type: number
              maximumPostLength:
                type: number
              minimumTagsPerTopic:
                type: number
              maximumTagsPerTopic:
                type: number
              minimumTagLength:
                type: number
              undoTimeout:
                type: number
              maximumTagLength:
                type: number
              useOutgoingLinksPage:
                type: boolean
              allowGuestHandles:
                type: boolean
              allowTopicsThumbnail:
                type: boolean
              usePagination:
                type: boolean
              disableChat:
                type: boolean
              disableChatMessageEditing:
                type: boolean
              maximumChatMessageLength:
                type: number
              socketioTransports:
                type: array
                items:
                  type: string
              socketioOrigins:
                type: string
              websocketAddress:
                type: string
              maxReconnectionAttempts:
                type: number
              reconnectionDelay:
                type: number
              topicsPerPage:
                type: number
              postsPerPage:
                type: number
              maximumFileSize:
                type: number
              convertPastedImageTo:
                type: string
              theme:id:
                type: string
              theme:src:
                type: string
              defaultLang:
                type: string
              userLang:
                type: string
              loggedIn:
                type: boolean
              uid:
                type: number
                description: A user identifier
              cache-buster:
                type: string
              topicPostSort:
                type: string
              categoryTopicSort:
                type: string
              csrf_token:
                type: string
              searchEnabled:
                type: boolean
              searchDefaultInQuick:
                type: string
              disableCustomUserSkins:
                type: boolean
              bootswatchSkin:
                type: string
              defaultBootswatchSkin:
                type: string
              composer:showHelpTab:
                type: boolean
              enablePostHistory:
                type: boolean
              timeagoCutoff:
                type: number
              timeagoCodes:
                type: array
                items:
                  type: string
              cookies:
                type: object
                properties:
                  enabled:
                    type: boolean
                  message:
                    type: string
                  dismiss:
                    type: string
                  link:
                    type: string
                  link_url:
                    type: string
              thumbs:
                type: object
                properties:
                  size:
                    type: number
              activitypub:
                type: object
                properties:
                  probe:
                    type: number
                  worldDefaultCid:
                    type: number
              acpLang:
                type: string
              hideReadNotifications:
                type: boolean
              notificationType_new-reply:
                type: string
              notificationType_new-topic-with-tag:
                type: string
              openOutgoingLinksInNewTab:
                type: boolean
              topicSearchEnabled:
                type: boolean
              hideSubCategories:
                type: boolean
              hideCategoryLastPost:
                type: boolean
              enableQuickReply:
                type: boolean
              emailPrompt:
                type: number
              useragent:
                type: object
                properties:
                  isSafari:
                    type: boolean
              composer-default:
                type: object
              fontawesome:
                type: object
                properties:
                  pro:
                    type: boolean
                  styles:
                    type: array
                    items:
                      type: string
                  version:
                    type: string
              tinycon:
                type: object
                properties:
                  color:
                    type: string
                  background:
                    type: string