1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
|
components:
schemas:
Error:
type: object
description: Error info in problem-details-0.0.1 format
properties:
error:
$ref: "../common-data-objects/problem-details-0.0.1.schema.json"
responses:
400:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
json:
$ref: "#/components/examples/BadRequest"
401:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
json:
$ref: "#/components/examples/Unauthorized"
500:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
examples:
json:
$ref: "#/components/examples/InternalServerError"
examples:
BadRequest:
summary: Wrong format
value:
error:
type: validation-error
title: Your request parameters didn't validate.
status: 400
invalid-params:
- name: age
reason: must be a positive integer
- name: color
reason: must be 'green', 'red' or 'blue'
Unauthorized:
summary: Not authenticated
value:
error:
type: unauthorized
title: The request has not been applied because it lacks valid authentication credentials
for the target resource.
status: 401
InternalServerError:
summary: Not handled internal server error
value:
error:
type: internal-server-error
title: Internal server error.
status: 500
|