Skip to content

Node.js based forum software built for the modern web

2.7 KB
Raw Blame
get:
  tags:
    - flags
  summary: /api/flags/{flagId}
  parameters:
    - name: flagId
      in: path
      required: true
      schema:
        type: string
      example: 1
  responses:
    "200":
      description: ""
      content:
        application/json:
          schema:
            allOf:
              - $ref: ../../components/schemas/FlagObject.yaml#/FlagObject
              - type: object
                properties:
                  type_path:
                    type: string
                  assignees:
                    type: array
                    items:
                      $ref: ../../components/schemas/UserObject.yaml#/UserObject
                  type_bool:
                    type: object
                    properties:
                      post:
                        type: boolean
                      user:
                        type: boolean
                      empty:
                        type: boolean
                  title:
                    type: string
                  privileges:
                    type: object
                    properties: {}
                    additionalProperties:
                      description: "A list of global and admin privileges, and whether the calling user has (or has inherited) them"
                      type: boolean
                  states:
                    type: object
                    properties:
                      open:
                        type: object
                        properties:
                          label:
                            type: string
                          class:
                            type: string
                      wip:
                        type: object
                        properties:
                          label:
                            type: string
                          class:
                            type: string
                      resolved:
                        type: object
                        properties:
                          label:
                            type: string
                          class:
                            type: string
                      rejected:
                        type: object
                        properties:
                          label:
                            type: string
                          class:
                            type: string
                    additionalProperties:
                      type: object
                      description: Plugins are able to add additional flag states, and so their values would also be present here if so.
              - $ref: ../../components/schemas/Breadcrumbs.yaml#/Breadcrumbs
              - $ref: ../../components/schemas/CommonProps.yaml#/CommonProps