Skip to content

Commit 153669b

Browse files
jamietannajamietanna
committed
chore: remove references to Swagger
As it's been OpenAPI for a while. Related: https://togithub.com/oapi-codegen/oapi-codegen/issues/672
1 parent 5324ea6 commit 153669b

File tree

4 files changed

+43
-43
lines changed

4 files changed

+43
-43
lines changed

‎internal/test/chi/oapi_validate_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,21 @@ func doPost(t *testing.T, mux http.Handler, rawURL string, jsonBody interface{})
4444
}
4545

4646
func TestOapiRequestValidator(t *testing.T) {
47-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
48-
require.NoError(t, err, "Error initializing swagger")
47+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
48+
require.NoError(t, err, "Error initializing OpenAPI spec")
4949

5050
r := chi.NewRouter()
5151

5252
// register middleware
53-
r.Use(middleware.OapiRequestValidator(swagger))
53+
r.Use(middleware.OapiRequestValidator(spec))
5454

5555
// basic cases
5656
testRequestValidatorBasicFunctions(t, r)
5757
}
5858

5959
func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
60-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
61-
require.NoError(t, err, "Error initializing swagger")
60+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
61+
require.NoError(t, err, "Error initializing OpenAPI spec")
6262

6363
r := chi.NewRouter()
6464

@@ -74,7 +74,7 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
7474
}
7575

7676
// register middleware
77-
r.Use(middleware.OapiRequestValidatorWithOptions(swagger, &options))
77+
r.Use(middleware.OapiRequestValidatorWithOptions(spec, &options))
7878

7979
called := false
8080

@@ -156,8 +156,8 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
156156
}
157157

158158
func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T) {
159-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
160-
require.NoError(t, err, "Error initializing swagger")
159+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
160+
require.NoError(t, err, "Error initializing OpenAPI spec")
161161

162162
r := chi.NewRouter()
163163

@@ -176,7 +176,7 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
176176
}
177177

178178
// register middleware
179-
r.Use(middleware.OapiRequestValidatorWithOptions(swagger, &options))
179+
r.Use(middleware.OapiRequestValidatorWithOptions(spec, &options))
180180

181181
called := false
182182

@@ -258,8 +258,8 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
258258
}
259259

260260
func TestOapiRequestValidatorWithOptions(t *testing.T) {
261-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
262-
require.NoError(t, err, "Error initializing swagger")
261+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
262+
require.NoError(t, err, "Error initializing OpenAPI spec")
263263

264264
r := chi.NewRouter()
265265

@@ -283,7 +283,7 @@ func TestOapiRequestValidatorWithOptions(t *testing.T) {
283283
}
284284

285285
// register middleware
286-
r.Use(middleware.OapiRequestValidatorWithOptions(swagger, &options))
286+
r.Use(middleware.OapiRequestValidatorWithOptions(spec, &options))
287287

288288
// basic cases
289289
testRequestValidatorBasicFunctions(t, r)

‎internal/test/gorilla/oapi_validate_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,21 @@ func doPost(t *testing.T, mux http.Handler, rawURL string, jsonBody interface{})
4444
}
4545

4646
func TestOapiRequestValidator(t *testing.T) {
47-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
48-
require.NoError(t, err, "Error initializing swagger")
47+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
48+
require.NoError(t, err, "Error initializing OpenAPI spec")
4949

5050
r := mux.NewRouter()
5151

5252
// register middleware
53-
r.Use(middleware.OapiRequestValidator(swagger))
53+
r.Use(middleware.OapiRequestValidator(spec))
5454

5555
// basic cases
5656
testRequestValidatorBasicFunctions(t, r)
5757
}
5858

5959
func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
60-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
61-
require.NoError(t, err, "Error initializing swagger")
60+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
61+
require.NoError(t, err, "Error initializing OpenAPI spec")
6262

6363
r := mux.NewRouter()
6464

@@ -74,7 +74,7 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
7474
}
7575

7676
// register middleware
77-
r.Use(middleware.OapiRequestValidatorWithOptions(swagger, &options))
77+
r.Use(middleware.OapiRequestValidatorWithOptions(spec, &options))
7878

7979
called := false
8080

@@ -156,8 +156,8 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
156156
}
157157

158158
func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T) {
159-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
160-
require.NoError(t, err, "Error initializing swagger")
159+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
160+
require.NoError(t, err, "Error initializing OpenAPI spec")
161161

162162
r := mux.NewRouter()
163163

@@ -176,7 +176,7 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
176176
}
177177

178178
// register middleware
179-
r.Use(middleware.OapiRequestValidatorWithOptions(swagger, &options))
179+
r.Use(middleware.OapiRequestValidatorWithOptions(spec, &options))
180180

181181
called := false
182182

@@ -258,8 +258,8 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
258258
}
259259

