Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify defaults around openapi3filter.Options and openapi3filter.Aut… #305

Merged
merged 1 commit into from
Feb 23, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions openapi3filter/options.go
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
package openapi3filter

import (
"context"
)

// DefaultOptions do not set an AuthenticationFunc.
// A spec with security schemes defined will not pass validation
// unless an AuthenticationFunc is defined.
var DefaultOptions = &Options{}

// Options used by ValidateRequest and ValidateResponse
type Options struct {
ExcludeRequestBody bool
ExcludeResponseBody bool
IncludeResponseStatus bool
MultiError bool
AuthenticationFunc func(c context.Context, input *AuthenticationInput) error

MultiError bool

// See NoopAuthenticationFunc
AuthenticationFunc AuthenticationFunc
}