iceshrimp-legacy/packages/backend/src/server/api/endpoints/users/lists/show.ts
2023-07-18 16:00:48 +02:00

51 lines
950 B
TypeScript

import { UserLists } from "@/models/index.js";
import define from "../../../define.js";
import { ApiError } from "../../../error.js";
export const meta = {
tags: ["lists", "account"],
requireCredential: true,
kind: "read:account",
description: "Show the properties of a list.",
res: {
type: "object",
optional: false,
nullable: false,
ref: "UserList",
},
errors: {
noSuchList: {
message: "No such list.",
code: "NO_SUCH_LIST",
id: "7bc05c21-1d7a-41ae-88f1-66820f4dc686",
},
},
} as const;
export const paramDef = {
type: "object",
properties: {
listId: { type: "string", format: "misskey:id" },
},
required: ["listId"],
} as const;
export default define(meta, paramDef, async (ps, me) => {
// Fetch the list
const userList = await UserLists.findOneBy({
id: ps.listId,
userId: me.id,
});
if (!userList) {
throw new ApiError(meta.errors.noSuchList);
}
return await UserLists.pack(userList);
});