Repository navigation
Expand file tree
/
Copy pathopenapi.json
More file actions
242 lines (242 loc) · 6.08 KB
/
Copy pathopenapi.json
File metadata and controls
242 lines (242 loc) · 6.08 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
{
"components": {
"schemas": {
"CreateWidgetBody": {
"additionalProperties": false,
"properties": {
"color": {
"description": "Optional display color",
"examples": [
"green"
],
"maxLength": 30,
"type": "string"
},
"name": {
"description": "Human-readable widget name",
"examples": [
"Second widget"
],
"maxLength": 80,
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ErrorDetail": {
"additionalProperties": false,
"properties": {
"location": {
"description": "Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'",
"type": "string"
},
"message": {
"description": "Error message text",
"type": "string"
},
"value": {
"description": "The value at the given location"
}
},
"type": "object"
},
"ErrorModel": {
"additionalProperties": false,
"properties": {
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"examples": [
"Property foo is required but is missing."
],
"type": "string"
},
"errors": {
"description": "Optional list of individual error details",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"type": [
"array",
"null"
]
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.",
"examples": [
"https://example.com/error-log/abc123"
],
"format": "uri",
"type": "string"
},
"status": {
"description": "HTTP status code",
"examples": [
400
],
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the problem type. This value should not change between occurrences of the error.",
"examples": [
"Bad Request"
],
"type": "string"
},
"type": {
"default": "about:blank",
"description": "A URI reference to human-readable documentation for the error.",
"examples": [
"https://example.com/errors/example"
],
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"SuccessEnvelopeListWidget": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Widget"
},
"type": [
"array",
"null"
]
}
},
"required": [
"data"
],
"type": "object"
},
"SuccessEnvelopeWidget": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/components/schemas/Widget"
}
},
"required": [
"data"
],
"type": "object"
},
"Widget": {
"additionalProperties": false,
"properties": {
"color": {
"description": "Optional display color",
"examples": [
"blue"
],
"type": "string"
},
"id": {
"description": "Stable widget identifier",
"examples": [
"widget-1"
],
"type": "string"
},
"name": {
"description": "Human-readable widget name",
"examples": [
"First widget"
],
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
},
"info": {
"title": "Gombit Contract Spike",
"version": "0.0.0"
},
"openapi": "3.1.0",
"paths": {
"/widgets": {
"get": {
"operationId": "list-widgets",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessEnvelopeListWidget"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ErrorModel"
}
}
},
"description": "Error"
}
},
"summary": "List widgets",
"tags": [
"Widgets"
]
},
"post": {
"operationId": "create-widget",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWidgetBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessEnvelopeWidget"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ErrorModel"
}
}
},
"description": "Error"
}
},
"summary": "Create a widget",
"tags": [
"Widgets"
]
}
}
}
}