484e023c0c
* 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>
92 lines
2.1 KiB
TypeScript
92 lines
2.1 KiB
TypeScript
import define from '../../../define.js';
|
|
import { Emojis } from '@/models/index.js';
|
|
import { toPuny } from '@/misc/convert-host.js';
|
|
import { makePaginationQuery } from '../../../common/make-pagination-query.js';
|
|
|
|
export const meta = {
|
|
tags: ['admin'],
|
|
|
|
requireCredential: true,
|
|
requireModerator: true,
|
|
|
|
res: {
|
|
type: 'array',
|
|
optional: false, nullable: false,
|
|
items: {
|
|
type: 'object',
|
|
optional: false, nullable: false,
|
|
properties: {
|
|
id: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
format: 'id',
|
|
},
|
|
aliases: {
|
|
type: 'array',
|
|
optional: false, nullable: false,
|
|
items: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
},
|
|
},
|
|
name: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
},
|
|
category: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
},
|
|
host: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
description: 'The local host is represented with `null`.',
|
|
},
|
|
url: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
export const paramDef = {
|
|
type: 'object',
|
|
properties: {
|
|
query: { type: 'string', nullable: true, default: null },
|
|
host: {
|
|
type: 'string',
|
|
nullable: true,
|
|
default: null,
|
|
description: 'Use `null` to represent the local host.',
|
|
},
|
|
limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
|
|
sinceId: { type: 'string', format: 'misskey:id' },
|
|
untilId: { type: 'string', format: 'misskey:id' },
|
|
},
|
|
required: [],
|
|
} as const;
|
|
|
|
// eslint-disable-next-line import/no-default-export
|
|
export default define(meta, paramDef, async (ps) => {
|
|
const q = makePaginationQuery(Emojis.createQueryBuilder('emoji'), ps.sinceId, ps.untilId);
|
|
|
|
if (ps.host == null) {
|
|
q.andWhere(`emoji.host IS NOT NULL`);
|
|
} else {
|
|
q.andWhere(`emoji.host = :host`, { host: toPuny(ps.host) });
|
|
}
|
|
|
|
if (ps.query) {
|
|
q.andWhere('emoji.name like :query', { query: '%' + ps.query + '%' });
|
|
}
|
|
|
|
const emojis = await q
|
|
.orderBy('emoji.id', 'DESC')
|
|
.take(ps.limit)
|
|
.getMany();
|
|
|
|
return Emojis.packMany(emojis);
|
|
});
|