Class: APIGatewayDSL::Parameter

Inherits:
Object
  • Object
show all
Defined in:
lib/api_gateway_dsl/parameter.rb,
lib/api_gateway_dsl/parameter/body.rb,
lib/api_gateway_dsl/parameter/path.rb,
lib/api_gateway_dsl/parameter/query.rb,
lib/api_gateway_dsl/parameter/header.rb,
lib/api_gateway_dsl/parameter/simple.rb,
lib/api_gateway_dsl/parameter/collection.rb

Direct Known Subclasses

Simple

Defined Under Namespace

Classes: Body, Collection, Header, Path, Query, Simple

Instance Method Summary collapse

Constructor Details

#initialize(name, **options) ⇒ Parameter

Returns a new instance of Parameter.



4
5
6
7
8
 
# File 'lib/api_gateway_dsl/parameter.rb', line 4

def initialize(name, **options)
  @name        = name
  @description = options[:description].try(:strip_heredoc)
  @required    = !!options[:required]
end

Instance Method Details

#as_json ⇒ Object 



10
11
12
13
14
15
16
17
 
# File 'lib/api_gateway_dsl/parameter.rb', line 10

def as_json
  {}.tap do |result|
    result[:name]        = @name
    result[:description] = @description if @description
    result[:in]          = @in
    result[:required]    = @required
  end
end