35 lines
1.2 KiB
YAML
35 lines
1.2 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
version: "1.0.0"
|
|
title: 'Path Items for example'
|
|
description: 'Defines all the path items used in the example API'
|
|
|
|
tags:
|
|
- name: Example
|
|
|
|
components:
|
|
pathItems:
|
|
GetExampleById:
|
|
get:
|
|
parameters:
|
|
- $ref: "example-params.yaml#/components/parameters/exampleId"
|
|
tags:
|
|
- Example
|
|
summary: "Get example associated with this id"
|
|
operationId: GetExampleById
|
|
responses:
|
|
200:
|
|
description: "The example associated with this id"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: 'example-schemas.yaml#/components/schemas/Example'
|
|
400:
|
|
description: 'The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).'
|
|
403:
|
|
description: 'Forbidden: the server is refusing action, you do not have the necessary permissions this resource'
|
|
500:
|
|
description: 'The server encountered an unexpected condition which prevented it from fulfilling the request'
|