Sharkey/packages/backend/src/server/api/endpoints
Johann150 484e023c0c
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>
2022-04-02 15:04:36 +09:00
..
admin enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
antennas refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
ap refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
app refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
auth refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
blocking refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
channels enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
charts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
clips enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
drive enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
email-address refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
federation enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
following refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
gallery refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
hashtags refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
i perf(server): reduce db query when get notifications 2022-03-26 18:22:55 +09:00
messaging enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
miauth refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
mute enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
my refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
notes enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
notifications refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
pages enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
promo refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
sw refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
username refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
users enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
announcements.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
drive.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
endpoint.ts fix API console (#8416) 2022-03-19 18:25:06 +09:00
endpoints.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
export-custom-emojis.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
get-online-users-count.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
i.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
meta.ts enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
notes.ts enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
page-push.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
ping.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
pinned-users.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
request-reset-password.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
reset-db.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
reset-password.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
server-info.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
stats.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
test.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
users.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00