grape-swagger 2.1.1 → 2.1.3
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/CHANGELOG.md +128 -99
- data/README.md +155 -32
- data/RELEASING.md +8 -8
- data/grape-swagger.gemspec +2 -3
- data/lib/grape-swagger/doc_methods/build_model_definition.rb +1 -1
- data/lib/grape-swagger/doc_methods/format_data.rb +1 -1
- data/lib/grape-swagger/doc_methods/move_params.rb +1 -1
- data/lib/grape-swagger/doc_methods/parse_params.rb +4 -2
- data/lib/grape-swagger/doc_methods.rb +0 -1
- data/lib/grape-swagger/endpoint.rb +52 -48
- data/lib/grape-swagger/errors.rb +2 -0
- data/lib/grape-swagger/rake/oapi_tasks.rb +1 -1
- data/lib/grape-swagger/request_param_parser_registry.rb +48 -0
- data/lib/grape-swagger/{endpoint/params_parser.rb → request_param_parsers/body.rb} +21 -22
- data/lib/grape-swagger/request_param_parsers/headers.rb +33 -0
- data/lib/grape-swagger/request_param_parsers/route.rb +66 -0
- data/lib/grape-swagger/token_owner_resolver.rb +101 -0
- data/lib/grape-swagger/version.rb +1 -1
- data/lib/grape-swagger.rb +12 -5
- metadata +11 -26
- data/lib/grape-swagger/doc_methods/headers.rb +0 -20
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e83759346d523a9dc09d200cb5477b65ea4f84cc832cd90f1e74ff3dc5a08277
|
|
4
|
+
data.tar.gz: 3c4a6fbabe58a5382332544358d23e0c5eb94cf2a9b53d02f221da1a749814e2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 76b0e94bf1b75dde592f8602b253bbc701bbb6334d9456d340d342ed01d45f3d7153ef47998375a9a960fd29a24a9022bf5e371d280a336a0c24aee932b93f52
|
|
7
|
+
data.tar.gz: 55b59bbfd070ee86285575e1be90259d93f0f57b18f55744f3711b32c210016afc7672a45e90d0509e3c854d1ca266c143f8bad85a19cb0d2babc33baa7cebb2
|
data/CHANGELOG.md
CHANGED
|
@@ -1,121 +1,150 @@
|
|
|
1
|
-
### 2.1.
|
|
1
|
+
### 2.1.3 (2025-11-21)
|
|
2
|
+
|
|
3
|
+
#### Features
|
|
4
|
+
|
|
5
|
+
* [#956](https://github.com/ruby-grape/grape-swagger/pull/956): Add `danger` - [@numbata](https://github.com/numbata).
|
|
6
|
+
* [#958](https://github.com/ruby-grape/grape-swagger/pull/958): Drop ruby-head from test matrix - [@numbata](https://github.com/numbata).
|
|
7
|
+
* [#953](https://github.com/ruby-grape/grape-swagger/pull/953): Added `super_diff` - [@numbata](https://github.com/numbata).
|
|
8
|
+
* [#951](https://github.com/ruby-grape/grape-swagger/pull/951): Use `x-example` for non-body parameters - [@olivier-thatch](https://github.com/olivier-thatch).
|
|
9
|
+
* [#963](https://github.com/ruby-grape/grape-swagger/pull/963): Allow empty model definitions for swagger 2.0 - [@numbata](https://github.com/numbata).
|
|
10
|
+
|
|
11
|
+
#### Fixes
|
|
12
|
+
|
|
13
|
+
* [#966](https://github.com/ruby-grape/grape-swagger/pull/966): Grape 3.0 compatibility - [@numbata](https://github.com/numbata).
|
|
14
|
+
* [#954](https://github.com/ruby-grape/grape-swagger/pull/954): Ruby 3.5 compatibility: add cgi gem, drop runtime `rack‑test` - [@numbata](https://github.com/numbata).
|
|
15
|
+
* [#948](https://github.com/ruby-grape/grape-swagger/pull/948): Grape 2.3.0 and Ruby 3.5 compatibility - [@numbata](https://github.com/numbata).
|
|
16
|
+
|
|
17
|
+
### 2.1.2 (2025-01-07)
|
|
18
|
+
|
|
19
|
+
#### Features
|
|
20
|
+
|
|
21
|
+
* [#945](https://github.com/ruby-grape/grape-swagger/pull/945): Add support for primitive data types in responses - [@gregg-platogo](https://github.com/gregg-platogo).
|
|
22
|
+
|
|
23
|
+
#### Fixes
|
|
24
|
+
|
|
25
|
+
* [#943](https://github.com/ruby-grape/grape-swagger/pull/943): Fix route_param documentation and type - [@4ndv](https://github.com/4ndv).
|
|
26
|
+
* [#944](https://github.com/ruby-grape/grape-swagger/pull/944): Amend a few typographic errors - [@pieterocp](https://github.com/pieterocp).
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### 2.1.1 (2024-09-21)
|
|
2
30
|
|
|
3
31
|
#### Fixes
|
|
4
32
|
|
|
5
|
-
* [#940](https://github.com/ruby-grape/grape-swagger/pull/940): Grape 2.2.0 compatibility - [@padde](https://github.com/padde)
|
|
33
|
+
* [#940](https://github.com/ruby-grape/grape-swagger/pull/940): Grape 2.2.0 compatibility - [@padde](https://github.com/padde).
|
|
34
|
+
|
|
6
35
|
|
|
7
|
-
### 2.1.0 (
|
|
36
|
+
### 2.1.0 (2024-05-14)
|
|
8
37
|
|
|
9
38
|
#### Features
|
|
10
39
|
|
|
11
|
-
* [#927](https://github.com/ruby-grape/grape-swagger/pull/927): Set default parameter location based on consumes - [@spaceraccoon](https://github.com/spaceraccoon)
|
|
12
|
-
* [#929](https://github.com/ruby-grape/grape-swagger/pull/929): Set query parameter for array of primitive types - [@spaceraccoon](https://github.com/spaceraccoon)
|
|
40
|
+
* [#927](https://github.com/ruby-grape/grape-swagger/pull/927): Set default parameter location based on consumes - [@spaceraccoon](https://github.com/spaceraccoon).
|
|
41
|
+
* [#929](https://github.com/ruby-grape/grape-swagger/pull/929): Set query parameter for array of primitive types - [@spaceraccoon](https://github.com/spaceraccoon).
|
|
13
42
|
|
|
14
43
|
#### Fixes
|
|
15
44
|
|
|
16
|
-
* [#926](https://github.com/ruby-grape/grape-swagger/pull/926): Refactor route and namespace combination logic - [@numbata](https://github.com/numbata)
|
|
45
|
+
* [#926](https://github.com/ruby-grape/grape-swagger/pull/926): Refactor route and namespace combination logic - [@numbata](https://github.com/numbata).
|
|
17
46
|
|
|
18
47
|
|
|
19
|
-
### 2.0.3 (
|
|
48
|
+
### 2.0.3 (2024-04-26)
|
|
20
49
|
|
|
21
50
|
#### Fixes
|
|
22
51
|
|
|
23
|
-
* [#922](https://github.com/ruby-grape/grape-swagger/pull/922): Force request body to be an schema object - [@numbata](https://github.com/numbata)
|
|
24
|
-
* [#923](https://github.com/ruby-grape/grape-swagger/pull/923): Enabled schema definitions for body parameters in DELETE requests - [@numbata](https://github.com/numbata)
|
|
25
|
-
* [#924](https://github.com/ruby-grape/grape-swagger/pull/924):
|
|
52
|
+
* [#922](https://github.com/ruby-grape/grape-swagger/pull/922): Force request body to be an schema object - [@numbata](https://github.com/numbata).
|
|
53
|
+
* [#923](https://github.com/ruby-grape/grape-swagger/pull/923): Enabled schema definitions for body parameters in DELETE requests - [@numbata](https://github.com/numbata).
|
|
54
|
+
* [#924](https://github.com/ruby-grape/grape-swagger/pull/924): Use mount_path to narrow down urls_for - [@chibicco](https://github.com/chibicco).
|
|
26
55
|
|
|
27
56
|
|
|
28
|
-
### 2.0.2 (
|
|
57
|
+
### 2.0.2 (2024-02-02)
|
|
29
58
|
|
|
30
59
|
#### Fixes
|
|
31
60
|
|
|
32
|
-
* [#918](https://github.com/ruby-grape/grape-swagger/pull/918): Fix params extension does not work when param_type is body - [@numbata](https://github.com/numbata)
|
|
61
|
+
* [#918](https://github.com/ruby-grape/grape-swagger/pull/918): Fix params extension does not work when param_type is body - [@numbata](https://github.com/numbata).
|
|
33
62
|
|
|
34
63
|
|
|
35
|
-
### 2.0.1 (
|
|
64
|
+
### 2.0.1 (2024-01-02)
|
|
36
65
|
|
|
37
66
|
#### Features
|
|
38
67
|
|
|
39
|
-
* [#914](https://github.com/ruby-grape/grape-swagger/pull/914): Support Ruby 3.3 - [@LeFnord](https://github.com/LeFnord)
|
|
68
|
+
* [#914](https://github.com/ruby-grape/grape-swagger/pull/914): Support Ruby 3.3 - [@LeFnord](https://github.com/LeFnord).
|
|
40
69
|
|
|
41
70
|
#### Fixes
|
|
42
71
|
|
|
43
|
-
* [#916](https://github.com/ruby-grape/grape-swagger/pull/916): Restore Ruby 3.0 support - [@godfat](https://github.com/godfat)
|
|
72
|
+
* [#916](https://github.com/ruby-grape/grape-swagger/pull/916): Restore Ruby 3.0 support - [@godfat](https://github.com/godfat).
|
|
44
73
|
|
|
45
74
|
|
|
46
|
-
### 2.0.0 (
|
|
75
|
+
### 2.0.0 (2023-11-07)
|
|
47
76
|
|
|
48
77
|
#### Features
|
|
49
78
|
|
|
50
|
-
* [#910](https://github.com/ruby-grape/grape-swagger/pull/910): Allow using Grape v2 - [@ninoseki](https://github.com/ninoseki)
|
|
79
|
+
* [#910](https://github.com/ruby-grape/grape-swagger/pull/910): Allow using Grape v2 - [@ninoseki](https://github.com/ninoseki).
|
|
51
80
|
|
|
52
81
|
#### Fixes
|
|
53
82
|
|
|
54
|
-
* [#903](https://github.com/ruby-grape/grape-swagger/pull/903): Accept `example` documentation parameter for arrays - [@VladMomotov](https://github.com/VladMomotov)
|
|
83
|
+
* [#903](https://github.com/ruby-grape/grape-swagger/pull/903): Accept `example` documentation parameter for arrays - [@VladMomotov](https://github.com/VladMomotov).
|
|
55
84
|
|
|
56
85
|
|
|
57
|
-
### 1.6.1 (
|
|
86
|
+
### 1.6.1 (2023-05-21)
|
|
58
87
|
|
|
59
88
|
#### Fixes
|
|
60
89
|
|
|
61
|
-
* [#868](https://github.com/ruby-grape/grape-swagger/pull/896): Fix parsing endless range values - [@dhruvCW](https://github.com/dhruvCW)
|
|
90
|
+
* [#868](https://github.com/ruby-grape/grape-swagger/pull/896): Fix parsing endless range values - [@dhruvCW](https://github.com/dhruvCW).
|
|
62
91
|
|
|
63
92
|
|
|
64
|
-
### 1.6.0 (
|
|
93
|
+
### 1.6.0 (2023-03-19)
|
|
65
94
|
|
|
66
95
|
#### Features
|
|
67
96
|
|
|
68
|
-
* [#872](https://github.com/ruby-grape/grape-swagger/pull/872): Add `consumes` and `produces` options to `add_swagger_documentation` - [@spaceraccoon](https://github.com/spaceraccoon)
|
|
69
|
-
* [#868](https://github.com/ruby-grape/grape-swagger/pull/868): Add `default` endpoint option to specify default response - [@dhruvCW](https://github.com/dhruvCW)
|
|
97
|
+
* [#872](https://github.com/ruby-grape/grape-swagger/pull/872): Add `consumes` and `produces` options to `add_swagger_documentation` - [@spaceraccoon](https://github.com/spaceraccoon).
|
|
98
|
+
* [#868](https://github.com/ruby-grape/grape-swagger/pull/868): Add `default` endpoint option to specify default response - [@dhruvCW](https://github.com/dhruvCW).
|
|
70
99
|
|
|
71
100
|
|
|
72
|
-
### 1.5.0 (
|
|
101
|
+
### 1.5.0 (2022-07-28)
|
|
73
102
|
|
|
74
103
|
#### Features
|
|
75
104
|
|
|
76
|
-
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-)
|
|
105
|
+
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-).
|
|
77
106
|
|
|
78
107
|
#### Fixes
|
|
79
108
|
|
|
80
|
-
* [#860](https://github.com/ruby-grape/grape-swagger/pull/860)
|
|
81
|
-
* [#843](https://github.com/ruby-grape/grape-swagger/pull/843) Syntax errors in README.md examples [@remvee](https://github.com/remvee)
|
|
82
|
-
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844) Fixes the regexp used for parsing routes [@senhalil](https://github.com/senhalil)
|
|
83
|
-
* [#847](https://github.com/ruby-grape/grape-swagger/pull/847) Parse route_param type for nested endpoints [@dmoss18](https://github.com/dmoss18)
|
|
84
|
-
* [#856](https://github.com/ruby-grape/grape-swagger/pull/856) Remove unused methods in GrapeSwagger::DocMethods::BuildModelDefinition [@takahashim](https://github.com/takahashim)
|
|
85
|
-
* [#858](https://github.com/ruby-grape/grape-swagger/pull/858): Set permissions for GitHub actions [@naveensrinivasan](https://github.com/naveensrinivasan)
|
|
86
|
-
* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick to support Ruby 3.x [@takahashim](https://github.com/takahashim)
|
|
87
|
-
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work [@takahashim](https://github.com/takahashim)
|
|
88
|
-
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Refactor oapi fetch task [@Vachman](https://github.com/Vachman)
|
|
89
|
-
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of enum to be Array [@takahashim](https://github.com/takahashim)
|
|
109
|
+
* [#860](https://github.com/ruby-grape/grape-swagger/pull/860): Included githubactions in the dependabot config - [@naveensrinivasan](https://github.com/naveensrinivasan).
|
|
110
|
+
* [#843](https://github.com/ruby-grape/grape-swagger/pull/843): Syntax errors in README.md examples - [@remvee](https://github.com/remvee).
|
|
111
|
+
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil).
|
|
112
|
+
* [#847](https://github.com/ruby-grape/grape-swagger/pull/847): Parse route_param type for nested endpoints - [@dmoss18](https://github.com/dmoss18).
|
|
113
|
+
* [#856](https://github.com/ruby-grape/grape-swagger/pull/856): Remove unused methods in GrapeSwagger::DocMethods::BuildModelDefinition - [@takahashim](https://github.com/takahashim).
|
|
114
|
+
* [#858](https://github.com/ruby-grape/grape-swagger/pull/858): Set permissions for GitHub actions - [@naveensrinivasan](https://github.com/naveensrinivasan).
|
|
115
|
+
* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick to support Ruby 3.x - [@takahashim](https://github.com/takahashim).
|
|
116
|
+
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work - [@takahashim](https://github.com/takahashim).
|
|
117
|
+
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Refactor oapi fetch task - [@Vachman](https://github.com/Vachman).
|
|
118
|
+
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of enum to be Array - [@takahashim](https://github.com/takahashim).
|
|
90
119
|
|
|
91
|
-
### 1.4.3 (
|
|
120
|
+
### 1.4.3 (2022-01-05)
|
|
92
121
|
|
|
93
122
|
#### Fixes
|
|
94
123
|
|
|
95
|
-
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of `enum` to be `Array` - [@takahashim](https://github.com/takahashim)
|
|
96
|
-
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Fixes oapi rake tasks, allows generating sepcs for different API versions.
|
|
97
|
-
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work without error - [@takahashim](https://github.com/takahashim)
|
|
98
|
-
* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick gem so that example works in Ruby 3.x - [@takahashim](https://github.com/takahashim)
|
|
99
|
-
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil)
|
|
100
|
-
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-)
|
|
124
|
+
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of `enum` to be `Array` - [@takahashim](https://github.com/takahashim).
|
|
125
|
+
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Fixes oapi rake tasks, allows generating sepcs for different API versions - [@Vachman](https://github.com/Vachman).
|
|
126
|
+
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work without error - [@takahashim](https://github.com/takahashim).
|
|
127
|
+
* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick gem so that example works in Ruby 3.x - [@takahashim](https://github.com/takahashim).
|
|
128
|
+
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil).
|
|
129
|
+
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-).
|
|
101
130
|
|
|
102
|
-
### 1.4.2 (
|
|
131
|
+
### 1.4.2 (2021-10-22)
|
|
103
132
|
|
|
104
133
|
#### Fixes
|
|
105
134
|
|
|
106
|
-
* [#840](https://github.com/ruby-grape/grape-swagger/pull/840): Fixes documentation of `additionalProperties` field when used with array parameters, or when setting it to `false` - [@magni-](https://github.com/magni-)
|
|
107
|
-
* [#841](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes `type` and `format` values for object fields nested in an array ([#832](https://github.com/ruby-grape/grape-swagger/issue/832)) - [@magni-](https://github.com/magni-)
|
|
108
|
-
* [#839](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes documentation of `false` or `nil` default parameter values - [@magni-](https://github.com/magni-)
|
|
135
|
+
* [#840](https://github.com/ruby-grape/grape-swagger/pull/840): Fixes documentation of `additionalProperties` field when used with array parameters, or when setting it to `false` - [@magni-](https://github.com/magni-).
|
|
136
|
+
* [#841](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes `type` and `format` values for object fields nested in an array ([#832](https://github.com/ruby-grape/grape-swagger/issue/832)) - [@magni-](https://github.com/magni-).
|
|
137
|
+
* [#839](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes documentation of `false` or `nil` default parameter values - [@magni-](https://github.com/magni-).
|
|
109
138
|
|
|
110
139
|
|
|
111
|
-
### 1.4.1 (
|
|
140
|
+
### 1.4.1 (2021-09-15)
|
|
112
141
|
|
|
113
142
|
#### Fixes
|
|
114
143
|
|
|
115
|
-
* [#833](https://github.com/ruby-grape/grape-swagger/pull/833): Fixes issue of examples not showing for `in: 'body'` parameters - [@stevenou](https://github.com/stevenou)
|
|
144
|
+
* [#833](https://github.com/ruby-grape/grape-swagger/pull/833): Fixes issue of examples not showing for `in: 'body'` parameters - [@stevenou](https://github.com/stevenou).
|
|
116
145
|
|
|
117
146
|
|
|
118
|
-
### 1.4.0 (
|
|
147
|
+
### 1.4.0 (2021-03-20)
|
|
119
148
|
|
|
120
149
|
#### Features
|
|
121
150
|
|
|
@@ -127,7 +156,7 @@
|
|
|
127
156
|
* [#822](https://github.com/ruby-grape/grape-swagger/pull/822): Corrected the related parameter lookup on request params - [@Jack12816](https://github.com/Jack12816).
|
|
128
157
|
|
|
129
158
|
|
|
130
|
-
### 1.3.1 (
|
|
159
|
+
### 1.3.1 (2020-11-01)
|
|
131
160
|
|
|
132
161
|
#### Features
|
|
133
162
|
|
|
@@ -138,21 +167,21 @@
|
|
|
138
167
|
* [#811](https://github.com/ruby-grape/grape-swagger/pull/811): Fixes #809: supports utf8 route names - [@LeFnord](https://github.com/LeFnord).
|
|
139
168
|
|
|
140
169
|
|
|
141
|
-
### 1.3.0 (
|
|
170
|
+
### 1.3.0 (2020-09-03)
|
|
142
171
|
|
|
143
172
|
#### Features
|
|
144
173
|
|
|
145
174
|
* [#804](https://github.com/ruby-grape/grape-swagger/pull/804): Don't overwrite model description with the route description - [@Bhacaz](https://github.com/Bhacaz).
|
|
146
175
|
|
|
147
176
|
|
|
148
|
-
### 1.2.1 (
|
|
177
|
+
### 1.2.1 (2020-07-15)
|
|
149
178
|
|
|
150
179
|
#### Fixes
|
|
151
180
|
|
|
152
181
|
* [#801](https://github.com/ruby-grape/grape-swagger/pull/801): Fixes behaviour after grape upgrade to 1.4.0 - [@LeFnord](https://github.com/LeFnord).
|
|
153
182
|
|
|
154
183
|
|
|
155
|
-
### 1.2.0 (
|
|
184
|
+
### 1.2.0 (2020-07-01)
|
|
156
185
|
|
|
157
186
|
#### Features
|
|
158
187
|
|
|
@@ -165,7 +194,7 @@
|
|
|
165
194
|
* [#796](https://github.com/ruby-grape/grape-swagger/pull/796): Support grape 1.4.0 - [@thedanielhanke](https://github.com/thedanielhanke).
|
|
166
195
|
|
|
167
196
|
|
|
168
|
-
### 1.1.0 (
|
|
197
|
+
### 1.1.0 (2020-04-20)
|
|
169
198
|
|
|
170
199
|
#### Features
|
|
171
200
|
|
|
@@ -174,7 +203,7 @@
|
|
|
174
203
|
* [#786](https://github.com/ruby-grape/grape-swagger/pull/786): Use full entity name as a default - [@mrexox](https://github.com/mrexox).
|
|
175
204
|
|
|
176
205
|
|
|
177
|
-
### 1.0.0 (
|
|
206
|
+
### 1.0.0 (2020-02-10)
|
|
178
207
|
|
|
179
208
|
#### Features
|
|
180
209
|
|
|
@@ -182,14 +211,14 @@
|
|
|
182
211
|
* [#775](https://github.com/ruby-grape/grape-swagger/pull/775): Add in token_owner support to param hidden procs - [@urkle](https://github.com/urkle).
|
|
183
212
|
|
|
184
213
|
|
|
185
|
-
### 0.34.2 (
|
|
214
|
+
### 0.34.2 (2020-01-20)
|
|
186
215
|
|
|
187
216
|
#### Fixes
|
|
188
217
|
|
|
189
218
|
* [#773](https://github.com/ruby-grape/grape-swagger/pull/773): Freeze rack version to 2.0.8 - [@LeFnord](https://github.com/LeFnord).
|
|
190
219
|
|
|
191
220
|
|
|
192
|
-
### 0.34.0 (
|
|
221
|
+
### 0.34.0 (2020-01-11)
|
|
193
222
|
|
|
194
223
|
#### Features
|
|
195
224
|
|
|
@@ -205,7 +234,7 @@
|
|
|
205
234
|
* [#764](https://github.com/ruby-grape/grape-swagger/pull/764): Fix root element for multi-word entities - [@bikolya](https://github.com/bikolya).
|
|
206
235
|
|
|
207
236
|
|
|
208
|
-
### 0.33.0 (
|
|
237
|
+
### 0.33.0 (2019-06-21)
|
|
209
238
|
|
|
210
239
|
#### Fixes
|
|
211
240
|
|
|
@@ -215,7 +244,7 @@
|
|
|
215
244
|
* [#737](https://github.com/ruby-grape/grape-swagger/pull/737): Add swagger endpoint guard to both doc endpoints - [@urkle](https://github.com/urkle).
|
|
216
245
|
|
|
217
246
|
|
|
218
|
-
### 0.32.1 (
|
|
247
|
+
### 0.32.1 (2018-12-07)
|
|
219
248
|
|
|
220
249
|
#### Fixes
|
|
221
250
|
|
|
@@ -223,7 +252,7 @@
|
|
|
223
252
|
* [#729](https://github.com/ruby-grape/grape-swagger/pull/729): Allow empty security array for endpoints - [@fotos](https://github.com/fotos).
|
|
224
253
|
|
|
225
254
|
|
|
226
|
-
### 0.32.0 (
|
|
255
|
+
### 0.32.0 (2018-11-26)
|
|
227
256
|
|
|
228
257
|
#### Features
|
|
229
258
|
|
|
@@ -234,14 +263,14 @@
|
|
|
234
263
|
* [#720](https://github.com/ruby-grape/grape-swagger/pull/720): Fix: corrected `termsOfService` field name in additional info - [@dblock](https://github.com/dblock).
|
|
235
264
|
|
|
236
265
|
|
|
237
|
-
### 0.31.1 (
|
|
266
|
+
### 0.31.1 (2018-10-23)
|
|
238
267
|
|
|
239
268
|
#### Features
|
|
240
269
|
|
|
241
270
|
* [#710](https://github.com/ruby-grape/grape-swagger/issues/710): Re-implement `api_documentation` and `specific_api_documentation` options - [@dblock](https://github.com/dblock).
|
|
242
271
|
|
|
243
272
|
|
|
244
|
-
### 0.31.0 (
|
|
273
|
+
### 0.31.0 (2018-08-22)
|
|
245
274
|
|
|
246
275
|
#### Features
|
|
247
276
|
|
|
@@ -252,14 +281,14 @@
|
|
|
252
281
|
* [#696](https://github.com/ruby-grape/grape-swagger/pull/696): Delegate required properties parsing to model parsers - [@Bugagazavr](https://github.com/Bugagazavr).
|
|
253
282
|
|
|
254
283
|
|
|
255
|
-
### 0.30.1 (
|
|
284
|
+
### 0.30.1 (2018-07-19)
|
|
256
285
|
|
|
257
286
|
#### Features
|
|
258
287
|
|
|
259
288
|
* [#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).
|
|
260
289
|
|
|
261
290
|
|
|
262
|
-
### 0.30.0 (
|
|
291
|
+
### 0.30.0 (2018-07-19)
|
|
263
292
|
|
|
264
293
|
#### Features
|
|
265
294
|
|
|
@@ -271,7 +300,7 @@
|
|
|
271
300
|
* [#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).
|
|
272
301
|
|
|
273
302
|
|
|
274
|
-
### 0.29.0 (
|
|
303
|
+
### 0.29.0 (2018-05-22)
|
|
275
304
|
|
|
276
305
|
#### Features
|
|
277
306
|
|
|
@@ -286,7 +315,7 @@
|
|
|
286
315
|
* [#672](https://github.com/ruby-grape/grape-swagger/pull/672): Rename 'notes' to 'detail' in README - [@kjleitz](https://github.com/kjleitz).
|
|
287
316
|
|
|
288
317
|
|
|
289
|
-
### 0.28.0 (
|
|
318
|
+
### 0.28.0 (2018-02-03)
|
|
290
319
|
|
|
291
320
|
#### Features
|
|
292
321
|
|
|
@@ -303,7 +332,7 @@
|
|
|
303
332
|
* [#656](https://github.com/ruby-grape/grape-swagger/pull/656): Fix `description` field may be null - [@soranoba](https://github.com/soranoba).
|
|
304
333
|
|
|
305
334
|
|
|
306
|
-
### 0.27.3 (
|
|
335
|
+
### 0.27.3 (2017-07-11)
|
|
307
336
|
|
|
308
337
|
#### Features
|
|
309
338
|
|
|
@@ -314,7 +343,7 @@
|
|
|
314
343
|
* [#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).
|
|
315
344
|
|
|
316
345
|
|
|
317
|
-
### 0.27.2 (
|
|
346
|
+
### 0.27.2 (2017-05-11)
|
|
318
347
|
|
|
319
348
|
#### Features
|
|
320
349
|
|
|
@@ -323,14 +352,14 @@
|
|
|
323
352
|
* [#607](https://github.com/ruby-grape/grape-swagger/pull/607): Allow body parameter name to be specified - [@tjwp](https://github.com/tjwp).
|
|
324
353
|
|
|
325
354
|
|
|
326
|
-
### 0.27.1 (
|
|
355
|
+
### 0.27.1 (2017-04-28)
|
|
327
356
|
|
|
328
357
|
#### Features
|
|
329
358
|
|
|
330
359
|
* [#602](https://github.com/ruby-grape/grape-swagger/pull/602): Allow security object to be defined - [@markevich](https://github.com/markevich).
|
|
331
360
|
|
|
332
361
|
|
|
333
|
-
### 0.27.0 (
|
|
362
|
+
### 0.27.0 (2017-03-27)
|
|
334
363
|
|
|
335
364
|
#### Features
|
|
336
365
|
|
|
@@ -346,7 +375,7 @@
|
|
|
346
375
|
* [#593](https://github.com/ruby-grape/grape-swagger/pull/593): Clarify hidden option in readme - [@thogg4](https://github.com/thogg4).
|
|
347
376
|
|
|
348
377
|
|
|
349
|
-
### 0.26.1 (
|
|
378
|
+
### 0.26.1 (2017-02-03)
|
|
350
379
|
|
|
351
380
|
#### Features
|
|
352
381
|
|
|
@@ -361,7 +390,7 @@
|
|
|
361
390
|
* [#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).
|
|
362
391
|
|
|
363
392
|
|
|
364
|
-
### 0.26.0 (
|
|
393
|
+
### 0.26.0 (2017-01-09)
|
|
365
394
|
|
|
366
395
|
#### Features
|
|
367
396
|
|
|
@@ -374,7 +403,7 @@
|
|
|
374
403
|
* [#561](https://github.com/ruby-grape/grape-swagger/pull/561): Rename failures to failure in readme - [@justincampbell](https://github.com/justincampbell).
|
|
375
404
|
|
|
376
405
|
|
|
377
|
-
### 0.25.3 (
|
|
406
|
+
### 0.25.3 (2016-12-18)
|
|
378
407
|
|
|
379
408
|
#### Features
|
|
380
409
|
|
|
@@ -388,14 +417,14 @@
|
|
|
388
417
|
* [#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).
|
|
389
418
|
|
|
390
419
|
|
|
391
|
-
### 0.25.2 (
|
|
420
|
+
### 0.25.2 (2016-11-30)
|
|
392
421
|
|
|
393
422
|
#### Fixes
|
|
394
423
|
|
|
395
424
|
* [#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).
|
|
396
425
|
|
|
397
426
|
|
|
398
|
-
### 0.25.1 (
|
|
427
|
+
### 0.25.1 (2016-11-29)
|
|
399
428
|
|
|
400
429
|
#### Features
|
|
401
430
|
|
|
@@ -408,7 +437,7 @@
|
|
|
408
437
|
* [#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).
|
|
409
438
|
|
|
410
439
|
|
|
411
|
-
### 0.25.0 (
|
|
440
|
+
### 0.25.0 (2016-10-31)
|
|
412
441
|
|
|
413
442
|
#### Features
|
|
414
443
|
|
|
@@ -424,7 +453,7 @@
|
|
|
424
453
|
* [#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).
|
|
425
454
|
|
|
426
455
|
|
|
427
|
-
### 0.24.0 (
|
|
456
|
+
### 0.24.0 (2016-09-23)
|
|
428
457
|
|
|
429
458
|
#### Features
|
|
430
459
|
|
|
@@ -443,7 +472,7 @@
|
|
|
443
472
|
* [#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).
|
|
444
473
|
|
|
445
474
|
|
|
446
|
-
### 0.23.0 (
|
|
475
|
+
### 0.23.0 (2016-08-05)
|
|
447
476
|
|
|
448
477
|
#### Features
|
|
449
478
|
|
|
@@ -459,7 +488,7 @@
|
|
|
459
488
|
* [#483](https://github.com/ruby-grape/grape-swagger/pull/483): Added support for nicknamed routes - [@pbendersky](https://github.com/pbendersky).
|
|
460
489
|
|
|
461
490
|
|
|
462
|
-
### 0.22.0 (
|
|
491
|
+
### 0.22.0 (2016-07-12)
|
|
463
492
|
|
|
464
493
|
#### Features
|
|
465
494
|
|
|
@@ -484,7 +513,7 @@
|
|
|
484
513
|
* [#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).
|
|
485
514
|
|
|
486
515
|
|
|
487
|
-
### 0.21.0 (
|
|
516
|
+
### 0.21.0 (2016-06-01)
|
|
488
517
|
|
|
489
518
|
#### Features
|
|
490
519
|
|
|
@@ -500,7 +529,7 @@
|
|
|
500
529
|
* [#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).
|
|
501
530
|
|
|
502
531
|
|
|
503
|
-
### 0.20.3 (
|
|
532
|
+
### 0.20.3 (2016-05-09)
|
|
504
533
|
|
|
505
534
|
#### Features
|
|
506
535
|
|
|
@@ -515,7 +544,7 @@
|
|
|
515
544
|
* [#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).
|
|
516
545
|
|
|
517
546
|
|
|
518
|
-
### 0.20.2 (
|
|
547
|
+
### 0.20.2 (2016-04-22)
|
|
519
548
|
|
|
520
549
|
#### Fixes
|
|
521
550
|
|
|
@@ -524,7 +553,7 @@
|
|
|
524
553
|
* [#389](https://github.com/ruby-grape/grape-swagger/pull/389): Respect X-Forwarded-Host - [@edvakf](https://github.com/edvakf).
|
|
525
554
|
|
|
526
555
|
|
|
527
|
-
### 0.20.1 (
|
|
556
|
+
### 0.20.1 (2016-04-17)
|
|
528
557
|
|
|
529
558
|
#### Features
|
|
530
559
|
|
|
@@ -536,7 +565,7 @@
|
|
|
536
565
|
* [#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).
|
|
537
566
|
|
|
538
567
|
|
|
539
|
-
### 0.20.0 (
|
|
568
|
+
### 0.20.0 (2016-04-09)
|
|
540
569
|
|
|
541
570
|
#### Features
|
|
542
571
|
|
|
@@ -550,12 +579,12 @@
|
|
|
550
579
|
* [#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).
|
|
551
580
|
|
|
552
581
|
|
|
553
|
-
### 0.10.5 (
|
|
582
|
+
### 0.10.5 (2016-04-12)
|
|
554
583
|
|
|
555
584
|
* [#344](https://github.com/ruby-grape/grape-swagger/pull/344): Namespace based tag included in Swagger JSON - [@LeFnord](https://github.com/LeFnord).
|
|
556
585
|
|
|
557
586
|
|
|
558
|
-
### 0.10.2 (
|
|
587
|
+
### 0.10.2 (2015-08-19)
|
|
559
588
|
|
|
560
589
|
#### Features
|
|
561
590
|
|
|
@@ -580,13 +609,13 @@
|
|
|
580
609
|
* [#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).
|
|
581
610
|
|
|
582
611
|
|
|
583
|
-
### 0.10.1 (
|
|
612
|
+
### 0.10.1 (2015-03-11)
|
|
584
613
|
|
|
585
614
|
* [#227](https://github.com/ruby-grape/grape-swagger/issues/227): Fix: nested routes under prefix not documented - [@dblock](https://github.com/dblock).
|
|
586
615
|
* [#226](https://github.com/ruby-grape/grape-swagger/issues/226): Fix: be defensive with nil exposure types - [@dblock](https://github.com/dblock).
|
|
587
616
|
|
|
588
617
|
|
|
589
|
-
### 0.10.0 (
|
|
618
|
+
### 0.10.0 (2015-03-10)
|
|
590
619
|
|
|
591
620
|
#### Features
|
|
592
621
|
|
|
@@ -606,7 +635,7 @@
|
|
|
606
635
|
* [#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).
|
|
607
636
|
|
|
608
637
|
|
|
609
|
-
### 0.9.0 (
|
|
638
|
+
### 0.9.0 (2014-12-19)
|
|
610
639
|
|
|
611
640
|
* [#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).
|
|
612
641
|
* [#154](https://github.com/ruby-grape/grape-swagger/pull/154): Allow classes for type declarations inside documentation - [@mrmargolis](https://github.com/mrmargolis).
|
|
@@ -621,7 +650,7 @@
|
|
|
621
650
|
* [#185](https://github.com/ruby-grape/grape-swagger/pull/185): Support strings in `Grape::Entity.expose`'s `:using` option - [@jhollinger](https://github.com/jhollinger).
|
|
622
651
|
|
|
623
652
|
|
|
624
|
-
### 0.8.0 (
|
|
653
|
+
### 0.8.0 (2014-08-30)
|
|
625
654
|
|
|
626
655
|
#### Features
|
|
627
656
|
|
|
@@ -651,7 +680,7 @@
|
|
|
651
680
|
* Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
|
|
652
681
|
|
|
653
682
|
|
|
654
|
-
### 0.7.2 (
|
|
683
|
+
### 0.7.2 (2014-02-06)
|
|
655
684
|
|
|
656
685
|
* [#84](https://github.com/ruby-grape/grape-swagger/pull/84): Markdown is now Github Flavored Markdown - [@jeromegn](https://github.com/jeromegn).
|
|
657
686
|
* [#83](https://github.com/ruby-grape/grape-swagger/pull/83): Improved support for nested Entity types - [@jeromegn](https://github.com/jeromegn).
|
|
@@ -669,7 +698,7 @@
|
|
|
669
698
|
* [#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).
|
|
670
699
|
|
|
671
700
|
|
|
672
|
-
### 0.6.0 (
|
|
701
|
+
### 0.6.0 (2013-06-19)
|
|
673
702
|
|
|
674
703
|
* Added Rails 4 support - [@jrhe](https://github.com/jrhe).
|
|
675
704
|
* Fix: document APIs at root level - [@dblock](https://github.com/dblock).
|
|
@@ -678,17 +707,17 @@
|
|
|
678
707
|
* Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
|
|
679
708
|
|
|
680
709
|
|
|
681
|
-
### 0.5.0 (
|
|
710
|
+
### 0.5.0 (2013-03-28)
|
|
682
711
|
|
|
683
712
|
* Added Grape 0.5.0 support - [@ruby-grape](https://github.com/ruby-grape).
|
|
684
713
|
|
|
685
714
|
|
|
686
|
-
### 0.4.0 (
|
|
715
|
+
### 0.4.0 (2013-03-28)
|
|
687
716
|
|
|
688
717
|
* Support https - [@cutalion](https://github.com/cutalion).
|
|
689
718
|
|
|
690
719
|
|
|
691
|
-
### 0.3.0 (
|
|
720
|
+
### 0.3.0 (2012-10-19)
|
|
692
721
|
|
|
693
722
|
* Added version support - [@agileanimal](https://github.com/agileanimal), [@fknappe](https://github.com/fknappe).
|
|
694
723
|
* Added support for nested parameters - [@ruby-grape](https://github.com/ruby-grape).
|
|
@@ -696,27 +725,27 @@
|
|
|
696
725
|
* Add possibility to hide the documentation paths in the generated swagger documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
697
726
|
|
|
698
727
|
|
|
699
|
-
### 0.2.1 (
|
|
728
|
+
### 0.2.1 (2012-08-17)
|
|
700
729
|
|
|
701
730
|
* Added support for markdown in notes field - [@ruby-grape](https://github.com/ruby-grape).
|
|
702
731
|
* Fix: compatibility with Rails - [@qwert666](https://github.com/qwert666).
|
|
703
732
|
* Fix: swagger UI history - [@ruby-grape](https://github.com/ruby-grape).
|
|
704
733
|
|
|
705
734
|
|
|
706
|
-
### 0.2.0 (
|
|
735
|
+
### 0.2.0 (2012-07-27)
|
|
707
736
|
|
|
708
737
|
* Use resource as root for swagger - [@ruby-grape](https://github.com/ruby-grape).
|
|
709
738
|
* Added support for file uploads, and proper `paramType` - [@ruby-grape](https://github.com/ruby-grape).
|
|
710
739
|
* Added tests - [@nathanvda](https://github.com/nathanvda).
|
|
711
740
|
|
|
712
741
|
|
|
713
|
-
### 0.1.0 (
|
|
742
|
+
### 0.1.0 (2012-07-19)
|
|
714
743
|
|
|
715
744
|
* Added some configurability to the generated documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
716
745
|
* Adapted to rails plugin structure - [@ruby-grape](https://github.com/ruby-grape).
|
|
717
746
|
* Allowed cross origin, so swagger can be used from official site - [@ruby-grape](https://github.com/ruby-grape).
|
|
718
747
|
|
|
719
748
|
|
|
720
|
-
### 0.0.0 (
|
|
749
|
+
### 0.0.0 (2012-07-19)
|
|
721
750
|
|
|
722
751
|
* Initial public release - [@ruby-grape](https://github.com/ruby-grape).
|