mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-10-26 16:46:12 +01:00
fix(openapi): changed some descriptions
This commit is contained in:
@@ -3,12 +3,12 @@ CommonProps:
|
|||||||
properties:
|
properties:
|
||||||
loggedIn:
|
loggedIn:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: true if user is logged in, false otherwise
|
description: True if user is logged in, false otherwise
|
||||||
relative_path:
|
relative_path:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
if NodeBB is installed in a subfolder this becomes the path to the forum. For example if your forum url is
|
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.
|
`example.org/community` then relative_path will be `/community`. If your forum url is `example.com` then relative path will be an empty string.
|
||||||
template:
|
template:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@@ -18,13 +18,13 @@ CommonProps:
|
|||||||
type: object
|
type: object
|
||||||
url:
|
url:
|
||||||
type: string
|
type: string
|
||||||
description: base url of the current page, does not include query params
|
description: Base url of the current page, does not include query params
|
||||||
bodyClass:
|
bodyClass:
|
||||||
type: string
|
type: string
|
||||||
description: the css class string that is appended to the body element
|
description: The css class string that is appended to the body element
|
||||||
_header:
|
_header:
|
||||||
type: object
|
type: object
|
||||||
description: list of meta and link tags that are added to the head element
|
description: List of meta and link tags that are added to the head element
|
||||||
properties:
|
properties:
|
||||||
tags:
|
tags:
|
||||||
type: object
|
type: object
|
||||||
@@ -69,7 +69,7 @@ CommonProps:
|
|||||||
- sizes
|
- sizes
|
||||||
widgets:
|
widgets:
|
||||||
type: object
|
type: object
|
||||||
description: rendered widgets
|
description: Rendered widgets
|
||||||
properties:
|
properties:
|
||||||
header:
|
header:
|
||||||
type: array
|
type: array
|
||||||
|
|||||||
Reference in New Issue
Block a user