Files
sxchnge/backend/contracts/sendico/api/response/response.yaml
T

48 lines
1.1 KiB
YAML

components:
schemas:
BaseResponse:
type: object
additionalProperties: false
required:
- status
- data
properties:
status:
$ref: ./status.yaml#/components/schemas/ApiStatus
data:
description: Payload for success or error responses.
ErrorResponse:
allOf:
- $ref: ./response.yaml#/components/schemas/BaseResponse
- type: object
properties:
status:
type: string
enum:
- error
data:
$ref: ./error.yaml#/components/schemas/ApiError
SuccessResultData:
type: object
additionalProperties: false
required:
- result
properties:
result:
type: boolean
SuccessResultResponse:
allOf:
- $ref: ./response.yaml#/components/schemas/BaseResponse
- type: object
properties:
status:
type: string
enum:
- success
- processed
data:
$ref: ./response.yaml#/components/schemas/SuccessResultData