Module: Jsapi::Meta::OpenAPI::Extensions

Included in:
Contact, Definitions, Example::Model, ExternalDocumentation, Header::Model, Info, License, Link::Model, Jsapi::Meta::OAuthFlow, Jsapi::Meta::Operation, Parameter::Model, RequestBody::Model, Response::Model, Schema::Base, SecurityScheme::APIKey, SecurityScheme::HTTP::Basic, SecurityScheme::HTTP::Bearer, SecurityScheme::HTTP::Other, SecurityScheme::OAuth2, SecurityScheme::OpenIDConnect, Server, ServerVariable, Tag
Defined in:
lib/jsapi/meta/openapi/extensions.rb

Instance Method Summary collapse

Instance Method Details

#add_openapi_extension(name, value = nil) ⇒ Object

Adds an OpenAPI extension.

Raises an ArgumentError if name is blank.

Raises:

  • (ArgumentError) 


14
15
16
17
18
 
# File 'lib/jsapi/meta/openapi/extensions.rb', line 14

def add_openapi_extension(name, value = nil)
  raise ArgumentError, "name can't be blank" if name.blank?

  openapi_extensions["x-#{name}".to_sym] = value
end

#openapi_extensions ⇒ Object

:nodoc:



20
21
22
 
# File 'lib/jsapi/meta/openapi/extensions.rb', line 20

def openapi_extensions # :nodoc:
  @openapi_extensions ||= {}
end

#openapi_extensions=(extensions) ⇒ Object

:nodoc:



24
25
26
27
28
29
30
 
# File 'lib/jsapi/meta/openapi/extensions.rb', line 24

def openapi_extensions=(extensions) # :nodoc:
  @openapi_extensions = {}

  extensions.each do |name, value|
    add_openapi_extension(name, value)
  end
end