tariffs/src/swagger/account/index.ts
2023-05-12 07:03:11 +03:00

92 lines
3.2 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import { getAccountParams, setAccountRoleBody, getAccountsQuerystring } from "./inputs";
import {
getAccountResponse,
createAccountResponse,
setAccountRoleResponse,
getAccountsResponse,
removeAccountResponse,
} from "./responses";
import type { SwaggerSchema } from "@/types/swagger.type";
export const getAccountsSchema: SwaggerSchema = {
summary: "Получение информации об аккаунтах",
description: "Получение список аккаунтов с пагинацией из БД",
tags: ["account"],
querystring: getAccountsQuerystring,
response: getAccountsResponse,
};
export const getAccountByIdSchema: SwaggerSchema = {
summary: "Получение информации об аккаунте",
description: "Получение аккаунта по ID",
tags: ["account"],
params: getAccountParams,
response: getAccountResponse,
};
export const getAccountSchema: SwaggerSchema = {
summary: "Получение информации об аккаунте",
description: "Получение информации об аккаунте через токен доступа",
tags: ["account"],
security: [{ bearer: [] }],
response: getAccountResponse,
};
export const createAccountSchema: SwaggerSchema = {
summary: "Создание аккаунта",
tags: ["account"],
response: createAccountResponse,
security: [{ bearer: [] }],
};
export const setAccountRoleSchema: SwaggerSchema = {
summary: "Присвоение роли пользователя",
tags: ["account"],
body: setAccountRoleBody,
response: setAccountRoleResponse,
security: [{ bearer: [] }],
};
export const removeAccountSchema: SwaggerSchema = {
summary: "Удаление аккаунта",
description: "Помечает аккаунт удалённым, но не удаляет его из БД",
tags: ["account"],
response: removeAccountResponse,
security: [{ bearer: [] }],
};
export const removeAccountByIdSchema: SwaggerSchema = {
summary: "Удаление аккаунта по ID",
description: "Помечает аккаунт удалённым, но не удаляет его из БД",
tags: ["account"],
params: getAccountParams,
response: removeAccountResponse,
security: [{ bearer: [] }],
};
export const deleteAccountSchema: SwaggerSchema = {
summary: "Удаление аккаунта",
description: "Удаляет аккаунт из БД окончательно",
tags: ["account"],
response: removeAccountResponse,
security: [{ bearer: [] }],
};
export const deleteAccountByIdSchema: SwaggerSchema = {
summary: "Удаление аккаунта по ID",
description: "Удаляет аккаунт из БД окончательно",
tags: ["account"],
params: getAccountParams,
response: removeAccountResponse,
security: [{ bearer: [] }],
};
export const restoreAccountSchema: SwaggerSchema = {
summary: "Восстановление аккаунта",
description: "Восстанавливает аккаунт, который не был удалён окончательно",
tags: ["account"],
response: removeAccountResponse,
security: [{ bearer: [] }],
};