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>
Showing
- CHANGELOG.md 3 additions, 0 deletionsCHANGELOG.md
- packages/backend/src/models/schema/emoji.ts 1 addition, 0 deletionspackages/backend/src/models/schema/emoji.ts
- packages/backend/src/models/schema/user.ts 1 addition, 0 deletionspackages/backend/src/models/schema/user.ts
- packages/backend/src/server/api/endpoints/admin/drive/files.ts 6 additions, 1 deletion...ges/backend/src/server/api/endpoints/admin/drive/files.ts
- packages/backend/src/server/api/endpoints/admin/drive/show-file.ts 15 additions, 5 deletions...backend/src/server/api/endpoints/admin/drive/show-file.ts
- packages/backend/src/server/api/endpoints/admin/emoji/list-remote.ts 7 additions, 1 deletion...ckend/src/server/api/endpoints/admin/emoji/list-remote.ts
- packages/backend/src/server/api/endpoints/admin/emoji/list.ts 3 additions, 2 deletions...ages/backend/src/server/api/endpoints/admin/emoji/list.ts
- packages/backend/src/server/api/endpoints/admin/emoji/set-category-bulk.ts 5 additions, 1 deletion...src/server/api/endpoints/admin/emoji/set-category-bulk.ts
- packages/backend/src/server/api/endpoints/admin/emoji/update.ts 5 additions, 1 deletion...es/backend/src/server/api/endpoints/admin/emoji/update.ts
- packages/backend/src/server/api/endpoints/admin/show-users.ts 7 additions, 2 deletions...ages/backend/src/server/api/endpoints/admin/show-users.ts
- packages/backend/src/server/api/endpoints/channels/pin-note.ts 0 additions, 0 deletions...ges/backend/src/server/api/endpoints/channels/pin-note.ts
- packages/backend/src/server/api/endpoints/clips/create.ts 1 addition, 1 deletionpackages/backend/src/server/api/endpoints/clips/create.ts
- packages/backend/src/server/api/endpoints/drive/files/show.ts 14 additions, 13 deletions...ages/backend/src/server/api/endpoints/drive/files/show.ts
- packages/backend/src/server/api/endpoints/federation/instances.ts 1 addition, 1 deletion.../backend/src/server/api/endpoints/federation/instances.ts
- packages/backend/src/server/api/endpoints/messaging/messages.ts 14 additions, 5 deletions...es/backend/src/server/api/endpoints/messaging/messages.ts
- packages/backend/src/server/api/endpoints/messaging/messages/create.ts 14 additions, 3 deletions...end/src/server/api/endpoints/messaging/messages/create.ts
- packages/backend/src/server/api/endpoints/meta.ts 1 addition, 0 deletionspackages/backend/src/server/api/endpoints/meta.ts
- packages/backend/src/server/api/endpoints/mute/create.ts 5 additions, 1 deletionpackages/backend/src/server/api/endpoints/mute/create.ts
- packages/backend/src/server/api/endpoints/notes.ts 1 addition, 1 deletionpackages/backend/src/server/api/endpoints/notes.ts
- packages/backend/src/server/api/endpoints/notes/create.ts 48 additions, 24 deletionspackages/backend/src/server/api/endpoints/notes/create.ts
Loading
Please register or sign in to comment