security

type ApiKey struct {
	// The name of the field containing the API key.
	Name string `json:"string"`

	// Where the API key is stored.
	In ApiKeyIn `json:"in"`
}

type ApiKeyIn string

type Http struct {
	Scheme       string  `json:"scheme"`
	BearerFormat *string `json:"bearerFormat"`
}

type OAuthFlow struct {
	// The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
	AuthorizationUrl string `json:"authorizationUrl"`

	// The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
	TokenUrl string `json:"tokenUrl"`

	// The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
	RefreshUrl *string `json:"refreshUrl,omitempty"`

	// The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
	Scopes map[string]string `json:"scopes"`
}

type OAuthFlows struct {
	// Configuration for the OAuth implicit flow.
	Implicit *OAuthFlow `json:"implicit,omitempty" exhaustruct:"optional"`

	// Configuration for the OAuth password flow.
	Password *OAuthFlow `json:"password,omitempty" exhaustruct:"optional"`

	// Configuration for the OAuth client credentials (aka "application") flow.
	ClientCredentials *OAuthFlow `json:"clientCredentials,omitempty" exhaustruct:"optional"`

	// Configuration for the OAuth authorization code (aka "accesCode") flow.
	AuthorizationCode *OAuthFlow `json:"authorizationCode,omitempty" exhaustruct:"optional"`
}

type OpenIdConnect struct {
	OpenIdConnectUrl string `json:"openIdConnectUrl"`
}

type Reference shared.Reference

type Requirement = map[string][]string

type Scheme interface {
	// contains filtered or unexported methods
}

type Spec struct {
	// The type of security, e.g. oauth2.
	Type Type `json:"type"`

	// A human readable description. May contain markdown.
	Description *string `json:"description,omitempty" exhaustruct:"optional"`

	// Poor man's sum type. Provided iff Type is TypeAPIKey.
	*ApiKey `exhaustruct:"optional"`

	// Poor man's sum type. Provided iff Type is TypeHttp.
	*Http `exhaustruct:"optional"`

	// Poor man's sum type. Provided iff Type is TypeOAuth2.
	Flows *OAuthFlows `json:"flows" exhaustruct:"optional"`

	// Poor man's sum type. Provided iff Type is TypeOpenIdConnect.
	*OpenIdConnect `exhaustruct:"optional"`
}

type Type string