Skip to content

Commit

Permalink
docs: add usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickp-at-work authored Apr 28, 2022
1 parent 6c8a324 commit d1ca6ab
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions problemDetails.openapi.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
openapi: 3.1.0
info:
title: ProblemDetails
version: 1.0.0
description: |
version: 1.0.1
description: |-
The sole purpose of this API definition is to expose the `ProblemDetails` DTO.
Other API definitions can **[include the `ProblemDetails` DTO by `$ref`erencing it](https://swagger.io/docs/specification/using-ref/)**.
### Usage Example:
```yaml
responses:
'400':
schema:
$ref: 'https://raw.githubusercontent.com/patrickp-at-work/rfc7807-openapi/1.0.1/problemDetails.openapi.yml#/components/schemas/ProblemDetails'
```
contact:
url: 'https://github.com/patrickp-at-work/rfc7807-openapi/'
name: patrickp-at-work
Expand Down

0 comments on commit d1ca6ab

Please sign in to comment.