libopenapi/datamodel/high/v2/security_definitions.go

// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT

package v2

import low "github.com/pb33f/libopenapi/datamodel/low/v2"

// SecurityDefinitions is a high-level representation of a Swagger / OpenAPI 2 Security Definitions object, that
// is backed by a low-level one.
//
// A declaration of the security schemes available to be used in the specification. This does not enforce the security
// schemes on the operations and only serves to provide the relevant details for each scheme
//  - https://swagger.io/specification/v2/#securityDefinitionsObject
type SecurityDefinitions struct {
	Definitions map[string]*SecurityScheme
	low         *low.SecurityDefinitions
}

// NewSecurityDefinitions creates a new high-level instance of a SecurityDefinitions from a low-level one.
func NewSecurityDefinitions(definitions *low.SecurityDefinitions) *SecurityDefinitions {
	sd := new(SecurityDefinitions)
	sd.low = definitions
	schemes := make(map[string]*SecurityScheme)
	for k := range definitions.Definitions {
		schemes[k.Value] = NewSecurityScheme(definitions.Definitions[k].Value)
	}
	sd.Definitions = schemes
	return sd
}

// GoLow returns the low-level SecurityDefinitions instance used to create the high-level one.
func (sd *SecurityDefinitions) GoLow() *low.SecurityDefinitions {
	return sd.low
}