Class: Jsapi::Meta::SecurityScheme::Base

Inherits:

Model::Base

• Object
• Model::Base
• Jsapi::Meta::SecurityScheme::Base

Defined in:

lib/jsapi/meta/security_scheme/base.rb

Direct Known Subclasses

APIKey, HTTP::Basic, HTTP::Bearer, HTTP::Other, MutualTLS, OAuth2, OpenIDConnect

Instance Method Summary

• #deprecated ⇒ Object

  :attr: deprecated Specifies whether the security scheme is marked as deprecated.

• #description ⇒ Object

  :attr: description The description of the security scheme.

Methods inherited from Model::Base

#initialize, #inspect, #merge!, #reference?, #resolve

Methods included from Model::Attributes

#attributes_frozen?, #freeze_attributes, included

Constructor Details

This class inherits a constructor from Jsapi::Meta::Model::Base

Instance Method Details

#deprecated ⇒ Object

:attr: deprecated Specifies whether the security scheme is marked as deprecated.

Applies to OpenAPI 3.2 and higher.

# File 'lib/jsapi/meta/security_scheme/base.rb', line 17

attribute :deprecated, values: [true, false]

#description ⇒ Object

:attr: description The description of the security scheme.

# File 'lib/jsapi/meta/security_scheme/base.rb', line 10

attribute :description, String