HM-98. Описаны все ошибки api для swagger'a
This commit is contained in:
80
src/users/users.responses.ts
Normal file
80
src/users/users.responses.ts
Normal file
@ -0,0 +1,80 @@
|
||||
import {ApiResponseOptions, ApiProperty} from '@nestjs/swagger';
|
||||
import {UserResponse, UpdateUserRequest} from './users.schema';
|
||||
|
||||
class Error {
|
||||
@ApiProperty()
|
||||
statusCode: number;
|
||||
|
||||
@ApiProperty()
|
||||
message: string;
|
||||
|
||||
@ApiProperty()
|
||||
error: string;
|
||||
}
|
||||
|
||||
export const FIND_ALL_SUCCESS: ApiResponseOptions = {
|
||||
status: 200,
|
||||
description: 'Список всех пользователей',
|
||||
type: UserResponse,
|
||||
isArray: true
|
||||
};
|
||||
|
||||
export const FIND_ONE_SUCCESS: ApiResponseOptions = {
|
||||
status: 200,
|
||||
description: 'Пользователь найденный по логину',
|
||||
type: UserResponse,
|
||||
};
|
||||
|
||||
export const FIND_ONE_NOT_FOUND: ApiResponseOptions = {
|
||||
status: 404,
|
||||
description: 'Ошибка при попытке получить несуществующего пользователя',
|
||||
type: Error,
|
||||
};
|
||||
|
||||
export const CREATE_SUCCESS: ApiResponseOptions = {
|
||||
status: 201,
|
||||
description: 'Создает пользователя в системе',
|
||||
type: UserResponse,
|
||||
};
|
||||
|
||||
export const CREATE_CONFLICT: ApiResponseOptions = {
|
||||
status: 409,
|
||||
description: 'Объект вновь созданного пользователя',
|
||||
type: Error,
|
||||
};
|
||||
|
||||
export const CREATE_NOT_VALID: ApiResponseOptions = {
|
||||
status: 400,
|
||||
description: 'Ошибка при попытке создания пользователя с уже существующим логином',
|
||||
type: Error,
|
||||
};
|
||||
|
||||
export const UPDATE_SUCCESS: ApiResponseOptions = {
|
||||
status: 200,
|
||||
description: 'Объект для обновления пользователя',
|
||||
type: UpdateUserRequest,
|
||||
};
|
||||
|
||||
export const UPDATE_NOT_FOUND: ApiResponseOptions = {
|
||||
status: 404,
|
||||
description: 'Ошибка при попытке обновить пользователя с несуществующим логином',
|
||||
type: Error,
|
||||
};
|
||||
|
||||
export const UPDATE_NOT_VALID: ApiResponseOptions = {
|
||||
status: 400,
|
||||
description: 'Ошибка при попытке обновить пользователя с невалидными полями',
|
||||
type: Error,
|
||||
};
|
||||
|
||||
export const REMOVE_SUCCESS: ApiResponseOptions = {
|
||||
status: 200,
|
||||
description: 'Объект удаленного пользователя',
|
||||
type: UpdateUserRequest,
|
||||
};
|
||||
|
||||
export const REMOVE_NOT_FOUND: ApiResponseOptions = {
|
||||
status: 404,
|
||||
description: 'Ошибка при попытке удалить пользователя с несуществующим логином',
|
||||
type: Error,
|
||||
};
|
||||
Reference in New Issue
Block a user