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>
188 lines
3.6 KiB
TypeScript
188 lines
3.6 KiB
TypeScript
import define from '../../../define.js';
|
|
import { ApiError } from '../../../error.js';
|
|
import { DriveFiles } from '@/models/index.js';
|
|
|
|
export const meta = {
|
|
tags: ['admin'],
|
|
|
|
requireCredential: true,
|
|
requireModerator: true,
|
|
|
|
errors: {
|
|
noSuchFile: {
|
|
message: 'No such file.',
|
|
code: 'NO_SUCH_FILE',
|
|
id: 'caf3ca38-c6e5-472e-a30c-b05377dcc240',
|
|
},
|
|
},
|
|
|
|
res: {
|
|
type: 'object',
|
|
optional: false, nullable: false,
|
|
properties: {
|
|
id: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
format: 'id',
|
|
example: 'xxxxxxxxxx',
|
|
},
|
|
createdAt: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
format: 'date-time',
|
|
},
|
|
userId: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
format: 'id',
|
|
example: 'xxxxxxxxxx',
|
|
},
|
|
userHost: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
description: 'The local host is represented with `null`.',
|
|
},
|
|
md5: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
format: 'md5',
|
|
example: '15eca7fba0480996e2245f5185bf39f2',
|
|
},
|
|
name: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
example: 'lenna.jpg',
|
|
},
|
|
type: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
example: 'image/jpeg',
|
|
},
|
|
size: {
|
|
type: 'number',
|
|
optional: false, nullable: false,
|
|
example: 51469,
|
|
},
|
|
comment: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
},
|
|
blurhash: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
},
|
|
properties: {
|
|
type: 'object',
|
|
optional: false, nullable: false,
|
|
properties: {
|
|
width: {
|
|
type: 'number',
|
|
optional: false, nullable: false,
|
|
example: 1280,
|
|
},
|
|
height: {
|
|
type: 'number',
|
|
optional: false, nullable: false,
|
|
example: 720,
|
|
},
|
|
avgColor: {
|
|
type: 'string',
|
|
optional: true, nullable: false,
|
|
example: 'rgb(40,65,87)',
|
|
},
|
|
},
|
|
},
|
|
storedInternal: {
|
|
type: 'boolean',
|
|
optional: false, nullable: true,
|
|
example: true,
|
|
},
|
|
url: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
format: 'url',
|
|
},
|
|
thumbnailUrl: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
format: 'url',
|
|
},
|
|
webpublicUrl: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
format: 'url',
|
|
},
|
|
accessKey: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
},
|
|
thumbnailAccessKey: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
},
|
|
webpublicAccessKey: {
|
|
type: 'string',
|
|
optional: false, nullable: false,
|
|
},
|
|
uri: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
},
|
|
src: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
},
|
|
folderId: {
|
|
type: 'string',
|
|
optional: false, nullable: true,
|
|
format: 'id',
|
|
example: 'xxxxxxxxxx',
|
|
},
|
|
isSensitive: {
|
|
type: 'boolean',
|
|
optional: false, nullable: false,
|
|
},
|
|
isLink: {
|
|
type: 'boolean',
|
|
optional: false, nullable: false,
|
|
},
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
export const paramDef = {
|
|
type: 'object',
|
|
anyOf: [
|
|
{
|
|
properties: {
|
|
fileId: { type: 'string', format: 'misskey:id' },
|
|
},
|
|
required: ['fileId'],
|
|
},
|
|
{
|
|
properties: {
|
|
url: { type: 'string' },
|
|
},
|
|
required: ['url'],
|
|
},
|
|
],
|
|
} as const;
|
|
|
|
// eslint-disable-next-line import/no-default-export
|
|
export default define(meta, paramDef, async (ps, me) => {
|
|
const file = ps.fileId ? await DriveFiles.findOneBy({ id: ps.fileId }) : await DriveFiles.findOne({
|
|
where: [{
|
|
url: ps.url,
|
|
}, {
|
|
thumbnailUrl: ps.url,
|
|
}, {
|
|
webpublicUrl: ps.url,
|
|
}],
|
|
});
|
|
|
|
if (file == null) {
|
|
throw new ApiError(meta.errors.noSuchFile);
|
|
}
|
|
|
|
return file;
|
|
});
|