mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-27 11:23:08 +02:00
Improve doc
This commit is contained in:
parent
010d3f8281
commit
33ad60b1f3
4 changed files with 68 additions and 3 deletions
|
@ -44,7 +44,14 @@ export const meta = {
|
|||
'-attachedRemoteUsers',
|
||||
]),
|
||||
},
|
||||
}
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'Hashtag'
|
||||
}
|
||||
},
|
||||
};
|
||||
|
||||
const sort: any = {
|
||||
|
|
|
@ -35,7 +35,14 @@ export const meta = {
|
|||
'ja-JP': 'オフセット'
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
};
|
||||
|
||||
export default define(meta, async (ps) => {
|
||||
|
|
|
@ -44,7 +44,14 @@ export const meta = {
|
|||
]),
|
||||
default: 'local'
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
res: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'User'
|
||||
}
|
||||
},
|
||||
};
|
||||
|
||||
const sort: any = {
|
||||
|
|
|
@ -361,4 +361,48 @@ export const schemas = {
|
|||
},
|
||||
required: ['id', 'createdAt', 'blockee']
|
||||
},
|
||||
|
||||
Hashtag: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
tag: {
|
||||
type: 'string',
|
||||
description: 'The hashtag name. No # prefixed.',
|
||||
example: 'misskey',
|
||||
},
|
||||
mentionedUsersCount: {
|
||||
type: 'number',
|
||||
description: 'Number of all users using this hashtag.'
|
||||
},
|
||||
mentionedLocalUsersCount: {
|
||||
type: 'number',
|
||||
description: 'Number of local users using this hashtag.'
|
||||
},
|
||||
mentionedRemoteUsersCount: {
|
||||
type: 'number',
|
||||
description: 'Number of remote users using this hashtag.'
|
||||
},
|
||||
attachedUsersCount: {
|
||||
type: 'number',
|
||||
description: 'Number of all users who attached this hashtag to profile.'
|
||||
},
|
||||
attachedLocalUsersCount: {
|
||||
type: 'number',
|
||||
description: 'Number of local users who attached this hashtag to profile.'
|
||||
},
|
||||
attachedRemoteUsersCount: {
|
||||
type: 'number',
|
||||
description: 'Number of remote users who attached this hashtag to profile.'
|
||||
},
|
||||
},
|
||||
required: [
|
||||
'tag',
|
||||
'mentionedUsersCount',
|
||||
'mentionedLocalUsersCount',
|
||||
'mentionedRemoteUsersCount',
|
||||
'attachedUsersCount',
|
||||
'attachedLocalUsersCount',
|
||||
'attachedRemoteUsersCount',
|
||||
]
|
||||
},
|
||||
};
|
||||
|
|
Loading…
Reference in a new issue