libopenapi/datamodel/high/v2/security_scheme.go

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

package v2

import (
	"github.com/pb33f/libopenapi/datamodel/high"
	low "github.com/pb33f/libopenapi/datamodel/low/v2"
)

// SecurityScheme is a high-level representation of a Swagger / OpenAPI 2 SecurityScheme object
// backed by a low-level one.
//
// SecurityScheme allows the definition of a security scheme that can be used by the operations. Supported schemes are
// basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows
// (implicit, password, application and access code)
//   - https://swagger.io/specification/v2/#securityDefinitionsObject
type SecurityScheme struct {
	Type             string
	Description      string
	Name             string
	In               string
	Flow             string
	AuthorizationUrl string
	TokenUrl         string
	Scopes           *Scopes
	Extensions       map[string]any
	low              *low.SecurityScheme
}

// NewSecurityScheme creates a new instance of SecurityScheme from a low-level one.
func NewSecurityScheme(securityScheme *low.SecurityScheme) *SecurityScheme {
	s := new(SecurityScheme)
	s.low = securityScheme
	s.Extensions = high.ExtractExtensions(securityScheme.Extensions)
	if !securityScheme.Type.IsEmpty() {
		s.Type = securityScheme.Type.Value
	}
	if !securityScheme.Description.IsEmpty() {
		s.Description = securityScheme.Description.Value
	}
	if !securityScheme.Name.IsEmpty() {
		s.Name = securityScheme.Name.Value
	}
	if !securityScheme.In.IsEmpty() {
		s.In = securityScheme.In.Value
	}
	if !securityScheme.Flow.IsEmpty() {
		s.Flow = securityScheme.Flow.Value
	}
	if !securityScheme.AuthorizationUrl.IsEmpty() {
		s.AuthorizationUrl = securityScheme.AuthorizationUrl.Value
	}
	if !securityScheme.TokenUrl.IsEmpty() {
		s.TokenUrl = securityScheme.TokenUrl.Value
	}
	if !securityScheme.Scopes.IsEmpty() {
		s.Scopes = NewScopes(securityScheme.Scopes.Value)
	}
	return s
}

// GoLow returns the low-level SecurityScheme that was used to create the high-level one.
func (s *SecurityScheme) GoLow() *low.SecurityScheme {
	return s.low
}