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
|
package openapi3
import (
"encoding/json"
"testing"
"github.com/stretchr/testify/require"
)
func TestExtraSiblingsInRemoteRef(t *testing.T) {
t.Skip("skipping Internet test during Debian build")
spec := []byte(`
openapi: 3.0.1
servers:
- url: http://localhost:5000
info:
version: v1
title: Products api
contact:
name: me
email: me@github.com
description: This is a sample
paths:
/categories:
get:
summary: Provides the available categories for the store
operationId: list-categories
responses:
'200':
description: this is a desc
content:
application/json:
schema:
$ref: http://schemas.sentex.io/store/categories.json
`[1:])
// When that site fails to respond:
// see https://github.com/getkin/kin-openapi/issues/495
// http://schemas.sentex.io/store/categories.json
// {
// "$id": "http://schemas.sentex.io/store/categories.json",
// "$schema": "http://json-schema.org/draft-07/schema#",
// "description": "array of category strings",
// "type": "array",
// "items": {
// "allOf": [
// {
// "$ref": "http://schemas.sentex.io/store/category.json"
// }
// ]
// }
// }
// http://schemas.sentex.io/store/category.json
// {
// "$id": "http://schemas.sentex.io/store/category.json",
// "$schema": "http://json-schema.org/draft-07/schema#",
// "description": "category name for products",
// "type": "string",
// "pattern": "^[A-Za-z0-9\\-]+$",
// "minimum": 1,
// "maximum": 30
// }
sl := NewLoader()
sl.IsExternalRefsAllowed = true
doc, err := sl.LoadFromData(spec)
require.NoError(t, err)
err = doc.Validate(sl.Context, AllowExtraSiblingFields("$id", "$schema"))
require.NoError(t, err)
}
func TestIssue513OKWithExtension(t *testing.T) {
spec := `
openapi: "3.0.3"
info:
title: 'My app'
version: 1.0.0
description: 'An API'
paths:
/v1/operation:
delete:
summary: Delete something
responses:
200:
description: Success
default:
description: '* **400** - Bad Request'
x-my-extension: {val: ue}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
description: An error response body.
properties:
message:
description: A detailed message describing the error.
type: string
`[1:]
sl := NewLoader()
doc, err := sl.LoadFromData([]byte(spec))
require.NoError(t, err)
err = doc.Validate(sl.Context)
require.NoError(t, err)
data, err := json.Marshal(doc)
require.NoError(t, err)
require.Contains(t, string(data), `x-my-extension`)
}
func TestIssue513KOHasExtraFieldSchema(t *testing.T) {
spec := `
openapi: "3.0.3"
info:
title: 'My app'
version: 1.0.0
description: 'An API'
paths:
/v1/operation:
delete:
summary: Delete something
responses:
200:
description: Success
default:
description: '* **400** - Bad Request'
x-my-extension: {val: ue}
# Notice here schema is invalid. It should instead be:
# content:
# application/json:
# schema:
# $ref: '#/components/schemas/Error'
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
description: An error response body.
properties:
message:
description: A detailed message describing the error.
type: string
`[1:]
sl := NewLoader()
doc, err := sl.LoadFromData([]byte(spec))
require.NoError(t, err)
require.Contains(t, doc.Paths.Value("/v1/operation").Delete.Responses.Default().Value.Extensions, `x-my-extension`)
err = doc.Validate(sl.Context)
require.ErrorContains(t, err, `extra sibling fields: [schema]`)
}
func TestIssue513KOMixesRefAlongWithOtherFieldsDisallowed(t *testing.T) {
spec := `
openapi: "3.0.3"
info:
title: 'My app'
version: 1.0.0
description: 'An API'
paths:
/v1/operation:
delete:
summary: Delete something
responses:
200:
description: A sibling field that the spec says is ignored
$ref: '#/components/responses/SomeResponseBody'
components:
responses:
SomeResponseBody:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
description: An error response body.
properties:
message:
description: A detailed message describing the error.
type: string
`[1:]
sl := NewLoader()
doc, err := sl.LoadFromData([]byte(spec))
require.NoError(t, err)
err = doc.Validate(sl.Context)
require.ErrorContains(t, err, `extra sibling fields: [description]`)
}
func TestIssue513KOMixesRefAlongWithOtherFieldsAllowed(t *testing.T) {
spec := `
openapi: "3.0.3"
info:
title: 'My app'
version: 1.0.0
description: 'An API'
paths:
/v1/operation:
delete:
summary: Delete something
responses:
200:
description: A sibling field that the spec says is ignored
$ref: '#/components/responses/SomeResponseBody'
components:
responses:
SomeResponseBody:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
description: An error response body.
properties:
message:
description: A detailed message describing the error.
type: string
`[1:]
sl := NewLoader()
doc, err := sl.LoadFromData([]byte(spec))
require.NoError(t, err)
err = doc.Validate(sl.Context, AllowExtraSiblingFields("description"))
require.NoError(t, err)
}
|