260260
func TestOapiRequestValidatorWithOptions(t *testing.T) {
261-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
262-
require.NoError(t, err, "Error initializing swagger")
261+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
262+
require.NoError(t, err, "Error initializing OpenAPI spec")
263263

264264
r := mux.NewRouter()
265265

@@ -283,7 +283,7 @@ func TestOapiRequestValidatorWithOptions(t *testing.T) {
283283
}
284284

285285
// register middleware
286-
r.Use(middleware.OapiRequestValidatorWithOptions(swagger, &options))
286+
r.Use(middleware.OapiRequestValidatorWithOptions(spec, &options))
287287

288288
// basic cases
289289
testRequestValidatorBasicFunctions(t, r)

‎internal/test/nethttp/oapi_validate_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -48,21 +48,21 @@ func use(r *http.ServeMux, mw func(next http.Handler) http.Handler) http.Handler
4848
}
4949

5050
func TestOapiRequestValidator(t *testing.T) {
51-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
52-
require.NoError(t, err, "Error initializing swagger")
51+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
52+
require.NoError(t, err, "Error initializing OpenAPI spec")
5353

5454
r := http.NewServeMux()
5555

5656
// create middleware
57-
mw := middleware.OapiRequestValidator(swagger)
57+
mw := middleware.OapiRequestValidator(spec)
5858

5959
// basic cases
6060
testRequestValidatorBasicFunctions(t, r, mw)
6161
}
6262

6363
func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
64-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
65-
require.NoError(t, err, "Error initializing swagger")
64+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
65+
require.NoError(t, err, "Error initializing OpenAPI spec")
6666

6767
// Set up an authenticator to check authenticated function. It will allow
6868
// access to "someScope", but disallow others.
@@ -91,7 +91,7 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
9191
})
9292

9393
// register middleware
94-
mw := middleware.OapiRequestValidatorWithOptions(swagger, &options)
94+
mw := middleware.OapiRequestValidatorWithOptions(spec, &options)
9595
server := mw(r)
9696

9797
// Let's send a good request, it should pass
@@ -166,8 +166,8 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
166166
}
167167

168168
func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T) {
169-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
170-
require.NoError(t, err, "Error initializing swagger")
169+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
170+
require.NoError(t, err, "Error initializing OpenAPI spec")
171171

172172
r := http.NewServeMux()
173173

@@ -199,7 +199,7 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
199199
})
200200

201201
// register middleware
202-
server := use(r, middleware.OapiRequestValidatorWithOptions(swagger, &options))
202+
server := use(r, middleware.OapiRequestValidatorWithOptions(spec, &options))
203203

204204
// Let's send a good request, it should pass
205205
{
@@ -273,8 +273,8 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
273273
}
274274

275275
func TestOapiRequestValidatorWithOptions(t *testing.T) {
276-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
277-
require.NoError(t, err, "Error initializing swagger")
276+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
277+
require.NoError(t, err, "Error initializing OpenAPI spec")
278278

279279
r := http.NewServeMux()
280280

@@ -298,7 +298,7 @@ func TestOapiRequestValidatorWithOptions(t *testing.T) {
298298
}
299299

300300
// register middleware
301-
mw := middleware.OapiRequestValidatorWithOptions(swagger, &options)
301+
mw := middleware.OapiRequestValidatorWithOptions(spec, &options)
302302
server := use(r, mw)
303303

304304
// basic cases

‎oapi_validate.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ type Options struct {
3131
SilenceServersWarning bool
3232
}
3333

34-
// OapiRequestValidator Creates middleware to validate request by swagger spec.
35-
func OapiRequestValidator(swagger *openapi3.T) func(next http.Handler) http.Handler {
36-
return OapiRequestValidatorWithOptions(swagger, nil)
34+
// OapiRequestValidator Creates middleware to validate request by OpenAPI spec.
35+
func OapiRequestValidator(spec *openapi3.T) func(next http.Handler) http.Handler {
36+
return OapiRequestValidatorWithOptions(spec, nil)
3737
}
3838

39-
// OapiRequestValidatorWithOptions Creates middleware to validate request by swagger spec.
40-
func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) func(next http.Handler) http.Handler {
41-
if swagger.Servers != nil && (options == nil || !options.SilenceServersWarning) {
39+
// OapiRequestValidatorWithOptions Creates middleware to validate request by OpenAPI spec.
40+
func OapiRequestValidatorWithOptions(spec *openapi3.T, options *Options) func(next http.Handler) http.Handler {
41+
if spec.Servers != nil && (options == nil || !options.SilenceServersWarning) {
4242
log.Println("WARN: OapiRequestValidatorWithOptions called with an OpenAPI spec that has `Servers` set. This may lead to an HTTP 400 with `no matching operation was found` when sending a valid request, as the validator performs `Host` header validation. If you're expecting `Host` header validation, you can silence this warning by setting `Options.SilenceServersWarning = true`. See https://github.com/deepmap/oapi-codegen/issues/882 for more information.")
4343
}
4444

45-
router, err := gorillamux.NewRouter(swagger)
45+
router, err := gorillamux.NewRouter(spec)
4646
if err != nil {
4747
panic(err)
4848
}

0 commit comments

Comments
 (0)