grape-swagger 2.1.2 → 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 +111 -107
- data/README.md +150 -29
- data/RELEASING.md +8 -8
- data/grape-swagger.gemspec +1 -2
- 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 +17 -43
- data/lib/grape-swagger/errors.rb +2 -0
- 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 +10 -21
- 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,15 +1,20 @@
|
|
|
1
|
-
###
|
|
1
|
+
### 2.1.3 (2025-11-21)
|
|
2
2
|
|
|
3
3
|
#### Features
|
|
4
4
|
|
|
5
|
-
*
|
|
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).
|
|
6
10
|
|
|
7
11
|
#### Fixes
|
|
8
12
|
|
|
9
|
-
*
|
|
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).
|
|
10
16
|
|
|
11
|
-
|
|
12
|
-
### 2.1.2 (Jan 7, 2025)
|
|
17
|
+
### 2.1.2 (2025-01-07)
|
|
13
18
|
|
|
14
19
|
#### Features
|
|
15
20
|
|
|
@@ -17,130 +22,129 @@
|
|
|
17
22
|
|
|
18
23
|
#### Fixes
|
|
19
24
|
|
|
20
|
-
* [#943](https://github.com/ruby-grape/grape-swagger/pull/943): Fix route_param documentation and type - [@4ndv](https://github.com/4ndv)
|
|
21
|
-
* [#944](https://github.com/ruby-grape/grape-swagger/pull/944): Amend a few typographic errors - [@pieterocp](https://github.com/pieterocp)
|
|
22
|
-
* Your contribution here.
|
|
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).
|
|
23
27
|
|
|
24
28
|
|
|
25
|
-
### 2.1.1 (
|
|
29
|
+
### 2.1.1 (2024-09-21)
|
|
26
30
|
|
|
27
31
|
#### Fixes
|
|
28
32
|
|
|
29
|
-
* [#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).
|
|
30
34
|
|
|
31
35
|
|
|
32
|
-
### 2.1.0 (
|
|
36
|
+
### 2.1.0 (2024-05-14)
|
|
33
37
|
|
|
34
38
|
#### Features
|
|
35
39
|
|
|
36
|
-
* [#927](https://github.com/ruby-grape/grape-swagger/pull/927): Set default parameter location based on consumes - [@spaceraccoon](https://github.com/spaceraccoon)
|
|
37
|
-
* [#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).
|
|
38
42
|
|
|
39
43
|
#### Fixes
|
|
40
44
|
|
|
41
|
-
* [#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).
|
|
42
46
|
|
|
43
47
|
|
|
44
|
-
### 2.0.3 (
|
|
48
|
+
### 2.0.3 (2024-04-26)
|
|
45
49
|
|
|
46
50
|
#### Fixes
|
|
47
51
|
|
|
48
|
-
* [#922](https://github.com/ruby-grape/grape-swagger/pull/922): Force request body to be an schema object - [@numbata](https://github.com/numbata)
|
|
49
|
-
* [#923](https://github.com/ruby-grape/grape-swagger/pull/923): Enabled schema definitions for body parameters in DELETE requests - [@numbata](https://github.com/numbata)
|
|
50
|
-
* [#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).
|
|
51
55
|
|
|
52
56
|
|
|
53
|
-
### 2.0.2 (
|
|
57
|
+
### 2.0.2 (2024-02-02)
|
|
54
58
|
|
|
55
59
|
#### Fixes
|
|
56
60
|
|
|
57
|
-
* [#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).
|
|
58
62
|
|
|
59
63
|
|
|
60
|
-
### 2.0.1 (
|
|
64
|
+
### 2.0.1 (2024-01-02)
|
|
61
65
|
|
|
62
66
|
#### Features
|
|
63
67
|
|
|
64
|
-
* [#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).
|
|
65
69
|
|
|
66
70
|
#### Fixes
|
|
67
71
|
|
|
68
|
-
* [#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).
|
|
69
73
|
|
|
70
74
|
|
|
71
|
-
### 2.0.0 (
|
|
75
|
+
### 2.0.0 (2023-11-07)
|
|
72
76
|
|
|
73
77
|
#### Features
|
|
74
78
|
|
|
75
|
-
* [#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).
|
|
76
80
|
|
|
77
81
|
#### Fixes
|
|
78
82
|
|
|
79
|
-
* [#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).
|
|
80
84
|
|
|
81
85
|
|
|
82
|
-
### 1.6.1 (
|
|
86
|
+
### 1.6.1 (2023-05-21)
|
|
83
87
|
|
|
84
88
|
#### Fixes
|
|
85
89
|
|
|
86
|
-
* [#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).
|
|
87
91
|
|
|
88
92
|
|
|
89
|
-
### 1.6.0 (
|
|
93
|
+
### 1.6.0 (2023-03-19)
|
|
90
94
|
|
|
91
95
|
#### Features
|
|
92
96
|
|
|
93
|
-
* [#872](https://github.com/ruby-grape/grape-swagger/pull/872): Add `consumes` and `produces` options to `add_swagger_documentation` - [@spaceraccoon](https://github.com/spaceraccoon)
|
|
94
|
-
* [#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).
|
|
95
99
|
|
|
96
100
|
|
|
97
|
-
### 1.5.0 (
|
|
101
|
+
### 1.5.0 (2022-07-28)
|
|
98
102
|
|
|
99
103
|
#### Features
|
|
100
104
|
|
|
101
|
-
* [#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-).
|
|
102
106
|
|
|
103
107
|
#### Fixes
|
|
104
108
|
|
|
105
|
-
* [#860](https://github.com/ruby-grape/grape-swagger/pull/860)
|
|
106
|
-
* [#843](https://github.com/ruby-grape/grape-swagger/pull/843) Syntax errors in README.md examples [@remvee](https://github.com/remvee)
|
|
107
|
-
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844) Fixes the regexp used for parsing routes [@senhalil](https://github.com/senhalil)
|
|
108
|
-
* [#847](https://github.com/ruby-grape/grape-swagger/pull/847) Parse route_param type for nested endpoints [@dmoss18](https://github.com/dmoss18)
|
|
109
|
-
* [#856](https://github.com/ruby-grape/grape-swagger/pull/856) Remove unused methods in GrapeSwagger::DocMethods::BuildModelDefinition [@takahashim](https://github.com/takahashim)
|
|
110
|
-
* [#858](https://github.com/ruby-grape/grape-swagger/pull/858): Set permissions for GitHub actions [@naveensrinivasan](https://github.com/naveensrinivasan)
|
|
111
|
-
* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick to support Ruby 3.x [@takahashim](https://github.com/takahashim)
|
|
112
|
-
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work [@takahashim](https://github.com/takahashim)
|
|
113
|
-
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Refactor oapi fetch task [@Vachman](https://github.com/Vachman)
|
|
114
|
-
* [#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).
|
|
115
119
|
|
|
116
|
-
### 1.4.3 (
|
|
120
|
+
### 1.4.3 (2022-01-05)
|
|
117
121
|
|
|
118
122
|
#### Fixes
|
|
119
123
|
|
|
120
|
-
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of `enum` to be `Array` - [@takahashim](https://github.com/takahashim)
|
|
121
|
-
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Fixes oapi rake tasks, allows generating sepcs for different API versions.
|
|
122
|
-
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work without error - [@takahashim](https://github.com/takahashim)
|
|
123
|
-
* [#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)
|
|
124
|
-
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil)
|
|
125
|
-
* [#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-).
|
|
126
130
|
|
|
127
|
-
### 1.4.2 (
|
|
131
|
+
### 1.4.2 (2021-10-22)
|
|
128
132
|
|
|
129
133
|
#### Fixes
|
|
130
134
|
|
|
131
|
-
* [#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-)
|
|
132
|
-
* [#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-)
|
|
133
|
-
* [#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-).
|
|
134
138
|
|
|
135
139
|
|
|
136
|
-
### 1.4.1 (
|
|
140
|
+
### 1.4.1 (2021-09-15)
|
|
137
141
|
|
|
138
142
|
#### Fixes
|
|
139
143
|
|
|
140
|
-
* [#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).
|
|
141
145
|
|
|
142
146
|
|
|
143
|
-
### 1.4.0 (
|
|
147
|
+
### 1.4.0 (2021-03-20)
|
|
144
148
|
|
|
145
149
|
#### Features
|
|
146
150
|
|
|
@@ -152,7 +156,7 @@
|
|
|
152
156
|
* [#822](https://github.com/ruby-grape/grape-swagger/pull/822): Corrected the related parameter lookup on request params - [@Jack12816](https://github.com/Jack12816).
|
|
153
157
|
|
|
154
158
|
|
|
155
|
-
### 1.3.1 (
|
|
159
|
+
### 1.3.1 (2020-11-01)
|
|
156
160
|
|
|
157
161
|
#### Features
|
|
158
162
|
|
|
@@ -163,21 +167,21 @@
|
|
|
163
167
|
* [#811](https://github.com/ruby-grape/grape-swagger/pull/811): Fixes #809: supports utf8 route names - [@LeFnord](https://github.com/LeFnord).
|
|
164
168
|
|
|
165
169
|
|
|
166
|
-
### 1.3.0 (
|
|
170
|
+
### 1.3.0 (2020-09-03)
|
|
167
171
|
|
|
168
172
|
#### Features
|
|
169
173
|
|
|
170
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).
|
|
171
175
|
|
|
172
176
|
|
|
173
|
-
### 1.2.1 (
|
|
177
|
+
### 1.2.1 (2020-07-15)
|
|
174
178
|
|
|
175
179
|
#### Fixes
|
|
176
180
|
|
|
177
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).
|
|
178
182
|
|
|
179
183
|
|
|
180
|
-
### 1.2.0 (
|
|
184
|
+
### 1.2.0 (2020-07-01)
|
|
181
185
|
|
|
182
186
|
#### Features
|
|
183
187
|
|
|
@@ -190,7 +194,7 @@
|
|
|
190
194
|
* [#796](https://github.com/ruby-grape/grape-swagger/pull/796): Support grape 1.4.0 - [@thedanielhanke](https://github.com/thedanielhanke).
|
|
191
195
|
|
|
192
196
|
|
|
193
|
-
### 1.1.0 (
|
|
197
|
+
### 1.1.0 (2020-04-20)
|
|
194
198
|
|
|
195
199
|
#### Features
|
|
196
200
|
|
|
@@ -199,7 +203,7 @@
|
|
|
199
203
|
* [#786](https://github.com/ruby-grape/grape-swagger/pull/786): Use full entity name as a default - [@mrexox](https://github.com/mrexox).
|
|
200
204
|
|
|
201
205
|
|
|
202
|
-
### 1.0.0 (
|
|
206
|
+
### 1.0.0 (2020-02-10)
|
|
203
207
|
|
|
204
208
|
#### Features
|
|
205
209
|
|
|
@@ -207,14 +211,14 @@
|
|
|
207
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).
|
|
208
212
|
|
|
209
213
|
|
|
210
|
-
### 0.34.2 (
|
|
214
|
+
### 0.34.2 (2020-01-20)
|
|
211
215
|
|
|
212
216
|
#### Fixes
|
|
213
217
|
|
|
214
218
|
* [#773](https://github.com/ruby-grape/grape-swagger/pull/773): Freeze rack version to 2.0.8 - [@LeFnord](https://github.com/LeFnord).
|
|
215
219
|
|
|
216
220
|
|
|
217
|
-
### 0.34.0 (
|
|
221
|
+
### 0.34.0 (2020-01-11)
|
|
218
222
|
|
|
219
223
|
#### Features
|
|
220
224
|
|
|
@@ -230,7 +234,7 @@
|
|
|
230
234
|
* [#764](https://github.com/ruby-grape/grape-swagger/pull/764): Fix root element for multi-word entities - [@bikolya](https://github.com/bikolya).
|
|
231
235
|
|
|
232
236
|
|
|
233
|
-
### 0.33.0 (
|
|
237
|
+
### 0.33.0 (2019-06-21)
|
|
234
238
|
|
|
235
239
|
#### Fixes
|
|
236
240
|
|
|
@@ -240,7 +244,7 @@
|
|
|
240
244
|
* [#737](https://github.com/ruby-grape/grape-swagger/pull/737): Add swagger endpoint guard to both doc endpoints - [@urkle](https://github.com/urkle).
|
|
241
245
|
|
|
242
246
|
|
|
243
|
-
### 0.32.1 (
|
|
247
|
+
### 0.32.1 (2018-12-07)
|
|
244
248
|
|
|
245
249
|
#### Fixes
|
|
246
250
|
|
|
@@ -248,7 +252,7 @@
|
|
|
248
252
|
* [#729](https://github.com/ruby-grape/grape-swagger/pull/729): Allow empty security array for endpoints - [@fotos](https://github.com/fotos).
|
|
249
253
|
|
|
250
254
|
|
|
251
|
-
### 0.32.0 (
|
|
255
|
+
### 0.32.0 (2018-11-26)
|
|
252
256
|
|
|
253
257
|
#### Features
|
|
254
258
|
|
|
@@ -259,14 +263,14 @@
|
|
|
259
263
|
* [#720](https://github.com/ruby-grape/grape-swagger/pull/720): Fix: corrected `termsOfService` field name in additional info - [@dblock](https://github.com/dblock).
|
|
260
264
|
|
|
261
265
|
|
|
262
|
-
### 0.31.1 (
|
|
266
|
+
### 0.31.1 (2018-10-23)
|
|
263
267
|
|
|
264
268
|
#### Features
|
|
265
269
|
|
|
266
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).
|
|
267
271
|
|
|
268
272
|
|
|
269
|
-
### 0.31.0 (
|
|
273
|
+
### 0.31.0 (2018-08-22)
|
|
270
274
|
|
|
271
275
|
#### Features
|
|
272
276
|
|
|
@@ -277,14 +281,14 @@
|
|
|
277
281
|
* [#696](https://github.com/ruby-grape/grape-swagger/pull/696): Delegate required properties parsing to model parsers - [@Bugagazavr](https://github.com/Bugagazavr).
|
|
278
282
|
|
|
279
283
|
|
|
280
|
-
### 0.30.1 (
|
|
284
|
+
### 0.30.1 (2018-07-19)
|
|
281
285
|
|
|
282
286
|
#### Features
|
|
283
287
|
|
|
284
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).
|
|
285
289
|
|
|
286
290
|
|
|
287
|
-
### 0.30.0 (
|
|
291
|
+
### 0.30.0 (2018-07-19)
|
|
288
292
|
|
|
289
293
|
#### Features
|
|
290
294
|
|
|
@@ -296,7 +300,7 @@
|
|
|
296
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).
|
|
297
301
|
|
|
298
302
|
|
|
299
|
-
### 0.29.0 (
|
|
303
|
+
### 0.29.0 (2018-05-22)
|
|
300
304
|
|
|
301
305
|
#### Features
|
|
302
306
|
|
|
@@ -311,7 +315,7 @@
|
|
|
311
315
|
* [#672](https://github.com/ruby-grape/grape-swagger/pull/672): Rename 'notes' to 'detail' in README - [@kjleitz](https://github.com/kjleitz).
|
|
312
316
|
|
|
313
317
|
|
|
314
|
-
### 0.28.0 (
|
|
318
|
+
### 0.28.0 (2018-02-03)
|
|
315
319
|
|
|
316
320
|
#### Features
|
|
317
321
|
|
|
@@ -328,7 +332,7 @@
|
|
|
328
332
|
* [#656](https://github.com/ruby-grape/grape-swagger/pull/656): Fix `description` field may be null - [@soranoba](https://github.com/soranoba).
|
|
329
333
|
|
|
330
334
|
|
|
331
|
-
### 0.27.3 (
|
|
335
|
+
### 0.27.3 (2017-07-11)
|
|
332
336
|
|
|
333
337
|
#### Features
|
|
334
338
|
|
|
@@ -339,7 +343,7 @@
|
|
|
339
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).
|
|
340
344
|
|
|
341
345
|
|
|
342
|
-
### 0.27.2 (
|
|
346
|
+
### 0.27.2 (2017-05-11)
|
|
343
347
|
|
|
344
348
|
#### Features
|
|
345
349
|
|
|
@@ -348,14 +352,14 @@
|
|
|
348
352
|
* [#607](https://github.com/ruby-grape/grape-swagger/pull/607): Allow body parameter name to be specified - [@tjwp](https://github.com/tjwp).
|
|
349
353
|
|
|
350
354
|
|
|
351
|
-
### 0.27.1 (
|
|
355
|
+
### 0.27.1 (2017-04-28)
|
|
352
356
|
|
|
353
357
|
#### Features
|
|
354
358
|
|
|
355
359
|
* [#602](https://github.com/ruby-grape/grape-swagger/pull/602): Allow security object to be defined - [@markevich](https://github.com/markevich).
|
|
356
360
|
|
|
357
361
|
|
|
358
|
-
### 0.27.0 (
|
|
362
|
+
### 0.27.0 (2017-03-27)
|
|
359
363
|
|
|
360
364
|
#### Features
|
|
361
365
|
|
|
@@ -371,7 +375,7 @@
|
|
|
371
375
|
* [#593](https://github.com/ruby-grape/grape-swagger/pull/593): Clarify hidden option in readme - [@thogg4](https://github.com/thogg4).
|
|
372
376
|
|
|
373
377
|
|
|
374
|
-
### 0.26.1 (
|
|
378
|
+
### 0.26.1 (2017-02-03)
|
|
375
379
|
|
|
376
380
|
#### Features
|
|
377
381
|
|
|
@@ -386,7 +390,7 @@
|
|
|
386
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).
|
|
387
391
|
|
|
388
392
|
|
|
389
|
-
### 0.26.0 (
|
|
393
|
+
### 0.26.0 (2017-01-09)
|
|
390
394
|
|
|
391
395
|
#### Features
|
|
392
396
|
|
|
@@ -399,7 +403,7 @@
|
|
|
399
403
|
* [#561](https://github.com/ruby-grape/grape-swagger/pull/561): Rename failures to failure in readme - [@justincampbell](https://github.com/justincampbell).
|
|
400
404
|
|
|
401
405
|
|
|
402
|
-
### 0.25.3 (
|
|
406
|
+
### 0.25.3 (2016-12-18)
|
|
403
407
|
|
|
404
408
|
#### Features
|
|
405
409
|
|
|
@@ -413,14 +417,14 @@
|
|
|
413
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).
|
|
414
418
|
|
|
415
419
|
|
|
416
|
-
### 0.25.2 (
|
|
420
|
+
### 0.25.2 (2016-11-30)
|
|
417
421
|
|
|
418
422
|
#### Fixes
|
|
419
423
|
|
|
420
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).
|
|
421
425
|
|
|
422
426
|
|
|
423
|
-
### 0.25.1 (
|
|
427
|
+
### 0.25.1 (2016-11-29)
|
|
424
428
|
|
|
425
429
|
#### Features
|
|
426
430
|
|
|
@@ -433,7 +437,7 @@
|
|
|
433
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).
|
|
434
438
|
|
|
435
439
|
|
|
436
|
-
### 0.25.0 (
|
|
440
|
+
### 0.25.0 (2016-10-31)
|
|
437
441
|
|
|
438
442
|
#### Features
|
|
439
443
|
|
|
@@ -449,7 +453,7 @@
|
|
|
449
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).
|
|
450
454
|
|
|
451
455
|
|
|
452
|
-
### 0.24.0 (
|
|
456
|
+
### 0.24.0 (2016-09-23)
|
|
453
457
|
|
|
454
458
|
#### Features
|
|
455
459
|
|
|
@@ -468,7 +472,7 @@
|
|
|
468
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).
|
|
469
473
|
|
|
470
474
|
|
|
471
|
-
### 0.23.0 (
|
|
475
|
+
### 0.23.0 (2016-08-05)
|
|
472
476
|
|
|
473
477
|
#### Features
|
|
474
478
|
|
|
@@ -484,7 +488,7 @@
|
|
|
484
488
|
* [#483](https://github.com/ruby-grape/grape-swagger/pull/483): Added support for nicknamed routes - [@pbendersky](https://github.com/pbendersky).
|
|
485
489
|
|
|
486
490
|
|
|
487
|
-
### 0.22.0 (
|
|
491
|
+
### 0.22.0 (2016-07-12)
|
|
488
492
|
|
|
489
493
|
#### Features
|
|
490
494
|
|
|
@@ -509,7 +513,7 @@
|
|
|
509
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).
|
|
510
514
|
|
|
511
515
|
|
|
512
|
-
### 0.21.0 (
|
|
516
|
+
### 0.21.0 (2016-06-01)
|
|
513
517
|
|
|
514
518
|
#### Features
|
|
515
519
|
|
|
@@ -525,7 +529,7 @@
|
|
|
525
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).
|
|
526
530
|
|
|
527
531
|
|
|
528
|
-
### 0.20.3 (
|
|
532
|
+
### 0.20.3 (2016-05-09)
|
|
529
533
|
|
|
530
534
|
#### Features
|
|
531
535
|
|
|
@@ -540,7 +544,7 @@
|
|
|
540
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).
|
|
541
545
|
|
|
542
546
|
|
|
543
|
-
### 0.20.2 (
|
|
547
|
+
### 0.20.2 (2016-04-22)
|
|
544
548
|
|
|
545
549
|
#### Fixes
|
|
546
550
|
|
|
@@ -549,7 +553,7 @@
|
|
|
549
553
|
* [#389](https://github.com/ruby-grape/grape-swagger/pull/389): Respect X-Forwarded-Host - [@edvakf](https://github.com/edvakf).
|
|
550
554
|
|
|
551
555
|
|
|
552
|
-
### 0.20.1 (
|
|
556
|
+
### 0.20.1 (2016-04-17)
|
|
553
557
|
|
|
554
558
|
#### Features
|
|
555
559
|
|
|
@@ -561,7 +565,7 @@
|
|
|
561
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).
|
|
562
566
|
|
|
563
567
|
|
|
564
|
-
### 0.20.0 (
|
|
568
|
+
### 0.20.0 (2016-04-09)
|
|
565
569
|
|
|
566
570
|
#### Features
|
|
567
571
|
|
|
@@ -575,12 +579,12 @@
|
|
|
575
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).
|
|
576
580
|
|
|
577
581
|
|
|
578
|
-
### 0.10.5 (
|
|
582
|
+
### 0.10.5 (2016-04-12)
|
|
579
583
|
|
|
580
584
|
* [#344](https://github.com/ruby-grape/grape-swagger/pull/344): Namespace based tag included in Swagger JSON - [@LeFnord](https://github.com/LeFnord).
|
|
581
585
|
|
|
582
586
|
|
|
583
|
-
### 0.10.2 (
|
|
587
|
+
### 0.10.2 (2015-08-19)
|
|
584
588
|
|
|
585
589
|
#### Features
|
|
586
590
|
|
|
@@ -605,13 +609,13 @@
|
|
|
605
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).
|
|
606
610
|
|
|
607
611
|
|
|
608
|
-
### 0.10.1 (
|
|
612
|
+
### 0.10.1 (2015-03-11)
|
|
609
613
|
|
|
610
614
|
* [#227](https://github.com/ruby-grape/grape-swagger/issues/227): Fix: nested routes under prefix not documented - [@dblock](https://github.com/dblock).
|
|
611
615
|
* [#226](https://github.com/ruby-grape/grape-swagger/issues/226): Fix: be defensive with nil exposure types - [@dblock](https://github.com/dblock).
|
|
612
616
|
|
|
613
617
|
|
|
614
|
-
### 0.10.0 (
|
|
618
|
+
### 0.10.0 (2015-03-10)
|
|
615
619
|
|
|
616
620
|
#### Features
|
|
617
621
|
|
|
@@ -631,7 +635,7 @@
|
|
|
631
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).
|
|
632
636
|
|
|
633
637
|
|
|
634
|
-
### 0.9.0 (
|
|
638
|
+
### 0.9.0 (2014-12-19)
|
|
635
639
|
|
|
636
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).
|
|
637
641
|
* [#154](https://github.com/ruby-grape/grape-swagger/pull/154): Allow classes for type declarations inside documentation - [@mrmargolis](https://github.com/mrmargolis).
|
|
@@ -646,7 +650,7 @@
|
|
|
646
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).
|
|
647
651
|
|
|
648
652
|
|
|
649
|
-
### 0.8.0 (
|
|
653
|
+
### 0.8.0 (2014-08-30)
|
|
650
654
|
|
|
651
655
|
#### Features
|
|
652
656
|
|
|
@@ -676,7 +680,7 @@
|
|
|
676
680
|
* Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
|
|
677
681
|
|
|
678
682
|
|
|
679
|
-
### 0.7.2 (
|
|
683
|
+
### 0.7.2 (2014-02-06)
|
|
680
684
|
|
|
681
685
|
* [#84](https://github.com/ruby-grape/grape-swagger/pull/84): Markdown is now Github Flavored Markdown - [@jeromegn](https://github.com/jeromegn).
|
|
682
686
|
* [#83](https://github.com/ruby-grape/grape-swagger/pull/83): Improved support for nested Entity types - [@jeromegn](https://github.com/jeromegn).
|
|
@@ -694,7 +698,7 @@
|
|
|
694
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).
|
|
695
699
|
|
|
696
700
|
|
|
697
|
-
### 0.6.0 (
|
|
701
|
+
### 0.6.0 (2013-06-19)
|
|
698
702
|
|
|
699
703
|
* Added Rails 4 support - [@jrhe](https://github.com/jrhe).
|
|
700
704
|
* Fix: document APIs at root level - [@dblock](https://github.com/dblock).
|
|
@@ -703,17 +707,17 @@
|
|
|
703
707
|
* Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
|
|
704
708
|
|
|
705
709
|
|
|
706
|
-
### 0.5.0 (
|
|
710
|
+
### 0.5.0 (2013-03-28)
|
|
707
711
|
|
|
708
712
|
* Added Grape 0.5.0 support - [@ruby-grape](https://github.com/ruby-grape).
|
|
709
713
|
|
|
710
714
|
|
|
711
|
-
### 0.4.0 (
|
|
715
|
+
### 0.4.0 (2013-03-28)
|
|
712
716
|
|
|
713
717
|
* Support https - [@cutalion](https://github.com/cutalion).
|
|
714
718
|
|
|
715
719
|
|
|
716
|
-
### 0.3.0 (
|
|
720
|
+
### 0.3.0 (2012-10-19)
|
|
717
721
|
|
|
718
722
|
* Added version support - [@agileanimal](https://github.com/agileanimal), [@fknappe](https://github.com/fknappe).
|
|
719
723
|
* Added support for nested parameters - [@ruby-grape](https://github.com/ruby-grape).
|
|
@@ -721,27 +725,27 @@
|
|
|
721
725
|
* Add possibility to hide the documentation paths in the generated swagger documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
722
726
|
|
|
723
727
|
|
|
724
|
-
### 0.2.1 (
|
|
728
|
+
### 0.2.1 (2012-08-17)
|
|
725
729
|
|
|
726
730
|
* Added support for markdown in notes field - [@ruby-grape](https://github.com/ruby-grape).
|
|
727
731
|
* Fix: compatibility with Rails - [@qwert666](https://github.com/qwert666).
|
|
728
732
|
* Fix: swagger UI history - [@ruby-grape](https://github.com/ruby-grape).
|
|
729
733
|
|
|
730
734
|
|
|
731
|
-
### 0.2.0 (
|
|
735
|
+
### 0.2.0 (2012-07-27)
|
|
732
736
|
|
|
733
737
|
* Use resource as root for swagger - [@ruby-grape](https://github.com/ruby-grape).
|
|
734
738
|
* Added support for file uploads, and proper `paramType` - [@ruby-grape](https://github.com/ruby-grape).
|
|
735
739
|
* Added tests - [@nathanvda](https://github.com/nathanvda).
|
|
736
740
|
|
|
737
741
|
|
|
738
|
-
### 0.1.0 (
|
|
742
|
+
### 0.1.0 (2012-07-19)
|
|
739
743
|
|
|
740
744
|
* Added some configurability to the generated documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
741
745
|
* Adapted to rails plugin structure - [@ruby-grape](https://github.com/ruby-grape).
|
|
742
746
|
* Allowed cross origin, so swagger can be used from official site - [@ruby-grape](https://github.com/ruby-grape).
|
|
743
747
|
|
|
744
748
|
|
|
745
|
-
### 0.0.0 (
|
|
749
|
+
### 0.0.0 (2012-07-19)
|
|
746
750
|
|
|
747
751
|
* Initial public release - [@ruby-grape](https://github.com/ruby-grape).
|