diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 2d59bb6..fc3d1f9 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -45,7 +45,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RecoveryRequest' + $ref: '#/components/schemas/RecoveryReq' responses: '200': description: Запрос на восстановление принят @@ -109,7 +109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReqEditPromoCode' + $ref: '#/components/schemas/EditPromoCodeReq' responses: '200': description: Промокод успешно обновлен @@ -208,14 +208,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateFastLinkRequest' + $ref: '#/components/schemas/CreateFastLinkReq' responses: '200': description: Быстрая ссылка для промокода успешно создана content: application/json: schema: - $ref: '#/components/schemas/CreateFastLinkResponse' + $ref: '#/components/schemas/CreateFastLinkResp' '400': description: Неверный запрос, отсутствует идентификатор промокода '404': @@ -235,14 +235,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PromoCodeStatsRequest' + $ref: '#/components/schemas/PromoCodeStatsReq' responses: '200': description: Статистика промокода успешно получена content: application/json: schema: - $ref: '#/components/schemas/PromoCodeStats' + $ref: '#/components/schemas/PromoCodeStatsResp' '400': description: Неверный запрос '500': @@ -251,7 +251,7 @@ paths: components: schemas: - RecoveryRequest: + RecoveryReq: type: object required: - email @@ -263,14 +263,14 @@ components: redirectionURL: type: string description: URL-адрес, на который перенаправляется пользователь - PromoCodeStatsRequest: + PromoCodeStatsReq: type: object properties: promoCodeID: type: string required: - promoCodeID - PromoCodeStats: + PromoCodeStatsResp: type: object properties: id: @@ -298,7 +298,7 @@ components: format: date-time description: Время использования промокода - CreateFastLinkRequest: + CreateFastLinkReq: type: object properties: id: @@ -307,7 +307,7 @@ components: required: - id - CreateFastLinkResponse: + CreateFastLinkResp: type: object properties: fastlink: @@ -393,33 +393,8 @@ components: bonus: type: object description: Бонус, предоставляемый с промокодом - properties: - privilege: - type: object - description: Привилегия - properties: - privilegeID: - type: string - description: Идентификатор привилегии - amount: - type: integer - description: Количество привилегии - discount: - type: object - description: Скидка - properties: - layer: - type: integer - description: Уровень скидки - factor: - type: number - description: Множитель скидки - target: - type: string - description: Слой - threshold: - type: integer - description: Граничное значение + items: + $ref: '#/components/schemas/Bonus' outdated: type: boolean description: Флаг @@ -439,7 +414,7 @@ components: type: string description: Список быстрых ссылок для активации промокода - ReqEditPromoCode: + EditPromoCodeReq: type: object properties: ID: @@ -486,35 +461,48 @@ components: bonus: type: object description: Бонус - properties: - privilege: - type: object - description: Привилегия - properties: - privilegeID: - type: string - description: Идентификатор привилегии - amount: - type: integer - description: Количество привилегии - discount: - type: object - description: Скидка - properties: - layer: - type: integer - description: Уровень скидки - factor: - type: number - description: Множитель скидки - target: - type: string - description: Слой - threshold: - type: integer - description: Граничное значение + items: + $ref: '#/components/schemas/Bonus' fastLinks: type: array items: type: string description: Список быстрых ссылок для активации промокода + + Bonus: + type: object + description: Бонус + properties: + privilege: + $ref: '#/components/schemas/Privilege' + discount: + $ref: '#/components/schemas/Discount' + + Privilege: + type: object + description: Привилегия + properties: + privilegeID: + type: string + description: Идентификатор привилегии + amount: + type: integer + description: Количество привилегии + + Discount: + type: object + description: Скидка + properties: + layer: + type: integer + description: Уровень скидки + factor: + type: integer + description: Множитель скидки + target: + type: string + description: Цель скидки + threshold: + type: integer + description: Порог скидки +