openapi_config

type Config struct {
	// Version is the specification version the document declares and is written against.
	Version string

	// Info identifies the API. Title and Version are required of a document and cannot be derived
	// from any endpoint.
	Info *openapiTypes.Info

	// Servers are the base URLs the API is served at.
	Servers []*openapiTypes.Server

	// SecuritySchemes are the ways a request may prove who is making it, by the name an operation
	// refers to them by. Every scheme declared here is offered as an alternative on every endpoint
	// that is not public.
	SecuritySchemes map[string]*openapiTypes.SecurityScheme

	// Tags describe the groups operations name through Hint.Tags.
	Tags []*openapiTypes.Tag

	// Path is where a served document is offered.
	Path string

	// Public says whether the served document may be read without a session.
	//
	// It is false by default, unlike most things that are served. The document names every
	// operation, its inputs and its outputs, including those that exist for one customer's
	// administrators; handing that to an unauthenticated reader is a decision to be made on
	// purpose, not by leaving a field alone. A document meant for a public API says so here.
	Public bool

	// CacheControl is what a served document is cached under. Empty means a value derived from
	// Public: a gated document is private and revalidated, a public one may be held briefly.
	CacheControl string
}

type Option func(*Config)