Created
October 4, 2023 23:13
-
-
Save DavidBiesack/fd879884aea86e0b76648a3657a0ef54 to your computer and use it in GitHub Desktop.
OpenAPI with common components for the Chain Links API
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
components: | |
responses: | |
'204': | |
description: No Content. The operation succeeded but returned no response body. | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/apiProblem' | |
'400': | |
description: Bad Request. Request parameters and/or request body is invalid. | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/apiProblem' | |
'404': | |
description: Not Found. The resource was not found at the request URL. | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/apiProblem' | |
'409': | |
description: Conflict. The operation cannot be completed because of a conflict with the application state. | |
content: | |
application/json: | |
$ref: '#/components/schemas/apiProblem' | |
schemas: | |
resourceId: | |
title: Resource ID | |
description: The unique, opaque ID of an API resource. | |
type: string | |
minLength: 4 | |
maxLength: 48 | |
pattern: ^[-_a-zA-Z0-9:+$]{4,48}$ | |
apiProblem: | |
title: API Problem | |
description: >- | |
API problem response, as per | |
[RFC 9457](https://tools.ietf.org/html/rfc9457). | |
type: object | |
properties: | |
type: | |
description: >- | |
A URI reference | |
[RFC 3986](https://tools.ietf.org/html/rfc3986) | |
that identifies the problem type. | |
type: string | |
format: uri-reference | |
maxLength: 2048 | |
title: | |
description: >- | |
A short, human-readable summary | |
of the problem type. | |
type: string | |
maxLength: 120 | |
status: | |
description: >- | |
The | |
[RFC 9110](https://tools.ietf.org/html/rfc9110) | |
HTTP status code generated by the origin server | |
for this occurrence of the problem. | |
type: integer | |
format: int32 | |
minimum: 100 | |
maximum: 599 | |
instance: | |
description: >- | |
A URI reference that identifies | |
the specific occurrence of the problem. | |
type: string | |
format: uri-reference | |
maxLength: 256 | |
detail: | |
description: >- | |
A human-readable explanation | |
specific to this occurrence of the problem. | |
type: string | |
maxLength: 2048 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment