forked from OAI/OpenAPI-Specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpath_item_servers_parameters.yaml
More file actions
114 lines (114 loc) · 2.86 KB
/
path_item_servers_parameters.yaml
File metadata and controls
114 lines (114 loc) · 2.86 KB
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
openapi: 3.2.0
info:
title: API
version: 1.0.0
paths:
/things:
summary: Lots of things
servers:
- url: https://things.example.com
get:
summary: Get a list of things
externalDocs:
description: Find more info here
url: https://example.com
parameters:
- $ref: '#/components/parameters/biscuit'
summary: The maximum number of things to return
description: The maximum number of things to return
responses:
default:
description: A list of things
servers:
- url: https://things.example.com
post:
deprecated: false
requestBody:
$ref: '#/components/requestBodies/ThingRequestBody'
responses:
'201':
$ref: '#/components/responses/ThingResponse'
callbacks:
myCallback:
'{$request.query.queryUrl}':
post:
requestBody:
description: Callback payload
content:
application/json:
schema:
$ref: '#/components/schemas/SomePayload'
responses:
'200':
description: callback successfully processed
transactionCallback:
$ref: '#/components/callbacks/transactionCallback'
patch: {}
delete: {}
head: {}
options: {}
trace: {}
components:
callbacks:
transactionCallback:
'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}':
post:
requestBody:
description: Callback payload
content:
application/json:
schema:
$ref: '#/components/schemas/SomePayload'
responses:
'200':
description: callback successfully processed
examples:
ThingExample:
summary: A thing
description: A thing
value:
id: 1
name: Thing
links:
ThingLink:
description: A link to a thing
operationId: getThing
parameters:
thingId: '$response.body#/id'
server:
url: https://things.example.com
ThingyLink:
$ref: '#/components/links/ThingLink'
parameters:
limit:
name: limit
in: query
required: false
allowEmptyValue: false
allowReserved: false
deprecated: true
description: The maximum number of list items to return
schema:
type: integer
minimum: 0
biscuit:
name: biscuit
in: cookie
style: form
schema:
type: string
requestBodies:
ThingRequestBody:
content:
application/json:
schema:
type: object
responses:
ThingResponse:
description: A thing
content:
application/json:
schema:
type: object
schemas:
SomePayload: {}