summaryrefslogtreecommitdiff
path: root/packages/backend/src/server/api/endpoints/federation/instances.ts
diff options
context:
space:
mode:
authorJohann150 <johann.galle@protonmail.com>2022-04-02 08:04:36 +0200
committerGitHub <noreply@github.com>2022-04-02 15:04:36 +0900
commit484e023c0c8ad348438edfeee73623223e6ad088 (patch)
treed13917e58b3d7f41c52d6bceae0653e0a5da4ea1 /packages/backend/src/server/api/endpoints/federation/instances.ts
parentUpdate CHANGELOG.md (diff)
downloadmisskey-484e023c0c8ad348438edfeee73623223e6ad088.tar.gz
misskey-484e023c0c8ad348438edfeee73623223e6ad088.tar.bz2
misskey-484e023c0c8ad348438edfeee73623223e6ad088.zip
enhance(doc): required input fields (#8456)
* remove empty file If the endpoint is to be implemented later, the file can be added back, but for now it is confusing to have an empty file. * enhance(doc): document defaults Default for `isPublic` is based on the database schema default value. Defaults for `local` and `withFiles` are based on the behaviour of the endpoint. * enhance(doc): explain nullable emoji category * fix: make nullable if default is null * enhance(doc): explain mute attribute expiresAt * fix: define required fields - `notes/create`: the default for `text` has been removed because ajv can not handle `default` inside of `anyOf`, see https://ajv.js.org/guide/modifying-data.html#assigning-defaults and the default value cannot be `null` if text is `nullable: false` in the `anyOf` first alternative. - `notes/create`: The `mediaIds` property has been marked as deprecated because it has the same behaviour as using `fileIds`, but the implementation tries to handlè `fileIds` first. - The result schema for `admin/emoji/list` has been altered because the `host` property will always be `null` as it is filtered this way in the database query. See packages/backend/src/server/api/endpoints/admin/emoji/list.ts line 67. * enhance(doc): explain nullable hostname * update changelog Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
Diffstat (limited to 'packages/backend/src/server/api/endpoints/federation/instances.ts')
-rw-r--r--packages/backend/src/server/api/endpoints/federation/instances.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/packages/backend/src/server/api/endpoints/federation/instances.ts b/packages/backend/src/server/api/endpoints/federation/instances.ts
index e272971763..07e5c07c6a 100644
--- a/packages/backend/src/server/api/endpoints/federation/instances.ts
+++ b/packages/backend/src/server/api/endpoints/federation/instances.ts
@@ -22,7 +22,7 @@ export const meta = {
export const paramDef = {
type: 'object',
properties: {
- host: { type: 'string', nullable: true },
+ host: { type: 'string', nullable: true, description: 'Omit or use `null` to not filter by host.' },
blocked: { type: 'boolean', nullable: true },
notResponding: { type: 'boolean', nullable: true },
suspended: { type: 'boolean', nullable: true },