feat: moved component specs into separate files
psychobunny
5 years ago
parent
2425f4533f
commit
cd5065572c
@ -0,0 +1,12 @@
|
||||
Breadcrumbs:
|
||||
type: object
|
||||
properties:
|
||||
breadcrumbs:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
text:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
@ -0,0 +1,94 @@
|
||||
CommonProps:
|
||||
type: object
|
||||
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.
|
||||
template:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
additionalProperties:
|
||||
type: object
|
||||
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
|
||||
properties:
|
||||
meta:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
content:
|
||||
type: string
|
||||
noEscape:
|
||||
type: boolean
|
||||
property:
|
||||
type: string
|
||||
required:
|
||||
- name
|
||||
- content
|
||||
- noEscape
|
||||
- property
|
||||
link:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
rel:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
href:
|
||||
type: string
|
||||
title:
|
||||
type: string
|
||||
sizes:
|
||||
type: string
|
||||
required:
|
||||
- rel
|
||||
- href
|
||||
- type
|
||||
- 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:
|
||||
type: object
|
||||
properties:
|
||||
html:
|
||||
type: string
|
||||
@ -0,0 +1,44 @@
|
||||
Pagination:
|
||||
type: object
|
||||
properties:
|
||||
pagination:
|
||||
type: object
|
||||
properties:
|
||||
prev:
|
||||
type: object
|
||||
properties:
|
||||
page:
|
||||
type: number
|
||||
active:
|
||||
type: boolean
|
||||
next:
|
||||
type: object
|
||||
properties:
|
||||
page:
|
||||
type: number
|
||||
active:
|
||||
type: boolean
|
||||
first:
|
||||
type: object
|
||||
properties:
|
||||
page:
|
||||
type: number
|
||||
active:
|
||||
type: boolean
|
||||
last:
|
||||
type: object
|
||||
properties:
|
||||
page:
|
||||
type: number
|
||||
active:
|
||||
type: boolean
|
||||
rel:
|
||||
type: array
|
||||
items: {}
|
||||
pages:
|
||||
type: array
|
||||
items: {}
|
||||
currentPage:
|
||||
type: number
|
||||
pageCount:
|
||||
type: number
|
||||
@ -0,0 +1,394 @@
|
||||
UserObject:
|
||||
type: object
|
||||
properties:
|
||||
uid:
|
||||
type: number
|
||||
description: A user identifier
|
||||
example: 1
|
||||
username:
|
||||
type: string
|
||||
description: A friendly name for a given user account
|
||||
example: Dragon Fruit
|
||||
userslug:
|
||||
type: string
|
||||
description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.)
|
||||
example: dragon-fruit
|
||||
email:
|
||||
type: string
|
||||
description: Email address associated with the user account
|
||||
example: dragonfruit@example.org
|
||||
'email:confirmed':
|
||||
type: number
|
||||
description: Whether the user has confirmed their email address or not
|
||||
example: 1
|
||||
joindate:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the user's account was created
|
||||
example: 1585337827953
|
||||
lastonline:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the user was last recorded online on this site
|
||||
example: 1585337827953
|
||||
picture:
|
||||
type: string
|
||||
description: A URL pointing to a picture to be used as the user's avatar
|
||||
example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80'
|
||||
fullname:
|
||||
type: string
|
||||
example: Mr. Dragon Fruit Jr.
|
||||
location:
|
||||
type: string
|
||||
example: 'Toronto, Canada'
|
||||
birthday:
|
||||
type: string
|
||||
description: A birthdate given in an ISO format parseable by the Date object
|
||||
example: 03/27/2020
|
||||
website:
|
||||
type: string
|
||||
example: 'https://example.org'
|
||||
aboutme:
|
||||
type: string
|
||||
example: |
|
||||
This is a paragraph all about how my life got twist-turned upside-down
|
||||
and I'd like to take a minute and sit right here,
|
||||
to tell you all about how I because the administrator of NodeBB
|
||||
signature:
|
||||
type: string
|
||||
example: |
|
||||
This is an example signature
|
||||
It can span multiple lines.
|
||||
uploadedpicture:
|
||||
type: string
|
||||
example: /assets/profile/1-profileimg.png
|
||||
description: 'In almost all cases, defer to "picture" instead. Use this if you need to specifically reference the picture uploaded to the forum.'
|
||||
profileviews:
|
||||
type: number
|
||||
description: The number of times this user's profile has been viewed
|
||||
example: 1000
|
||||
reputation:
|
||||
type: number
|
||||
description: The user's reputation score on the forum. Out-of-the-box, users gain/lose reputation points based on upvotes/downvotes, though plugins can alter the logic and criterion for awarding reputation points
|
||||
example: 100
|
||||
postcount:
|
||||
type: number
|
||||
example: 1000
|
||||
topiccount:
|
||||
type: number
|
||||
example: 50
|
||||
lastposttime:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the user posted last
|
||||
example: 1585337827953
|
||||
banned:
|
||||
type: number
|
||||
description: A Boolean representing whether a user is banned or not
|
||||
example: 0
|
||||
'banned:expire':
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the ban will be lifted
|
||||
example: 1585337827953
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- online
|
||||
- offline
|
||||
- dnd
|
||||
- away
|
||||
example: online
|
||||
flags:
|
||||
type: number
|
||||
example: 0
|
||||
followercount:
|
||||
type: number
|
||||
example: 2
|
||||
followingcount:
|
||||
type: number
|
||||
example: 5
|
||||
'cover:url':
|
||||
type: string
|
||||
example: /assets/profile/1-cover.png
|
||||
'cover:position':
|
||||
type: string
|
||||
example: 50.0301% 19.2464%
|
||||
groupTitle:
|
||||
type: string
|
||||
example: '["administrators","Staff"]'
|
||||
groupTitleArray:
|
||||
type: array
|
||||
example:
|
||||
- administrators
|
||||
- Staff
|
||||
'icon:text':
|
||||
type: string
|
||||
description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar
|
||||
example: D
|
||||
'icon:bgColor':
|
||||
type: string
|
||||
description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon
|
||||
example: '#9c27b0'
|
||||
joindateISO:
|
||||
type: string
|
||||
example: '2020-03-27T20:30:36.590Z'
|
||||
lastonlineISO:
|
||||
type: string
|
||||
example: '2020-03-27T20:30:36.590Z'
|
||||
banned_until:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment a ban will be lifted
|
||||
example: 0
|
||||
banned_until_readable:
|
||||
type: string
|
||||
description: An ISO 8601 formatted date string representing the moment a ban will be lifted, or the words "Not Banned"
|
||||
example: Not Banned
|
||||
UserObjectFull:
|
||||
type: object
|
||||
properties:
|
||||
uid:
|
||||
type: number
|
||||
description: A user identifier
|
||||
example: 1
|
||||
username:
|
||||
type: string
|
||||
description: A friendly name for a given user account
|
||||
example: Dragon Fruit
|
||||
userslug:
|
||||
type: string
|
||||
description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.)
|
||||
example: dragon-fruit
|
||||
email:
|
||||
type: string
|
||||
description: Email address associated with the user account
|
||||
example: dragonfruit@example.org
|
||||
'email:confirmed':
|
||||
type: number
|
||||
description: Whether the user has confirmed their email address or not
|
||||
example: 1
|
||||
joindate:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the user's account was created
|
||||
example: 1585337827953
|
||||
lastonline:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the user was last recorded online on this site
|
||||
example: 1585337827953
|
||||
picture:
|
||||
type: string
|
||||
description: A URL pointing to a picture to be used as the user's avatar
|
||||
example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80'
|
||||
fullname:
|
||||
type: string
|
||||
example: Mr. Dragon Fruit Jr.
|
||||
location:
|
||||
type: string
|
||||
example: 'Toronto, Canada'
|
||||
birthday:
|
||||
type: string
|
||||
description: A birthdate given in an ISO format parseable by the Date object
|
||||
example: 03/27/2020
|
||||
website:
|
||||
type: string
|
||||
example: 'https://example.org'
|
||||
aboutme:
|
||||
type: string
|
||||
example: |
|
||||
This is a paragraph all about how my life got twist-turned upside-down
|
||||
and I'd like to take a minute and sit right here,
|
||||
to tell you all about how I because the administrator of NodeBB
|
||||
signature:
|
||||
type: string
|
||||
example: |
|
||||
This is an example signature
|
||||
It can span multiple lines.
|
||||
uploadedpicture:
|
||||
type: string
|
||||
example: /assets/profile/1-profileimg.png
|
||||
description: 'In almost all cases, defer to "picture" instead. Use this if you need to specifically reference the picture uploaded to the forum.'
|
||||
profileviews:
|
||||
type: number
|
||||
description: The number of times this user's profile has been viewed
|
||||
example: 1000
|
||||
reputation:
|
||||
type: number
|
||||
description: The user's reputation score on the forum. Out-of-the-box, users gain/lose reputation points based on upvotes/downvotes, though plugins can alter the logic and criterion for awarding reputation points
|
||||
example: 100
|
||||
postcount:
|
||||
type: number
|
||||
example: 1000
|
||||
topiccount:
|
||||
type: number
|
||||
example: 50
|
||||
lastposttime:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the user posted last
|
||||
example: 1585337827953
|
||||
banned:
|
||||
type: number
|
||||
description: A Boolean representing whether a user is banned or not
|
||||
example: 0
|
||||
'banned:expire':
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment the ban will be lifted
|
||||
example: 1585337827953
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- online
|
||||
- offline
|
||||
- dnd
|
||||
- away
|
||||
example: online
|
||||
flags:
|
||||
type: number
|
||||
example: 0
|
||||
followercount:
|
||||
type: number
|
||||
example: 2
|
||||
followingcount:
|
||||
type: number
|
||||
example: 5
|
||||
'cover:url':
|
||||
type: string
|
||||
example: /assets/profile/1-cover.png
|
||||
'cover:position':
|
||||
type: string
|
||||
example: 50.0301% 19.2464%
|
||||
groupTitle:
|
||||
type: string
|
||||
example: '["administrators","Staff"]'
|
||||
groupTitleArray:
|
||||
type: array
|
||||
example:
|
||||
- administrators
|
||||
- Staff
|
||||
'icon:text':
|
||||
type: string
|
||||
description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar
|
||||
example: D
|
||||
'icon:bgColor':
|
||||
type: string
|
||||
description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon
|
||||
example: '#9c27b0'
|
||||
joindateISO:
|
||||
type: string
|
||||
example: '2020-03-27T20:30:36.590Z'
|
||||
lastonlineISO:
|
||||
type: string
|
||||
example: '2020-03-27T20:30:36.590Z'
|
||||
banned_until:
|
||||
type: number
|
||||
description: A UNIX timestamp representing the moment a ban will be lifted
|
||||
example: 0
|
||||
banned_until_readable:
|
||||
type: string
|
||||
description: An ISO 8601 formatted date string representing the moment a ban will be lifted, or the words "Not Banned"
|
||||
example: Not Banned
|
||||
aboutmeParsed:
|
||||
type: string
|
||||
age:
|
||||
type: number
|
||||
emailClass:
|
||||
type: string
|
||||
ips:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
moderationNote:
|
||||
type: string
|
||||
isBlocked:
|
||||
type: boolean
|
||||
blocksCount:
|
||||
type: number
|
||||
yourid:
|
||||
type: number
|
||||
theirid:
|
||||
type: number
|
||||
isTargetAdmin:
|
||||
type: boolean
|
||||
isAdmin:
|
||||
type: boolean
|
||||
isGlobalModerator:
|
||||
type: boolean
|
||||
isModerator:
|
||||
type: boolean
|
||||
isAdminOrGlobalModerator:
|
||||
type: boolean
|
||||
isAdminOrGlobalModeratorOrModerator:
|
||||
type: boolean
|
||||
isSelfOrAdminOrGlobalModerator:
|
||||
type: boolean
|
||||
canEdit:
|
||||
type: boolean
|
||||
canBan:
|
||||
type: boolean
|
||||
canChangePassword:
|
||||
type: boolean
|
||||
isSelf:
|
||||
type: boolean
|
||||
isFollowing:
|
||||
type: boolean
|
||||
hasPrivateChat:
|
||||
type: number
|
||||
showHidden:
|
||||
type: boolean
|
||||
groups:
|
||||
type: array
|
||||
items: {}
|
||||
disableSignatures:
|
||||
type: boolean
|
||||
reputation:disabled:
|
||||
type: boolean
|
||||
downvote:disabled:
|
||||
type: boolean
|
||||
profile_links:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
route:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
visibility:
|
||||
type: object
|
||||
properties:
|
||||
self:
|
||||
type: boolean
|
||||
other:
|
||||
type: boolean
|
||||
moderator:
|
||||
type: boolean
|
||||
globalMod:
|
||||
type: boolean
|
||||
admin:
|
||||
type: boolean
|
||||
canViewInfo:
|
||||
type: boolean
|
||||
public:
|
||||
type: boolean
|
||||
icon:
|
||||
type: string
|
||||
sso:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
associated:
|
||||
type: boolean
|
||||
url:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
icon:
|
||||
type: string
|
||||
deauthUrl:
|
||||
type: string
|
||||
websiteLink:
|
||||
type: string
|
||||
websiteName:
|
||||
type: string
|
||||
username:disableEdit:
|
||||
type: number
|
||||
email:disableEdit:
|
||||
type: number
|
||||
Loading…
Reference in New Issue