From 442c018ec0cbc4c4aea2522ec619b8365f3b9c5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bar=C4=B1=C5=9F=20Soner=20U=C5=9Fakl=C4=B1?= Date: Tue, 7 Apr 2020 00:23:10 -0400 Subject: [PATCH] feat: add some descriptions --- public/openapi/read.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/public/openapi/read.yaml b/public/openapi/read.yaml index 757e673aa4..f289527ba8 100644 --- a/public/openapi/read.yaml +++ b/public/openapi/read.yaml @@ -44,14 +44,21 @@ components: properties: loggedIn: type: boolean + description: true if user is logged in, false otherwise relative_path: type: string + description: | + if NodeBB is installed in a subfolder this becomes the path to the forum. For example if your forum url is + mycompany.com/community then relative_path will be /community. If your forum url is myforum.com then relative path will be empty string. url: type: string + description: base url of the current page, does not include query params bodyClass: type: string + description: the css class string that is appended to the body element _header: type: object + description: list of meta and link tags that are added to the head element properties: tags: type: object @@ -96,7 +103,22 @@ components: - sizes widgets: type: object + description: rendered widgets properties: + header: + type: array + items: + type: object + properties: + html: + type: string + sidebar: + type: array + items: + type: object + properties: + html: + type: string footer: type: array items: