-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
openapi.yaml
270 lines (270 loc) · 7.52 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
openapi: 3.0.0
info:
description: Standard, out-of-the-box read & write API for NodeBB v2.0+
version: "1.0.0"
title: Read/Write API
contact:
email: support@nodebb.org
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
tags:
# - name: admins
# description: Secured Admin-only calls
# - name: developers
# description: Operations available to regular developers
- name: users
description: Account related calls (create, modify, delete, etc.)
paths:
# /inventory:
# get:
# tags:
# - developers
# summary: searches inventory
# operationId: searchInventory
# description: |
# By passing in the appropriate options, you can search for
# available inventory in the system
# parameters:
# - in: query
# name: searchString
# description: pass an optional search string for looking up inventory
# required: false
# schema:
# type: string
# - in: query
# name: skip
# description: number of records to skip for pagination
# schema:
# type: integer
# format: int32
# minimum: 0
# - in: query
# name: limit
# description: maximum number of records to return
# schema:
# type: integer
# format: int32
# minimum: 0
# maximum: 50
# responses:
# '200':
# description: search results matching criteria
# content:
# application/json:
# schema:
# type: array
# items:
# $ref: '#/components/schemas/InventoryItem'
# '400':
# description: bad input parameter
# post:
# tags:
# - admins
# summary: adds an inventory item
# operationId: addInventory
# description: Adds an item to the system
# responses:
# '201':
# description: item created
# '400':
# description: 'invalid input, object invalid'
# '409':
# description: an existing item already exists
# requestBody:
# content:
# application/json:
# schema:
# $ref: '#/components/schemas/InventoryItem'
# description: Inventory item to add
/:
post:
tags:
- users
summary: creates a user account
operationId: createUser
description: This operation creates a new user account
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: If the username is taken, a number will be appended
password:
type: string
email:
type: string
required:
- username
example:
username: Dragon Fruit
password: s3cre7password
email: dragonfruit@example.org
responses:
'200':
description: user successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/User'
components:
schemas:
# InventoryItem:
# type: object
# required:
# - id
# - name
# - manufacturer
# - releaseDate
# properties:
# id:
# type: string
# format: uuid
# example: d290f1ee-6c54-4b01-90e6-d701748f0851
# name:
# type: string
# example: Widget Adapter
# releaseDate:
# type: string
# format: date-time
# example: '2016-08-29T09:12:33.001Z'
# manufacturer:
# $ref: '#/components/schemas/Manufacturer'
# Manufacturer:
# required:
# - name
# properties:
# name:
# type: string
# example: ACME Corporation
# homePage:
# type: string
# format: url
# example: 'https://www.acme-corp.com'
# phone:
# type: string
# example: 408-867-5309
# type: object
User:
properties:
uid:
type: number
example: 1
username:
type: string
example: Dragon Fruit
userslug:
type: string
example: dragon-fruit
email:
type: string
example: dragonfruit@example.org
email:confirmed:
type: number
example: 1
joindate:
type: number
example: 1585337827953
lastonline:
type: number
example: 1585337827953
picture:
type: string
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
example: 1000
reputation:
type: number
example: 100
postcount:
type: number
example: 1000
topiccount:
type: number
example: 50
lastposttime:
type: number
example: 1585337827953
banned:
type: number
example: 0
banned:expire:
type: number
example: 1585337827953
status:
type: string
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
example: D
icon:bgColor:
type: string
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
example: 0
banned_until_readable:
type: string
example: Not Banned