Files
NodeBB/public/openapi/read/world.yaml

88 lines
2.9 KiB
YAML
Raw Permalink Normal View History

2024-02-20 15:01:38 -05:00
get:
tags:
- topics
summary: Get external topics
description: Returns a list of external topics known to the local instance
parameters:
- name: filter
in: path
required: true
schema:
type: string
example: all
2024-02-20 15:01:38 -05:00
responses:
"200":
description: An array of topic objects sorted by timestamp.
content:
application/json:
schema:
allOf:
2024-03-28 13:20:30 +01:00
- $ref: ../components/schemas/CategoryObject.yaml#/CategoryObject
2024-02-20 15:01:38 -05:00
- type: object
properties:
2024-03-28 13:20:30 +01:00
tagWhitelist:
type: array
items:
type: string
posts:
allOf:
- $ref: ../components/schemas/PostsObject.yaml#/PostsObject
- type: object
properties:
bookmarks:
type: number
showThumbs:
type: boolean
showTopicTools:
type: boolean
showSelect:
type: boolean
2024-03-28 13:20:30 +01:00
isWatched:
type: boolean
isTracked:
type: boolean
isNotWatched:
type: boolean
isIgnored:
type: boolean
hasFollowers:
type: boolean
nullable: true
privileges:
type: object
properties:
topics:create:
type: boolean
topics:read:
type: boolean
topics:schedule:
type: boolean
topics:tag:
type: boolean
read:
type: boolean
posts:view_deleted:
type: boolean
cid:
type: string
example: '-1'
uid:
type: number
description: A user identifier
editable:
type: boolean
view_deleted:
type: boolean
isAdminOrMod:
type: boolean
2024-03-28 13:20:30 +01:00
title:
type: string
2026-02-09 18:23:29 -05:00
topicCount:
type: number
categories:
type: array
items:
$ref: ../components/schemas/CategoryObject.yaml#/CategoryObject
2024-02-20 15:01:38 -05:00
- $ref: ../components/schemas/Pagination.yaml#/Pagination
- $ref: ../components/schemas/Breadcrumbs.yaml#/Breadcrumbs
- $ref: ../components/schemas/CommonProps.yaml#/CommonProps