@brainfish-ai/devdoc 0.1.25 → 0.1.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cli/commands/create.js +28 -9
- package/dist/cli/commands/dev.js +41 -77
- package/package.json +6 -6
- package/renderer/components/docs-viewer/index.tsx +41 -2
- package/renderer/components/docs-viewer/sidebar/collection-tree.tsx +20 -0
- package/templates/basic/README.md +0 -139
- package/templates/basic/assets/favicon.svg +0 -4
- package/templates/basic/assets/logo.svg +0 -9
- package/templates/basic/docs.json +0 -47
- package/templates/basic/guides/configuration.mdx +0 -149
- package/templates/basic/guides/overview.mdx +0 -96
- package/templates/basic/index.mdx +0 -39
- package/templates/basic/package.json +0 -14
- package/templates/basic/quickstart.mdx +0 -92
- package/templates/basic/vercel.json +0 -6
- package/templates/graphql/README.md +0 -139
- package/templates/graphql/api-reference/schema.graphql +0 -305
- package/templates/graphql/assets/favicon.svg +0 -4
- package/templates/graphql/assets/logo.svg +0 -9
- package/templates/graphql/docs.json +0 -54
- package/templates/graphql/guides/configuration.mdx +0 -149
- package/templates/graphql/guides/overview.mdx +0 -96
- package/templates/graphql/index.mdx +0 -39
- package/templates/graphql/package.json +0 -14
- package/templates/graphql/quickstart.mdx +0 -92
- package/templates/graphql/vercel.json +0 -6
- package/templates/openapi/README.md +0 -139
- package/templates/openapi/api-reference/openapi.json +0 -419
- package/templates/openapi/assets/favicon.svg +0 -4
- package/templates/openapi/assets/logo.svg +0 -9
- package/templates/openapi/docs.json +0 -61
- package/templates/openapi/guides/configuration.mdx +0 -149
- package/templates/openapi/guides/overview.mdx +0 -96
- package/templates/openapi/index.mdx +0 -39
- package/templates/openapi/package.json +0 -14
- package/templates/openapi/quickstart.mdx +0 -92
- package/templates/openapi/vercel.json +0 -6
|
@@ -1,419 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"openapi": "3.0.0",
|
|
3
|
-
"info": {
|
|
4
|
-
"title": "My API",
|
|
5
|
-
"description": "A sample REST API for your documentation",
|
|
6
|
-
"version": "1.0.0",
|
|
7
|
-
"contact": {
|
|
8
|
-
"name": "API Support",
|
|
9
|
-
"email": "support@example.com"
|
|
10
|
-
}
|
|
11
|
-
},
|
|
12
|
-
"servers": [
|
|
13
|
-
{
|
|
14
|
-
"url": "https://api.example.com/v1",
|
|
15
|
-
"description": "Production server"
|
|
16
|
-
},
|
|
17
|
-
{
|
|
18
|
-
"url": "https://staging-api.example.com/v1",
|
|
19
|
-
"description": "Staging server"
|
|
20
|
-
}
|
|
21
|
-
],
|
|
22
|
-
"tags": [
|
|
23
|
-
{
|
|
24
|
-
"name": "Users",
|
|
25
|
-
"description": "User management endpoints"
|
|
26
|
-
},
|
|
27
|
-
{
|
|
28
|
-
"name": "Projects",
|
|
29
|
-
"description": "Project management endpoints"
|
|
30
|
-
}
|
|
31
|
-
],
|
|
32
|
-
"paths": {
|
|
33
|
-
"/users": {
|
|
34
|
-
"get": {
|
|
35
|
-
"summary": "List users",
|
|
36
|
-
"description": "Retrieve a list of all users",
|
|
37
|
-
"operationId": "listUsers",
|
|
38
|
-
"tags": ["Users"],
|
|
39
|
-
"parameters": [
|
|
40
|
-
{
|
|
41
|
-
"name": "limit",
|
|
42
|
-
"in": "query",
|
|
43
|
-
"description": "Maximum number of users to return",
|
|
44
|
-
"schema": {
|
|
45
|
-
"type": "integer",
|
|
46
|
-
"default": 20,
|
|
47
|
-
"maximum": 100
|
|
48
|
-
}
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"name": "offset",
|
|
52
|
-
"in": "query",
|
|
53
|
-
"description": "Number of users to skip",
|
|
54
|
-
"schema": {
|
|
55
|
-
"type": "integer",
|
|
56
|
-
"default": 0
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
],
|
|
60
|
-
"responses": {
|
|
61
|
-
"200": {
|
|
62
|
-
"description": "A list of users",
|
|
63
|
-
"content": {
|
|
64
|
-
"application/json": {
|
|
65
|
-
"schema": {
|
|
66
|
-
"type": "object",
|
|
67
|
-
"properties": {
|
|
68
|
-
"data": {
|
|
69
|
-
"type": "array",
|
|
70
|
-
"items": {
|
|
71
|
-
"$ref": "#/components/schemas/User"
|
|
72
|
-
}
|
|
73
|
-
},
|
|
74
|
-
"total": {
|
|
75
|
-
"type": "integer"
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
},
|
|
83
|
-
"security": [
|
|
84
|
-
{
|
|
85
|
-
"bearerAuth": []
|
|
86
|
-
}
|
|
87
|
-
]
|
|
88
|
-
},
|
|
89
|
-
"post": {
|
|
90
|
-
"summary": "Create user",
|
|
91
|
-
"description": "Create a new user account",
|
|
92
|
-
"operationId": "createUser",
|
|
93
|
-
"tags": ["Users"],
|
|
94
|
-
"requestBody": {
|
|
95
|
-
"required": true,
|
|
96
|
-
"content": {
|
|
97
|
-
"application/json": {
|
|
98
|
-
"schema": {
|
|
99
|
-
"$ref": "#/components/schemas/CreateUserRequest"
|
|
100
|
-
}
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
},
|
|
104
|
-
"responses": {
|
|
105
|
-
"201": {
|
|
106
|
-
"description": "User created successfully",
|
|
107
|
-
"content": {
|
|
108
|
-
"application/json": {
|
|
109
|
-
"schema": {
|
|
110
|
-
"$ref": "#/components/schemas/User"
|
|
111
|
-
}
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
},
|
|
115
|
-
"400": {
|
|
116
|
-
"description": "Invalid request",
|
|
117
|
-
"content": {
|
|
118
|
-
"application/json": {
|
|
119
|
-
"schema": {
|
|
120
|
-
"$ref": "#/components/schemas/Error"
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
},
|
|
126
|
-
"security": [
|
|
127
|
-
{
|
|
128
|
-
"bearerAuth": []
|
|
129
|
-
}
|
|
130
|
-
]
|
|
131
|
-
}
|
|
132
|
-
},
|
|
133
|
-
"/users/{id}": {
|
|
134
|
-
"get": {
|
|
135
|
-
"summary": "Get user",
|
|
136
|
-
"description": "Retrieve a specific user by ID",
|
|
137
|
-
"operationId": "getUser",
|
|
138
|
-
"tags": ["Users"],
|
|
139
|
-
"parameters": [
|
|
140
|
-
{
|
|
141
|
-
"name": "id",
|
|
142
|
-
"in": "path",
|
|
143
|
-
"required": true,
|
|
144
|
-
"description": "User ID",
|
|
145
|
-
"schema": {
|
|
146
|
-
"type": "string"
|
|
147
|
-
}
|
|
148
|
-
}
|
|
149
|
-
],
|
|
150
|
-
"responses": {
|
|
151
|
-
"200": {
|
|
152
|
-
"description": "User details",
|
|
153
|
-
"content": {
|
|
154
|
-
"application/json": {
|
|
155
|
-
"schema": {
|
|
156
|
-
"$ref": "#/components/schemas/User"
|
|
157
|
-
}
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
},
|
|
161
|
-
"404": {
|
|
162
|
-
"description": "User not found",
|
|
163
|
-
"content": {
|
|
164
|
-
"application/json": {
|
|
165
|
-
"schema": {
|
|
166
|
-
"$ref": "#/components/schemas/Error"
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
}
|
|
170
|
-
}
|
|
171
|
-
},
|
|
172
|
-
"security": [
|
|
173
|
-
{
|
|
174
|
-
"bearerAuth": []
|
|
175
|
-
}
|
|
176
|
-
]
|
|
177
|
-
},
|
|
178
|
-
"put": {
|
|
179
|
-
"summary": "Update user",
|
|
180
|
-
"description": "Update an existing user",
|
|
181
|
-
"operationId": "updateUser",
|
|
182
|
-
"tags": ["Users"],
|
|
183
|
-
"parameters": [
|
|
184
|
-
{
|
|
185
|
-
"name": "id",
|
|
186
|
-
"in": "path",
|
|
187
|
-
"required": true,
|
|
188
|
-
"description": "User ID",
|
|
189
|
-
"schema": {
|
|
190
|
-
"type": "string"
|
|
191
|
-
}
|
|
192
|
-
}
|
|
193
|
-
],
|
|
194
|
-
"requestBody": {
|
|
195
|
-
"required": true,
|
|
196
|
-
"content": {
|
|
197
|
-
"application/json": {
|
|
198
|
-
"schema": {
|
|
199
|
-
"$ref": "#/components/schemas/UpdateUserRequest"
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
}
|
|
203
|
-
},
|
|
204
|
-
"responses": {
|
|
205
|
-
"200": {
|
|
206
|
-
"description": "User updated successfully",
|
|
207
|
-
"content": {
|
|
208
|
-
"application/json": {
|
|
209
|
-
"schema": {
|
|
210
|
-
"$ref": "#/components/schemas/User"
|
|
211
|
-
}
|
|
212
|
-
}
|
|
213
|
-
}
|
|
214
|
-
}
|
|
215
|
-
},
|
|
216
|
-
"security": [
|
|
217
|
-
{
|
|
218
|
-
"bearerAuth": []
|
|
219
|
-
}
|
|
220
|
-
]
|
|
221
|
-
},
|
|
222
|
-
"delete": {
|
|
223
|
-
"summary": "Delete user",
|
|
224
|
-
"description": "Delete a user account",
|
|
225
|
-
"operationId": "deleteUser",
|
|
226
|
-
"tags": ["Users"],
|
|
227
|
-
"parameters": [
|
|
228
|
-
{
|
|
229
|
-
"name": "id",
|
|
230
|
-
"in": "path",
|
|
231
|
-
"required": true,
|
|
232
|
-
"description": "User ID",
|
|
233
|
-
"schema": {
|
|
234
|
-
"type": "string"
|
|
235
|
-
}
|
|
236
|
-
}
|
|
237
|
-
],
|
|
238
|
-
"responses": {
|
|
239
|
-
"204": {
|
|
240
|
-
"description": "User deleted successfully"
|
|
241
|
-
}
|
|
242
|
-
},
|
|
243
|
-
"security": [
|
|
244
|
-
{
|
|
245
|
-
"bearerAuth": []
|
|
246
|
-
}
|
|
247
|
-
]
|
|
248
|
-
}
|
|
249
|
-
},
|
|
250
|
-
"/projects": {
|
|
251
|
-
"get": {
|
|
252
|
-
"summary": "List projects",
|
|
253
|
-
"description": "Retrieve a list of all projects",
|
|
254
|
-
"operationId": "listProjects",
|
|
255
|
-
"tags": ["Projects"],
|
|
256
|
-
"responses": {
|
|
257
|
-
"200": {
|
|
258
|
-
"description": "A list of projects",
|
|
259
|
-
"content": {
|
|
260
|
-
"application/json": {
|
|
261
|
-
"schema": {
|
|
262
|
-
"type": "array",
|
|
263
|
-
"items": {
|
|
264
|
-
"$ref": "#/components/schemas/Project"
|
|
265
|
-
}
|
|
266
|
-
}
|
|
267
|
-
}
|
|
268
|
-
}
|
|
269
|
-
}
|
|
270
|
-
},
|
|
271
|
-
"security": [
|
|
272
|
-
{
|
|
273
|
-
"bearerAuth": []
|
|
274
|
-
}
|
|
275
|
-
]
|
|
276
|
-
},
|
|
277
|
-
"post": {
|
|
278
|
-
"summary": "Create project",
|
|
279
|
-
"description": "Create a new project",
|
|
280
|
-
"operationId": "createProject",
|
|
281
|
-
"tags": ["Projects"],
|
|
282
|
-
"requestBody": {
|
|
283
|
-
"required": true,
|
|
284
|
-
"content": {
|
|
285
|
-
"application/json": {
|
|
286
|
-
"schema": {
|
|
287
|
-
"$ref": "#/components/schemas/CreateProjectRequest"
|
|
288
|
-
}
|
|
289
|
-
}
|
|
290
|
-
}
|
|
291
|
-
},
|
|
292
|
-
"responses": {
|
|
293
|
-
"201": {
|
|
294
|
-
"description": "Project created successfully",
|
|
295
|
-
"content": {
|
|
296
|
-
"application/json": {
|
|
297
|
-
"schema": {
|
|
298
|
-
"$ref": "#/components/schemas/Project"
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
}
|
|
303
|
-
},
|
|
304
|
-
"security": [
|
|
305
|
-
{
|
|
306
|
-
"bearerAuth": []
|
|
307
|
-
}
|
|
308
|
-
]
|
|
309
|
-
}
|
|
310
|
-
}
|
|
311
|
-
},
|
|
312
|
-
"components": {
|
|
313
|
-
"schemas": {
|
|
314
|
-
"User": {
|
|
315
|
-
"type": "object",
|
|
316
|
-
"properties": {
|
|
317
|
-
"id": {
|
|
318
|
-
"type": "string",
|
|
319
|
-
"description": "Unique identifier"
|
|
320
|
-
},
|
|
321
|
-
"email": {
|
|
322
|
-
"type": "string",
|
|
323
|
-
"format": "email",
|
|
324
|
-
"description": "User's email address"
|
|
325
|
-
},
|
|
326
|
-
"name": {
|
|
327
|
-
"type": "string",
|
|
328
|
-
"description": "User's full name"
|
|
329
|
-
},
|
|
330
|
-
"createdAt": {
|
|
331
|
-
"type": "string",
|
|
332
|
-
"format": "date-time",
|
|
333
|
-
"description": "When the user was created"
|
|
334
|
-
}
|
|
335
|
-
}
|
|
336
|
-
},
|
|
337
|
-
"CreateUserRequest": {
|
|
338
|
-
"type": "object",
|
|
339
|
-
"required": ["email", "name"],
|
|
340
|
-
"properties": {
|
|
341
|
-
"email": {
|
|
342
|
-
"type": "string",
|
|
343
|
-
"format": "email"
|
|
344
|
-
},
|
|
345
|
-
"name": {
|
|
346
|
-
"type": "string"
|
|
347
|
-
},
|
|
348
|
-
"password": {
|
|
349
|
-
"type": "string",
|
|
350
|
-
"minLength": 8
|
|
351
|
-
}
|
|
352
|
-
}
|
|
353
|
-
},
|
|
354
|
-
"UpdateUserRequest": {
|
|
355
|
-
"type": "object",
|
|
356
|
-
"properties": {
|
|
357
|
-
"email": {
|
|
358
|
-
"type": "string",
|
|
359
|
-
"format": "email"
|
|
360
|
-
},
|
|
361
|
-
"name": {
|
|
362
|
-
"type": "string"
|
|
363
|
-
}
|
|
364
|
-
}
|
|
365
|
-
},
|
|
366
|
-
"Project": {
|
|
367
|
-
"type": "object",
|
|
368
|
-
"properties": {
|
|
369
|
-
"id": {
|
|
370
|
-
"type": "string"
|
|
371
|
-
},
|
|
372
|
-
"name": {
|
|
373
|
-
"type": "string"
|
|
374
|
-
},
|
|
375
|
-
"description": {
|
|
376
|
-
"type": "string"
|
|
377
|
-
},
|
|
378
|
-
"ownerId": {
|
|
379
|
-
"type": "string"
|
|
380
|
-
},
|
|
381
|
-
"createdAt": {
|
|
382
|
-
"type": "string",
|
|
383
|
-
"format": "date-time"
|
|
384
|
-
}
|
|
385
|
-
}
|
|
386
|
-
},
|
|
387
|
-
"CreateProjectRequest": {
|
|
388
|
-
"type": "object",
|
|
389
|
-
"required": ["name"],
|
|
390
|
-
"properties": {
|
|
391
|
-
"name": {
|
|
392
|
-
"type": "string"
|
|
393
|
-
},
|
|
394
|
-
"description": {
|
|
395
|
-
"type": "string"
|
|
396
|
-
}
|
|
397
|
-
}
|
|
398
|
-
},
|
|
399
|
-
"Error": {
|
|
400
|
-
"type": "object",
|
|
401
|
-
"properties": {
|
|
402
|
-
"code": {
|
|
403
|
-
"type": "string"
|
|
404
|
-
},
|
|
405
|
-
"message": {
|
|
406
|
-
"type": "string"
|
|
407
|
-
}
|
|
408
|
-
}
|
|
409
|
-
}
|
|
410
|
-
},
|
|
411
|
-
"securitySchemes": {
|
|
412
|
-
"bearerAuth": {
|
|
413
|
-
"type": "http",
|
|
414
|
-
"scheme": "bearer",
|
|
415
|
-
"bearerFormat": "JWT"
|
|
416
|
-
}
|
|
417
|
-
}
|
|
418
|
-
}
|
|
419
|
-
}
|