grape-swagger 0.33.0 → 0.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +7 -7
- data/.rubocop_todo.yml +0 -6
- data/.travis.yml +8 -9
- data/CHANGELOG.md +67 -5
- data/Gemfile +4 -4
- data/README.md +66 -3
- data/grape-swagger.gemspec +1 -1
- data/lib/grape-swagger.rb +1 -1
- data/lib/grape-swagger/doc_methods.rb +2 -0
- data/lib/grape-swagger/doc_methods/build_model_definition.rb +0 -17
- data/lib/grape-swagger/doc_methods/extensions.rb +6 -1
- data/lib/grape-swagger/doc_methods/format_data.rb +51 -0
- data/lib/grape-swagger/doc_methods/move_params.rb +22 -49
- data/lib/grape-swagger/doc_methods/parse_params.rb +6 -0
- data/lib/grape-swagger/endpoint.rb +32 -13
- data/lib/grape-swagger/endpoint/params_parser.rb +10 -17
- data/lib/grape-swagger/version.rb +1 -1
- data/spec/issues/751_deeply_nested_objects_spec.rb +190 -0
- data/spec/lib/endpoint/params_parser_spec.rb +44 -20
- data/spec/lib/endpoint_spec.rb +3 -3
- data/spec/lib/extensions_spec.rb +10 -0
- data/spec/lib/format_data_spec.rb +91 -0
- data/spec/lib/move_params_spec.rb +4 -266
- data/spec/lib/optional_object_spec.rb +0 -1
- data/spec/spec_helper.rb +1 -1
- data/spec/swagger_v2/api_swagger_v2_hash_and_array_spec.rb +3 -1
- data/spec/swagger_v2/api_swagger_v2_response_with_root_spec.rb +153 -0
- data/spec/swagger_v2/description_not_initialized_spec.rb +39 -0
- data/spec/swagger_v2/endpoint_versioned_path_spec.rb +33 -0
- data/spec/swagger_v2/mounted_target_class_spec.rb +1 -1
- data/spec/swagger_v2/namespace_tags_prefix_spec.rb +15 -1
- data/spec/swagger_v2/params_array_spec.rb +2 -2
- data/spec/swagger_v2/parent_less_namespace_spec.rb +32 -0
- data/spec/swagger_v2/{reference_entity.rb → reference_entity_spec.rb} +17 -10
- metadata +22 -9
- data/spec/swagger_v2/description_not_initialized.rb +0 -39
- data/spec/swagger_v2/parent_less_namespace.rb +0 -49
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5cba1006ac7becc6885cd6c7fdc8b41cd8929cedb2911391a88e2fb72bb4ea16
|
|
4
|
+
data.tar.gz: 412d3cf615993037226e68ae3e84bb5a00087e852b4b8e70d7108589fe68e6a3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '08371ae2468afd4549c02114ba8f5891bdec9109e234e7879d76def080324411f3ccc4ca0c4e389364029238db5f420db99fcabe11a82cb18537e9ad35e8611b'
|
|
7
|
+
data.tar.gz: e00dde947780905ebb27cb2b45ee444a5d0dffbb8e6bf51795b90cb1420c03abaf12d013f3aaa53945a70a8c526279e59709c4412d184eab70ec88086cff028c
|
data/.rubocop.yml
CHANGED
|
@@ -4,14 +4,19 @@ AllCops:
|
|
|
4
4
|
Exclude:
|
|
5
5
|
- vendor/**/*
|
|
6
6
|
- example/**/*
|
|
7
|
-
TargetRubyVersion: 2.
|
|
7
|
+
TargetRubyVersion: 2.7
|
|
8
8
|
|
|
9
9
|
Layout/EmptyLinesAroundArguments:
|
|
10
10
|
Enabled: false
|
|
11
11
|
|
|
12
|
-
Layout/
|
|
12
|
+
Layout/FirstHashElementIndentation:
|
|
13
13
|
EnforcedStyle: consistent
|
|
14
14
|
|
|
15
|
+
Layout/LineLength:
|
|
16
|
+
Max: 120
|
|
17
|
+
Exclude:
|
|
18
|
+
- spec/**/*
|
|
19
|
+
|
|
15
20
|
Metrics/BlockLength:
|
|
16
21
|
Exclude:
|
|
17
22
|
- spec/**/*
|
|
@@ -19,11 +24,6 @@ Metrics/BlockLength:
|
|
|
19
24
|
Metrics/ClassLength:
|
|
20
25
|
Max: 300
|
|
21
26
|
|
|
22
|
-
Metrics/LineLength:
|
|
23
|
-
Max: 120
|
|
24
|
-
Exclude:
|
|
25
|
-
- spec/**/*
|
|
26
|
-
|
|
27
27
|
Metrics/MethodLength:
|
|
28
28
|
Exclude:
|
|
29
29
|
- spec/**/*
|
data/.rubocop_todo.yml
CHANGED
|
@@ -13,12 +13,6 @@ Gemspec/RequiredRubyVersion:
|
|
|
13
13
|
Exclude:
|
|
14
14
|
- 'grape-swagger.gemspec'
|
|
15
15
|
|
|
16
|
-
# Offense count: 1
|
|
17
|
-
# Cop supports --auto-correct.
|
|
18
|
-
Lint/UnneededCopEnableDirective:
|
|
19
|
-
Exclude:
|
|
20
|
-
- 'spec/lib/optional_object_spec.rb'
|
|
21
|
-
|
|
22
16
|
# Offense count: 30
|
|
23
17
|
Metrics/AbcSize:
|
|
24
18
|
Max: 59
|
data/.travis.yml
CHANGED
|
@@ -7,21 +7,20 @@ after_success:
|
|
|
7
7
|
- bundle exec danger
|
|
8
8
|
|
|
9
9
|
rvm:
|
|
10
|
-
- 2.
|
|
11
|
-
- 2.
|
|
12
|
-
- 2.
|
|
10
|
+
- 2.5.7
|
|
11
|
+
- 2.6.5
|
|
12
|
+
- 2.7.0
|
|
13
13
|
env:
|
|
14
|
-
- MODEL_PARSER=grape-swagger-entity
|
|
15
|
-
- MODEL_PARSER=grape-swagger-representable
|
|
14
|
+
- GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-entity
|
|
15
|
+
- GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-representable
|
|
16
16
|
- GRAPE_VERSION=1.0.3
|
|
17
|
-
- GRAPE_VERSION=1.2.
|
|
18
|
-
- GRAPE_VERSION=HEAD
|
|
17
|
+
- GRAPE_VERSION=1.2.5
|
|
19
18
|
|
|
20
19
|
matrix:
|
|
21
20
|
fast_finish: true
|
|
22
21
|
|
|
23
22
|
include:
|
|
24
|
-
- rvm: 2.
|
|
23
|
+
- rvm: 2.4.9
|
|
25
24
|
env:
|
|
26
25
|
- rvm: ruby-head
|
|
27
26
|
env:
|
|
@@ -29,6 +28,6 @@ matrix:
|
|
|
29
28
|
env:
|
|
30
29
|
|
|
31
30
|
allow_failures:
|
|
32
|
-
- rvm: 2.
|
|
31
|
+
- rvm: 2.4.9
|
|
33
32
|
- rvm: ruby-head
|
|
34
33
|
- rvm: jruby-head
|
data/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,23 @@
|
|
|
8
8
|
|
|
9
9
|
* Your contribution here.
|
|
10
10
|
|
|
11
|
+
|
|
12
|
+
### 0.34.0 (January 11, 2020)
|
|
13
|
+
|
|
14
|
+
#### Features
|
|
15
|
+
|
|
16
|
+
* [#768](https://github.com/ruby-grape/grape-swagger/pull/768): Uses ruby 2.7, fixes grape to 1.2.5 (cause of dry-types) - [@LeFnord](https://github.com/LeFnord).
|
|
17
|
+
* [#761](https://github.com/ruby-grape/grape-swagger/pull/761): Add an option to configure root element for responses - [@bikolya](https://github.com/bikolya).
|
|
18
|
+
* [#749](https://github.com/ruby-grape/grape-swagger/pull/749): Drop support for Ruby 2.3 and below - [@LeFnord](https://github.com/LeFnord).
|
|
19
|
+
|
|
20
|
+
#### Fixes
|
|
21
|
+
|
|
22
|
+
* [#758](https://github.com/ruby-grape/grape-swagger/pull/758): Handle cases where a route's prefix is a nested URL - [@SimonKaluza](https://github.com/simonkaluza).
|
|
23
|
+
* [#757](https://github.com/ruby-grape/grape-swagger/pull/757): Fix `array_use_braces` for nested body params - [@bikolya](https://github.com/bikolya).
|
|
24
|
+
* [#756](https://github.com/ruby-grape/grape-swagger/pull/756): Fix reference creation when custom type for documentation is provided - [@bikolya](https://github.com/bikolya).
|
|
25
|
+
* [#764](https://github.com/ruby-grape/grape-swagger/pull/764): Fix root element for multi-word entities - [@bikolya](https://github.com/bikolya).
|
|
26
|
+
|
|
27
|
+
|
|
11
28
|
### 0.33.0 (June 21, 2019)
|
|
12
29
|
|
|
13
30
|
#### Fixes
|
|
@@ -17,6 +34,11 @@
|
|
|
17
34
|
* [#743](https://github.com/ruby-grape/grape-swagger/pull/743): CI: use 2.4.6, 2.5.5 - [@olleolleolle](https://github.com/olleolleolle).
|
|
18
35
|
* [#737](https://github.com/ruby-grape/grape-swagger/pull/737): Add swagger endpoint guard to both doc endpoints - [@urkle](https://github.com/urkle).
|
|
19
36
|
|
|
37
|
+
#### Changes
|
|
38
|
+
|
|
39
|
+
* [#749](https://github.com/ruby-grape/grape-swagger/pull/749) Drop support for Ruby 2.3 and below - [@LeFnord](https://github.com/LeFnord).
|
|
40
|
+
|
|
41
|
+
|
|
20
42
|
### 0.32.1 (December 7, 2018)
|
|
21
43
|
|
|
22
44
|
#### Fixes
|
|
@@ -24,6 +46,7 @@
|
|
|
24
46
|
* [#731](https://github.com/ruby-grape/grape-swagger/pull/731): Skip empty parameters and tags arrays - [@fotos](https://github.com/fotos).
|
|
25
47
|
* [#729](https://github.com/ruby-grape/grape-swagger/pull/729): Allow empty security array for endpoints - [@fotos](https://github.com/fotos).
|
|
26
48
|
|
|
49
|
+
|
|
27
50
|
### 0.32.0 (November 26, 2018)
|
|
28
51
|
|
|
29
52
|
#### Features
|
|
@@ -34,13 +57,15 @@
|
|
|
34
57
|
|
|
35
58
|
* [#720](https://github.com/ruby-grape/grape-swagger/pull/720): Fix: corrected `termsOfService` field name in additional info - [@dblock](https://github.com/dblock).
|
|
36
59
|
|
|
60
|
+
|
|
37
61
|
### 0.31.1 (October 23, 2018)
|
|
38
62
|
|
|
39
63
|
#### Features
|
|
40
64
|
|
|
41
65
|
* [#710](https://github.com/ruby-grape/grape-swagger/issues/710): Re-implement `api_documentation` and `specific_api_documentation` options - [@dblock](https://github.com/dblock).
|
|
42
66
|
|
|
43
|
-
|
|
67
|
+
|
|
68
|
+
### 0.31.0 (August 22, 2018)
|
|
44
69
|
|
|
45
70
|
#### Features
|
|
46
71
|
|
|
@@ -50,13 +75,15 @@
|
|
|
50
75
|
* [#691](https://github.com/ruby-grape/grape-swagger/pull/691): Disregard order when parsing request params for arrays - [@jdmurphy](https://github.com/jdmurphy).
|
|
51
76
|
* [#696](https://github.com/ruby-grape/grape-swagger/pull/696): Delegate required properties parsing to model parsers - [@Bugagazavr](https://github.com/Bugagazavr).
|
|
52
77
|
|
|
53
|
-
|
|
78
|
+
|
|
79
|
+
### 0.30.1 (July 19, 2018)
|
|
54
80
|
|
|
55
81
|
#### Features
|
|
56
82
|
|
|
57
83
|
* [#686](https://github.com/ruby-grape/grape-swagger/pull/686): Allow response headers for responses with no content and for files - [@jdmurphy](https://github.com/jdmurphy).
|
|
58
84
|
|
|
59
|
-
|
|
85
|
+
|
|
86
|
+
### 0.30.0 (July 19, 2018)
|
|
60
87
|
|
|
61
88
|
#### Features
|
|
62
89
|
|
|
@@ -67,7 +94,8 @@
|
|
|
67
94
|
* [#681](https://github.com/ruby-grape/grape-swagger/pull/681): Provide error schemas when an endpoint can return a 204 - [@adstratm](https://github.com/adstratm).
|
|
68
95
|
* [#683](https://github.com/ruby-grape/grape-swagger/pull/683): Fix handling of arrays of complex entities in params so that valid OpenAPI spec is generated - [@jdmurphy](https://github.com/jdmurphy).
|
|
69
96
|
|
|
70
|
-
|
|
97
|
+
|
|
98
|
+
### 0.29.0 (May 22, 2018)
|
|
71
99
|
|
|
72
100
|
#### Features
|
|
73
101
|
|
|
@@ -81,6 +109,7 @@
|
|
|
81
109
|
* [#669](https://github.com/ruby-grape/grape-swagger/pull/669): Fix handling of http status codes from routes - [@milgner](https://github.com/milgner).
|
|
82
110
|
* [#672](https://github.com/ruby-grape/grape-swagger/pull/672): Rename 'notes' to 'detail' in README - [@kjleitz](https://github.com/kjleitz).
|
|
83
111
|
|
|
112
|
+
|
|
84
113
|
### 0.28.0 (February 3, 2018)
|
|
85
114
|
|
|
86
115
|
#### Features
|
|
@@ -97,6 +126,7 @@
|
|
|
97
126
|
* [#654](https://github.com/ruby-grape/grape-swagger/pull/654): Allow setting the consumes for PATCH methods - [@anakinj](https://github.com/anakinj).
|
|
98
127
|
* [#656](https://github.com/ruby-grape/grape-swagger/pull/656): Fix `description` field may be null - [@soranoba](https://github.com/soranoba).
|
|
99
128
|
|
|
129
|
+
|
|
100
130
|
### 0.27.3 (July 11, 2017)
|
|
101
131
|
|
|
102
132
|
#### Features
|
|
@@ -107,6 +137,7 @@
|
|
|
107
137
|
|
|
108
138
|
* [#616](https://github.com/ruby-grape/grape-swagger/pull/616): Fix swagger to show root path ([#605](https://github.com/ruby-grape/grape-swagger/issue/605)) - [@NightWolf007](https://github.com/NightWolf007).
|
|
109
139
|
|
|
140
|
+
|
|
110
141
|
### 0.27.2 (May 11, 2017)
|
|
111
142
|
|
|
112
143
|
#### Features
|
|
@@ -115,13 +146,15 @@
|
|
|
115
146
|
* [#596](https://github.com/ruby-grape/grape-swagger/pull/596): Use route_settings for hidden and operations extensions - [@thogg4](https://github.com/thogg4).
|
|
116
147
|
* [#607](https://github.com/ruby-grape/grape-swagger/pull/607): Allow body parameter name to be specified - [@tjwp](https://github.com/tjwp).
|
|
117
148
|
|
|
149
|
+
|
|
118
150
|
### 0.27.1 (April 28, 2017)
|
|
119
151
|
|
|
120
152
|
#### Features
|
|
121
153
|
|
|
122
154
|
* [#602](https://github.com/ruby-grape/grape-swagger/pull/602): Allow security object to be defined - [@markevich](https://github.com/markevich).
|
|
123
155
|
|
|
124
|
-
|
|
156
|
+
|
|
157
|
+
### 0.27.0 (March 27, 2017)
|
|
125
158
|
|
|
126
159
|
#### Features
|
|
127
160
|
|
|
@@ -136,6 +169,7 @@
|
|
|
136
169
|
* [#586](https://github.com/ruby-grape/grape-swagger/pull/586): Issue #587: Parameters delimited by dash cause exception - [@risa](https://github.com/risa).
|
|
137
170
|
* [#593](https://github.com/ruby-grape/grape-swagger/pull/593): Clarify hidden option in readme - [@thogg4](https://github.com/thogg4).
|
|
138
171
|
|
|
172
|
+
|
|
139
173
|
### 0.26.1 (February 3, 2017)
|
|
140
174
|
|
|
141
175
|
#### Features
|
|
@@ -150,6 +184,7 @@
|
|
|
150
184
|
* [#562](https://github.com/ruby-grape/grape-swagger/pull/562): The guard method should allow regular object methods as arguments - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
|
|
151
185
|
* [#574](https://github.com/ruby-grape/grape-swagger/pull/574): Fixes #572: `is_array` should only be applied to success - [@LeFnord](https://github.com/LeFnord).
|
|
152
186
|
|
|
187
|
+
|
|
153
188
|
### 0.26.0 (January 9, 2017)
|
|
154
189
|
|
|
155
190
|
#### Features
|
|
@@ -162,6 +197,7 @@
|
|
|
162
197
|
|
|
163
198
|
* [#561](https://github.com/ruby-grape/grape-swagger/pull/561): Rename failures to failure in readme - [@justincampbell](https://github.com/justincampbell).
|
|
164
199
|
|
|
200
|
+
|
|
165
201
|
### 0.25.3 (December 18, 2016)
|
|
166
202
|
|
|
167
203
|
#### Features
|
|
@@ -175,12 +211,14 @@
|
|
|
175
211
|
* [#548](https://github.com/ruby-grape/grape-swagger/pull/548): Remove dots from operation id - [@frodrigo](https://github.com/frodrigo).
|
|
176
212
|
* [#553](https://github.com/ruby-grape/grape-swagger/pull/553): Align array params for post, put request - addition to [#540](https://github.com/ruby-grape/grape-swagger/pull/540) - [@LeFnord](https://github.com/LeFnord).
|
|
177
213
|
|
|
214
|
+
|
|
178
215
|
### 0.25.2 (November 30, 2016)
|
|
179
216
|
|
|
180
217
|
#### Fixes
|
|
181
218
|
|
|
182
219
|
* [#544](https://github.com/ruby-grape/grape-swagger/pull/544): Fixes #539 and #542; not all of 530 was commited - [@LeFnord](https://github.com/LeFnord).
|
|
183
220
|
|
|
221
|
+
|
|
184
222
|
### 0.25.1 (November 29, 2016)
|
|
185
223
|
|
|
186
224
|
#### Features
|
|
@@ -193,6 +231,7 @@
|
|
|
193
231
|
* [#540](https://github.com/ruby-grape/grape-swagger/pull/540): Corrects exposing of array in post body - [@LeFnord](https://github.com/LeFnord).
|
|
194
232
|
* [#509](https://github.com/ruby-grape/grape-swagger/pull/509), [#529](https://github.com/ruby-grape/grape-swagger/pull/529): Making parent-less routes working - [@mur-wtag](https://github.com/mur-wtag).
|
|
195
233
|
|
|
234
|
+
|
|
196
235
|
### 0.25.0 (October 31, 2016)
|
|
197
236
|
|
|
198
237
|
#### Features
|
|
@@ -208,6 +247,7 @@
|
|
|
208
247
|
* [#515](https://github.com/ruby-grape/grape-swagger/pull/515): Removes limit on model names - [@LeFnord](https://github.com/LeFnord).
|
|
209
248
|
* [#511](https://github.com/ruby-grape/grape-swagger/pull/511): Fix incorrect data type linking for request params of entity types - [@serggl](https://github.com/serggl).
|
|
210
249
|
|
|
250
|
+
|
|
211
251
|
### 0.24.0 (September 23, 2016)
|
|
212
252
|
|
|
213
253
|
#### Features
|
|
@@ -226,6 +266,7 @@
|
|
|
226
266
|
* [#494](https://github.com/ruby-grape/grape-swagger/pull/494): Header parametes are now included in documentation when body parameters have been defined - [@anakinj](https://github.com/anakinj).
|
|
227
267
|
* [#505](https://github.com/ruby-grape/grape-swagger/pull/505): Combines namespaces with their mounted paths to allow APIs with specified mount_paths - [@KevinLiddle](https://github.com/KevinLiddle).
|
|
228
268
|
|
|
269
|
+
|
|
229
270
|
### 0.23.0 (August 5, 2016)
|
|
230
271
|
|
|
231
272
|
#### Features
|
|
@@ -241,6 +282,7 @@
|
|
|
241
282
|
* [#479](https://github.com/ruby-grape/grape-swagger/pull/479): Fix regex for Array and Multi Type in doc_methods. Parsing of "[APoint]" should return "APoint" - [@frodrigo](https://github.com/frodrigo).
|
|
242
283
|
* [#483](https://github.com/ruby-grape/grape-swagger/pull/483): Added support for nicknamed routes - [@pbendersky](https://github.com/pbendersky).
|
|
243
284
|
|
|
285
|
+
|
|
244
286
|
### 0.22.0 (July 12, 2016)
|
|
245
287
|
|
|
246
288
|
#### Features
|
|
@@ -265,6 +307,7 @@
|
|
|
265
307
|
* [#454](https://github.com/ruby-grape/grape-swagger/pull/454): Include documented Hashes in documentation output - [@aschuster3](https://github.com/aschuster3).
|
|
266
308
|
* [#457](https://github.com/ruby-grape/grape-swagger/issues/457): Using camel case on namespace throws exception on add_swagger_documentation method - [@rayko](https://github.com/rayko).
|
|
267
309
|
|
|
310
|
+
|
|
268
311
|
### 0.21.0 (June 1, 2016)
|
|
269
312
|
|
|
270
313
|
#### Features
|
|
@@ -280,6 +323,7 @@
|
|
|
280
323
|
* [#420](https://github.com/ruby-grape/grape-swagger/pull/420): Raise SwaggerSpec exception if swagger spec isn't satisfied, when no parser for model is registered or response model is empty - [@Bugagazavr](https://github.com/Bugagazavr).
|
|
281
324
|
* [#438](https://github.com/ruby-grape/grape-swagger/pull/438): Route version was missing in :options passed to PathString, so Endpoint.path_and_definitions_objects wasn't returning a versioned path when required - [@texpert](https://github.com/texpert).
|
|
282
325
|
|
|
326
|
+
|
|
283
327
|
### 0.20.3 (May 9, 2016)
|
|
284
328
|
|
|
285
329
|
#### Features
|
|
@@ -294,6 +338,7 @@
|
|
|
294
338
|
|
|
295
339
|
* [#399](https://github.com/ruby-grape/grape-swagger/pull/399), [#395](https://github.com/ruby-grape/grape-swagger/issues/395): Make param description optional - [@LeFnord](https://github.com/LeFnord).
|
|
296
340
|
|
|
341
|
+
|
|
297
342
|
### 0.20.2 (April 22, 2016)
|
|
298
343
|
|
|
299
344
|
#### Fixes
|
|
@@ -302,6 +347,7 @@
|
|
|
302
347
|
* [#393](https://github.com/ruby-grape/grape-swagger/pull/393): Properly handle header parameters - [@wleeper](https://github.com/wleeper).
|
|
303
348
|
* [#389](https://github.com/ruby-grape/grape-swagger/pull/389): Respect X-Forwarded-Host - [@edvakf](https://github.com/edvakf).
|
|
304
349
|
|
|
350
|
+
|
|
305
351
|
### 0.20.1 (April 17, 2016)
|
|
306
352
|
|
|
307
353
|
#### Features
|
|
@@ -313,6 +359,7 @@
|
|
|
313
359
|
|
|
314
360
|
* [#383](https://github.com/ruby-grape/grape-swagger/pull/383): Fixed support for Grape 0.12.0 through 0.14.0 - [@LeFnord](https://github.com/LeFnord).
|
|
315
361
|
|
|
362
|
+
|
|
316
363
|
### 0.20.0 (April 9, 2016)
|
|
317
364
|
|
|
318
365
|
#### Features
|
|
@@ -326,10 +373,12 @@
|
|
|
326
373
|
* [#354](https://github.com/ruby-grape/grape-swagger/pull/354): Fixed setting of `base_path` and `host`, added possibility to configure the setting of `version` and `base_path` in documented path and `operationId` - [@LeFnord](https://github.com/LeFnord).
|
|
327
374
|
* [#353](https://github.com/ruby-grape/grape-swagger/pull/353), [#352](https://github.com/ruby-grape/grape-swagger/pull/353): Fixed exception with routes having a dynamic `:section` - [@LeFnord](https://github.com/LeFnord).
|
|
328
375
|
|
|
376
|
+
|
|
329
377
|
### 0.10.5 (April 12, 2016)
|
|
330
378
|
|
|
331
379
|
* [#344](https://github.com/ruby-grape/grape-swagger/pull/344): Namespace based tag included in Swagger JSON - [@LeFnord](https://github.com/LeFnord).
|
|
332
380
|
|
|
381
|
+
|
|
333
382
|
### 0.10.2 (August 19, 2015)
|
|
334
383
|
|
|
335
384
|
#### Features
|
|
@@ -354,11 +403,13 @@
|
|
|
354
403
|
* [#284](https://github.com/ruby-grape/grape-swagger/pull/284): Use new params syntax for swagger doc endpoint, fix an issue that `:name` params not recognized by `declared` method - [@calfzhou](https://github.com/calfzhou).
|
|
355
404
|
* [#286](https://github.com/ruby-grape/grape-swagger/pull/286): Use `detail` value for `notes` - fix an issue where `detail` value specified in a block passed to `desc` was ignored - [@rngtng](https://github.com/rngtng).
|
|
356
405
|
|
|
406
|
+
|
|
357
407
|
### 0.10.1 (March 11, 2015)
|
|
358
408
|
|
|
359
409
|
* [#227](https://github.com/ruby-grape/grape-swagger/issues/227): Fix: nested routes under prefix not documented - [@dblock](https://github.com/dblock).
|
|
360
410
|
* [#226](https://github.com/ruby-grape/grape-swagger/issues/226): Fix: be defensive with nil exposure types - [@dblock](https://github.com/dblock).
|
|
361
411
|
|
|
412
|
+
|
|
362
413
|
### 0.10.0 (March 10, 2015)
|
|
363
414
|
|
|
364
415
|
#### Features
|
|
@@ -378,6 +429,7 @@
|
|
|
378
429
|
* [#208](https://github.com/ruby-grape/grape-swagger/pull/208): Fixed `Float` parameters, exposed as Swagger `float` types - [@u2](https://github.com/u2).
|
|
379
430
|
* [#216](https://github.com/ruby-grape/grape-swagger/pull/216), [#192](https://github.com/ruby-grape/grape-swagger/issues/192), [#189](https://github.com/ruby-grape/grape-swagger/issues/189): Fixed API route paths matching for root endpoints with `grape ~> 0.10.0`, specific `format` and `:path` versioning - [@dm1try](https://github.com/dm1try), [@minch](https://github.com/minch).
|
|
380
431
|
|
|
432
|
+
|
|
381
433
|
### 0.9.0 (December 19, 2014)
|
|
382
434
|
|
|
383
435
|
* [#91](https://github.com/ruby-grape/grape-swagger/issues/91): Fixed empty field for group parameters' name with type hash or Array - [@dukedave](https://github.com/dukedave).
|
|
@@ -392,6 +444,7 @@
|
|
|
392
444
|
* [#167](https://github.com/ruby-grape/grape-swagger/pull/167): Support mutli-tenanted APIs, don't cache `base_path` - [@bradrobertson](https://github.com/bradrobertson), (https://github.com/dblock).
|
|
393
445
|
* [#185](https://github.com/ruby-grape/grape-swagger/pull/185): Support strings in `Grape::Entity.expose`'s `:using` option - [@jhollinger](https://github.com/jhollinger).
|
|
394
446
|
|
|
447
|
+
|
|
395
448
|
### 0.8.0 (August 30, 2014)
|
|
396
449
|
|
|
397
450
|
#### Features
|
|
@@ -421,6 +474,7 @@
|
|
|
421
474
|
* Added `GrapeSwagger::VERSION` - [@dblock](https://github.com/dblock).
|
|
422
475
|
* Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
|
|
423
476
|
|
|
477
|
+
|
|
424
478
|
### 0.7.2 (February 6, 2014)
|
|
425
479
|
|
|
426
480
|
* [#84](https://github.com/ruby-grape/grape-swagger/pull/84): Markdown is now Github Flavored Markdown - [@jeromegn](https://github.com/jeromegn).
|
|
@@ -438,6 +492,7 @@
|
|
|
438
492
|
* [#54](https://github.com/ruby-grape/grape-swagger/pull/54): Adding support for generating swagger `responseClass` and models from Grape Entities - [@calebwoods](https://github.com/calebwoods).
|
|
439
493
|
* [#46](https://github.com/ruby-grape/grape-swagger/pull/46): Fixed translating parameter `type` to String, enables using Mongoid fields as parameter definitions - [@dblock](https://github.com/dblock).
|
|
440
494
|
|
|
495
|
+
|
|
441
496
|
### 0.6.0 (June 19, 2013)
|
|
442
497
|
|
|
443
498
|
* Added Rails 4 support - [@jrhe](https://github.com/jrhe).
|
|
@@ -446,14 +501,17 @@
|
|
|
446
501
|
* Support both `:desc` and `:description` when describing parameters - [@dblock](https://github.com/dblock).
|
|
447
502
|
* Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
|
|
448
503
|
|
|
504
|
+
|
|
449
505
|
### 0.5.0 (March 28, 2013)
|
|
450
506
|
|
|
451
507
|
* Added Grape 0.5.0 support - [@ruby-grape](https://github.com/ruby-grape).
|
|
452
508
|
|
|
509
|
+
|
|
453
510
|
### 0.4.0 (March 28, 2013)
|
|
454
511
|
|
|
455
512
|
* Support https - [@cutalion](https://github.com/cutalion).
|
|
456
513
|
|
|
514
|
+
|
|
457
515
|
### 0.3.0 (October 19, 2012)
|
|
458
516
|
|
|
459
517
|
* Added version support - [@agileanimal](https://github.com/agileanimal), [@fknappe](https://github.com/fknappe).
|
|
@@ -461,24 +519,28 @@
|
|
|
461
519
|
* Added basic support for specifying parameters that need to be passed in the header - [@agileanimal](https://github.com/agileanimal).
|
|
462
520
|
* Add possibility to hide the documentation paths in the generated swagger documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
463
521
|
|
|
522
|
+
|
|
464
523
|
### 0.2.1 (August 17, 2012)
|
|
465
524
|
|
|
466
525
|
* Added support for markdown in notes field - [@ruby-grape](https://github.com/ruby-grape).
|
|
467
526
|
* Fix: compatibility with Rails - [@qwert666](https://github.com/qwert666).
|
|
468
527
|
* Fix: swagger UI history - [@ruby-grape](https://github.com/ruby-grape).
|
|
469
528
|
|
|
529
|
+
|
|
470
530
|
### 0.2.0 (July 27, 2012)
|
|
471
531
|
|
|
472
532
|
* Use resource as root for swagger - [@ruby-grape](https://github.com/ruby-grape).
|
|
473
533
|
* Added support for file uploads, and proper `paramType` - [@ruby-grape](https://github.com/ruby-grape).
|
|
474
534
|
* Added tests - [@nathanvda](https://github.com/nathanvda).
|
|
475
535
|
|
|
536
|
+
|
|
476
537
|
### 0.1.0 (July 19, 2012)
|
|
477
538
|
|
|
478
539
|
* Added some configurability to the generated documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
479
540
|
* Adapted to rails plugin structure - [@ruby-grape](https://github.com/ruby-grape).
|
|
480
541
|
* Allowed cross origin, so swagger can be used from official site - [@ruby-grape](https://github.com/ruby-grape).
|
|
481
542
|
|
|
543
|
+
|
|
482
544
|
### 0.0.0 (July 19, 2012)
|
|
483
545
|
|
|
484
546
|
* Initial public release - [@ruby-grape](https://github.com/ruby-grape).
|
data/Gemfile
CHANGED
|
@@ -14,19 +14,19 @@ gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 1.2'
|
|
|
14
14
|
end
|
|
15
15
|
|
|
16
16
|
gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
|
|
17
|
-
|
|
18
17
|
group :development, :test do
|
|
19
18
|
gem 'bundler'
|
|
20
19
|
gem 'grape-entity'
|
|
21
20
|
gem 'pry', platforms: [:mri]
|
|
22
21
|
gem 'pry-byebug', platforms: [:mri]
|
|
23
|
-
|
|
22
|
+
|
|
23
|
+
gem 'rack', '2.0.8'
|
|
24
24
|
gem 'rack-cors'
|
|
25
25
|
gem 'rack-test'
|
|
26
26
|
gem 'rake'
|
|
27
27
|
gem 'rdoc'
|
|
28
|
-
gem 'rspec', '~> 3.
|
|
29
|
-
gem 'rubocop', '~> 0.
|
|
28
|
+
gem 'rspec', '~> 3.9'
|
|
29
|
+
gem 'rubocop', '~> 0.75', require: false
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
group :test do
|