Class: Apipie::ResponseDescription
- Inherits:
-
Object
- Object
- Apipie::ResponseDescription
- Includes:
- DSL::Base, DSL::Param
- Defined in:
- lib/apipie/response_description.rb,
lib/apipie/response_description.rb
Defined Under Namespace
Classes: ResponseObject
Instance Attribute Summary collapse
-
#code ⇒ Object
readonly
Returns the value of attribute code.
-
#description ⇒ Object
readonly
Returns the value of attribute description.
-
#hash_validator ⇒ Object
readonly
Returns the value of attribute hash_validator.
-
#is_array_of ⇒ Object
readonly
Returns the value of attribute is_array_of.
-
#scope ⇒ Object
readonly
Returns the value of attribute scope.
-
#type_ref ⇒ Object
readonly
Returns the value of attribute type_ref.
Attributes included from DSL::Base
#api_params, #apipie_resource_descriptions
Class Method Summary collapse
Instance Method Summary collapse
- #additional_properties ⇒ Object (also: #allow_additional_properties)
-
#initialize(method_description, code, options, scope, block, adapter) ⇒ ResponseDescription
constructor
A new instance of ResponseDescription.
- #is_array? ⇒ Boolean
- #param_description ⇒ Object
- #params_ordered ⇒ Object
- #to_json(lang = nil) ⇒ Object
Methods included from DSL::Param
#_default_param_group_scope, #param, #param_group, #property, #returns
Methods included from DSL::Base
Constructor Details
#initialize(method_description, code, options, scope, block, adapter) ⇒ ResponseDescription
Returns a new instance of ResponseDescription.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/apipie/response_description.rb', line 70 def initialize(method_description, code, , scope, block, adapter) @type_ref = [:param_group] @is_array_of = [:array_of] || false raise ReturnsMultipleDefinitionError, if @is_array_of && @type_ref @type_ref ||= @is_array_of @method_description = method_description if code.is_a? Symbol @code = Rack::Utils::SYMBOL_TO_STATUS_CODE[code] else @code = code end @description = [:desc] if @description.nil? @description = Rack::Utils::HTTP_STATUS_CODES[@code] raise "Cannot infer description from status code #{@code}" if @description.nil? end @scope = scope if adapter @response_object = adapter else @response_object = ResponseObject.new(method_description, scope, block) end @response_object.additional_properties ||= [:additional_properties] end |
Instance Attribute Details
#code ⇒ Object (readonly)
Returns the value of attribute code.
53 54 55 |
# File 'lib/apipie/response_description.rb', line 53 def code @code end |
#description ⇒ Object (readonly)
Returns the value of attribute description.
53 54 55 |
# File 'lib/apipie/response_description.rb', line 53 def description @description end |
#hash_validator ⇒ Object (readonly)
Returns the value of attribute hash_validator.
53 54 55 |
# File 'lib/apipie/response_description.rb', line 53 def hash_validator @hash_validator end |
#is_array_of ⇒ Object (readonly)
Returns the value of attribute is_array_of.
53 54 55 |
# File 'lib/apipie/response_description.rb', line 53 def is_array_of @is_array_of end |
#scope ⇒ Object (readonly)
Returns the value of attribute scope.
53 54 55 |
# File 'lib/apipie/response_description.rb', line 53 def scope @scope end |
#type_ref ⇒ Object (readonly)
Returns the value of attribute type_ref.
53 54 55 |
# File 'lib/apipie/response_description.rb', line 53 def type_ref @type_ref end |
Class Method Details
.from_dsl_data(method_description, code, args) ⇒ Object
55 56 57 58 59 60 61 62 63 64 |
# File 'lib/apipie/response_description.rb', line 55 def self.from_dsl_data(method_description, code, args) , scope, block, adapter = args Apipie::ResponseDescription.new(method_description, code, , scope, block, adapter) end |
Instance Method Details
#additional_properties ⇒ Object Also known as: allow_additional_properties
110 111 112 |
# File 'lib/apipie/response_description.rb', line 110 def additional_properties !!@response_object.additional_properties end |
#is_array? ⇒ Boolean
66 67 68 |
# File 'lib/apipie/response_description.rb', line 66 def is_array? @is_array_of != false end |
#param_description ⇒ Object
102 103 104 |
# File 'lib/apipie/response_description.rb', line 102 def param_description nil end |
#params_ordered ⇒ Object
106 107 108 |
# File 'lib/apipie/response_description.rb', line 106 def params_ordered @response_object.params_ordered end |
#to_json(lang = nil) ⇒ Object
115 116 117 118 119 120 121 122 123 |
# File 'lib/apipie/response_description.rb', line 115 def to_json(lang=nil) { :code => code, :description => description, :is_array => is_array?, :returns_object => params_ordered.map{ |param| param.to_json(lang).tap{|h| h.delete(:validations) }}.flatten, :additional_properties => additional_properties, } end |