-
Notifications
You must be signed in to change notification settings - Fork 470
/
parse_params.rb
179 lines (149 loc) · 6.44 KB
/
parse_params.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# frozen_string_literal: true
module GrapeSwagger
module DocMethods
class ParseParams
class << self
def call(param, settings, path, route, definitions)
method = route.request_method
additional_documentation = settings.fetch(:documentation, {})
settings.merge!(additional_documentation)
data_type = DataType.call(settings)
value_type = settings.merge(data_type: data_type, path: path, param_name: param, method: method)
# required properties
@parsed_param = {
in: param_type(value_type),
name: settings[:full_name] || param
}
# optional properties
document_description(settings)
document_type_and_format(settings, data_type)
document_array_param(value_type, definitions) if value_type[:is_array]
document_default_value(settings) unless value_type[:is_array]
document_range_values(settings) unless value_type[:is_array]
document_required(settings)
document_additional_properties(definitions, settings) unless value_type[:is_array]
document_add_extensions(settings)
document_example(settings)
@parsed_param
end
private
def document_description(settings)
description = settings[:desc] || settings[:description]
@parsed_param[:description] = description if description
end
def document_required(settings)
@parsed_param[:required] = settings[:required] || false
@parsed_param[:required] = true if @parsed_param[:in] == 'path'
end
def document_range_values(settings)
values = settings[:values] || nil
enum_or_range_values = parse_enum_or_range_values(values)
@parsed_param.merge!(enum_or_range_values) if enum_or_range_values
end
def document_default_value(settings)
@parsed_param[:default] = settings[:default] if settings.key?(:default)
end
def document_type_and_format(settings, data_type)
if DataType.primitive?(data_type)
data = DataType.mapping(data_type)
@parsed_param[:type], @parsed_param[:format] = data
else
@parsed_param[:type] = data_type
end
@parsed_param[:format] = settings[:format] if settings[:format].present?
end
def document_add_extensions(settings)
GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(settings, @parsed_param)
end
def document_array_param(value_type, definitions)
if value_type[:documentation].present?
param_type = value_type[:documentation][:param_type]
doc_type = value_type[:documentation][:type]
type = DataType.mapping(doc_type) if doc_type && !DataType.request_primitive?(doc_type)
collection_format = value_type[:documentation][:collectionFormat]
end
param_type ||= value_type[:param_type]
array_items = parse_array_item(
definitions,
type,
value_type
)
@parsed_param[:in] = param_type || 'formData'
@parsed_param[:items] = array_items
@parsed_param[:type] = 'array'
@parsed_param[:collectionFormat] = collection_format if DataType.collections.include?(collection_format)
end
def parse_array_item(definitions, type, value_type)
array_items = {}
if definitions[value_type[:data_type]]
array_items['$ref'] = "#/definitions/#{@parsed_param[:type]}"
else
array_items[:type] = type || @parsed_param[:type] == 'array' ? 'string' : @parsed_param[:type]
end
array_items[:format] = @parsed_param.delete(:format) if @parsed_param[:format]
values = value_type[:values] || nil
enum_or_range_values = parse_enum_or_range_values(values)
array_items.merge!(enum_or_range_values) if enum_or_range_values
array_items[:default] = value_type[:default] if value_type[:default].present?
set_additional_properties, additional_properties = parse_additional_properties(definitions, value_type)
array_items[:additionalProperties] = additional_properties if set_additional_properties
array_items
end
def document_additional_properties(definitions, settings)
set_additional_properties, additional_properties = parse_additional_properties(definitions, settings)
@parsed_param[:additionalProperties] = additional_properties if set_additional_properties
end
def parse_additional_properties(definitions, settings)
return false unless settings.key?(:additionalProperties) || settings.key?(:additional_properties)
value =
if settings.key?(:additionalProperties)
GrapeSwagger::Errors::SwaggerSpecDeprecated.tell!(:additionalProperties)
settings[:additionalProperties]
else
settings[:additional_properties]
end
parsed_value =
if definitions[value.to_s]
{ '$ref': "#/definitions/#{value}" }
elsif value.is_a?(Class)
{ type: DataType.call(value) }
else
value
end
[true, parsed_value]
end
def document_example(settings)
example = settings[:example]
@parsed_param[:example] = example if example
end
def param_type(value_type)
param_type = value_type[:param_type] || value_type[:in]
if value_type[:path].include?("{#{value_type[:param_name]}}")
'path'
elsif param_type
param_type
elsif %w[POST PUT PATCH].include?(value_type[:method])
DataType.request_primitive?(value_type[:data_type]) ? 'formData' : 'body'
else
'query'
end
end
def parse_enum_or_range_values(values)
case values
when Proc
parse_enum_or_range_values(values.call) if values.parameters.empty?
when Range
parse_range_values(values) if values.first.is_a?(Integer)
when Array
{ enum: values }
else
{ enum: [values] } if values
end
end
def parse_range_values(values)
{ minimum: values.begin, maximum: values.end }.compact
end
end
end
end
end