Skip to content

Commit d109c1a

Browse files
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 e81f4c5 commit d109c1a

2 files changed

Lines changed: 19 additions & 19 deletions

File tree

oapi_validate.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,16 @@ func OapiValidatorFromYamlFile(path string) (echo.MiddlewareFunc, error) {
4646
return nil, fmt.Errorf("error reading %s: %w", path, err)
4747
}
4848

49-
swagger, err := openapi3.NewLoader().LoadFromData(data)
49+
spec, err := openapi3.NewLoader().LoadFromData(data)
5050
if err != nil {
51-
return nil, fmt.Errorf("error parsing %s as Swagger YAML: %w", path, err)
51+
return nil, fmt.Errorf("error parsing %s as OpenAPI YAML: %w", path, err)
5252
}
53-
return OapiRequestValidator(swagger), nil
53+
return OapiRequestValidator(spec), nil
5454
}
5555

56-
// OapiRequestValidator creates a validator from a swagger object.
57-
func OapiRequestValidator(swagger *openapi3.T) echo.MiddlewareFunc {
58-
return OapiRequestValidatorWithOptions(swagger, nil)
56+
// OapiRequestValidator creates a validator from an OpenAPI spec.
57+
func OapiRequestValidator(spec *openapi3.T) echo.MiddlewareFunc {
58+
return OapiRequestValidatorWithOptions(spec, nil)
5959
}
6060

6161
// ErrorHandler is called when there is an error in validation
@@ -77,13 +77,13 @@ type Options struct {
7777
SilenceServersWarning bool
7878
}
7979

80-
// OapiRequestValidatorWithOptions creates a validator from a swagger object, with validation options
81-
func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) echo.MiddlewareFunc {
82-
if swagger.Servers != nil && (options == nil || !options.SilenceServersWarning) {
80+
// OapiRequestValidatorWithOptions creates a validator from an OpenAPI spec, with validation options
81+
func OapiRequestValidatorWithOptions(spec *openapi3.T, options *Options) echo.MiddlewareFunc {
82+
if spec.Servers != nil && (options == nil || !options.SilenceServersWarning) {
8383
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.")
8484
}
8585

86-
router, err := gorillamux.NewRouter(swagger)
86+
router, err := gorillamux.NewRouter(spec)
8787
if err != nil {
8888
panic(err)
8989
}

oapi_validate_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ func doPost(t *testing.T, e *echo.Echo, rawURL string, jsonBody interface{}) *ht
8484
}
8585

8686
func TestOapiRequestValidator(t *testing.T) {
87-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
88-
require.NoError(t, err, "Error initializing swagger")
87+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
88+
require.NoError(t, err, "Error initializing OpenAPI spec")
8989

9090
// Create a new echo router
9191
e := echo.New()
@@ -119,7 +119,7 @@ func TestOapiRequestValidator(t *testing.T) {
119119
}
120120

121121
// Install our OpenApi based request validator
122-
e.Use(OapiRequestValidatorWithOptions(swagger, &options))
122+
e.Use(OapiRequestValidatorWithOptions(spec, &options))
123123

124124
called := false
125125

@@ -234,8 +234,8 @@ func TestOapiRequestValidator(t *testing.T) {
234234
}
235235

236236
func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
237-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
238-
require.NoError(t, err, "Error initializing swagger")
237+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
238+
require.NoError(t, err, "Error initializing OpenAPI spec")
239239

240240
// Create a new echo router
241241
e := echo.New()
@@ -252,7 +252,7 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
252252
}
253253

254254
// register middleware
255-
e.Use(OapiRequestValidatorWithOptions(swagger, &options))
255+
e.Use(OapiRequestValidatorWithOptions(spec, &options))
256256

257257
called := false
258258

@@ -335,8 +335,8 @@ func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
335335
}
336336

337337
func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T) {
338-
swagger, err := openapi3.NewLoader().LoadFromData(testSchema)
339-
require.NoError(t, err, "Error initializing swagger")
338+
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
339+
require.NoError(t, err, "Error initializing OpenAPI spec")
340340

341341
// Create a new echo router
342342
e := echo.New()
@@ -360,7 +360,7 @@ func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T)
360360
}
361361

362362
// register middleware
363-
e.Use(OapiRequestValidatorWithOptions(swagger, &options))
363+
e.Use(OapiRequestValidatorWithOptions(spec, &options))
364364

365365
called := false
366366

0 commit comments

Comments
 (0)