mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-27 17:13:09 +02:00
Improve doc
This commit is contained in:
parent
fcc6a65e08
commit
02e4929a97
1 changed files with 11 additions and 4 deletions
|
@ -33,7 +33,8 @@ export const schemas = {
|
||||||
id: {
|
id: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
format: 'id',
|
format: 'id',
|
||||||
description: 'The unique identifier for this User.'
|
description: 'The unique identifier for this User.',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
username: {
|
username: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
|
@ -102,7 +103,8 @@ export const schemas = {
|
||||||
id: {
|
id: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
format: 'id',
|
format: 'id',
|
||||||
description: 'The unique identifier for this Note.'
|
description: 'The unique identifier for this Note.',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
createdAt: {
|
createdAt: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
|
@ -125,10 +127,12 @@ export const schemas = {
|
||||||
replyId: {
|
replyId: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
format: 'id',
|
format: 'id',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
renoteId: {
|
renoteId: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
format: 'id',
|
format: 'id',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
reply: {
|
reply: {
|
||||||
$ref: '#/components/schemas/Note'
|
$ref: '#/components/schemas/Note'
|
||||||
|
@ -152,7 +156,8 @@ export const schemas = {
|
||||||
id: {
|
id: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
format: 'id',
|
format: 'id',
|
||||||
description: 'The unique identifier for this notification.'
|
description: 'The unique identifier for this notification.',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
createdAt: {
|
createdAt: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
|
@ -174,7 +179,8 @@ export const schemas = {
|
||||||
id: {
|
id: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
format: 'id',
|
format: 'id',
|
||||||
description: 'The unique identifier for this Drive file.'
|
description: 'The unique identifier for this Drive file.',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
createdAt: {
|
createdAt: {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
|
@ -207,6 +213,7 @@ export const schemas = {
|
||||||
format: 'id',
|
format: 'id',
|
||||||
nullable: true,
|
nullable: true,
|
||||||
description: 'The parent folder ID of this Drive file.',
|
description: 'The parent folder ID of this Drive file.',
|
||||||
|
example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
|
||||||
},
|
},
|
||||||
isSensitive: {
|
isSensitive: {
|
||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
|
|
Loading…
Reference in a new issue