Sharkey/packages/backend/src/server/api
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
..
common refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
endpoints enhance(doc): required input fields (#8456) 2022-04-02 15:04:36 +09:00
openapi refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
private refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
service refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
stream refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
2fa.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
api-handler.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
authenticate.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
call.ts perf(server): refactor and performance improvements 2022-03-25 16:27:41 +09:00
define.ts perf(server): refactor and performance improvements 2022-03-25 16:27:41 +09:00
endpoints.ts fix(server): admin/meta is not working 2022-04-01 19:17:19 +09:00
error.ts fix lint 2021-12-09 23:58:30 +09:00
index.ts refactor: migrate to typeorm 3.0 (#8443) 2022-03-26 15:34:00 +09:00
limiter.ts perf(server): refactor and performance improvements 2022-03-25 16:27:41 +09:00
logger.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00
streaming.ts refactor: Use ESM (#8358) 2022-02-27 11:07:39 +09:00