Improve doc

This commit is contained in:
syuilo
2019-02-25 03:21:54 +09:00
parent b67f3438e9
commit 31802c9749
10 changed files with 85 additions and 16 deletions

View File

@@ -24,6 +24,54 @@ export const meta = {
default: true
}
},
res: {
type: 'object',
properties: {
version: {
type: 'string',
description: 'The version of Misskey of this instance.',
example: pkg.version
},
name: {
type: 'string',
description: 'The name of this instance.',
},
description: {
type: 'string',
description: 'The description of this instance.',
},
announcements: {
type: 'array',
items: {
type: 'object',
properties: {
title: {
type: 'string',
description: 'The title of the announcement.',
},
text: {
type: 'string',
description: 'The text of the announcement. (can be HTML)',
},
}
},
description: 'The description of this instance.',
},
disableRegistration: {
type: 'boolean',
description: 'Whether disabled open registration.',
},
disableLocalTimeline: {
type: 'boolean',
description: 'Whether disabled LTL and STL.',
},
disableGlobalTimeline: {
type: 'boolean',
description: 'Whether disabled GTL.',
},
}
}
};
export default define(meta, async (ps, me) => {
@@ -55,7 +103,7 @@ export default define(meta, async (ps, me) => {
cores: os.cpus().length
},
broadcasts: instance.broadcasts || [],
announcements: instance.announcements || [],
disableRegistration: instance.disableRegistration,
disableLocalTimeline: instance.disableLocalTimeline,
disableGlobalTimeline: instance.disableGlobalTimeline,