grape-swagger 2.1.2 → 2.1.4
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 +121 -106
- data/CLAUDE.md +88 -0
- 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 +19 -45
- 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 +15 -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: 7d2c2cc9aaea81baa5c7796897dd104559e7e8aa57020097fe899e35a21287cd
|
|
4
|
+
data.tar.gz: f8451dde88f7b7af02ff90f59cdd66ed7d5d8ff34b318be91f1e2ac6767c865f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a627ebc160edef37753bbfe3c049ece8426195d3a1d08a26a4fef7f6f2a0b8f0a49b250be74cca0d096e277c46a041c56a6f4e336ccf1aa0f09ec5a9037f6edb
|
|
7
|
+
data.tar.gz: 2ebf30ff9123454a77151a48a3f55f4d301a15e984c0dea2fd8ee92867a254d28581546796e629cbd94bb362e0902e4c80574b88be01b75df625c95bd7b0324c
|
data/CHANGELOG.md
CHANGED
|
@@ -1,15 +1,31 @@
|
|
|
1
|
-
###
|
|
1
|
+
### 2.1.4 (2026-02-02)
|
|
2
2
|
|
|
3
3
|
#### Features
|
|
4
4
|
|
|
5
|
-
*
|
|
5
|
+
* [#970](https://github.com/ruby-grape/grape-swagger/pull/970): Migrate Danger to use danger-pr-comment workflow - [@dblock](https://github.com/dblock).
|
|
6
|
+
* [#972](https://github.com/ruby-grape/grape-swagger/pull/972): Add weekly scheduled workflow to test against Grape HEAD - [@numbata](https://github.com/numbata).
|
|
6
7
|
|
|
7
8
|
#### Fixes
|
|
8
9
|
|
|
9
|
-
*
|
|
10
|
+
* [#972](https://github.com/ruby-grape/grape-swagger/pull/972): Grape 3.1.0 and grape-swagger-entity 0.7.1 compatibility - [@numbata](https://github.com/numbata).
|
|
10
11
|
|
|
12
|
+
### 2.1.3 (2025-11-21)
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
#### Features
|
|
15
|
+
|
|
16
|
+
* [#956](https://github.com/ruby-grape/grape-swagger/pull/956): Add `danger` - [@numbata](https://github.com/numbata).
|
|
17
|
+
* [#958](https://github.com/ruby-grape/grape-swagger/pull/958): Drop ruby-head from test matrix - [@numbata](https://github.com/numbata).
|
|
18
|
+
* [#953](https://github.com/ruby-grape/grape-swagger/pull/953): Added `super_diff` - [@numbata](https://github.com/numbata).
|
|
19
|
+
* [#951](https://github.com/ruby-grape/grape-swagger/pull/951): Use `x-example` for non-body parameters - [@olivier-thatch](https://github.com/olivier-thatch).
|
|
20
|
+
* [#963](https://github.com/ruby-grape/grape-swagger/pull/963): Allow empty model definitions for swagger 2.0 - [@numbata](https://github.com/numbata).
|
|
21
|
+
|
|
22
|
+
#### Fixes
|
|
23
|
+
|
|
24
|
+
* [#966](https://github.com/ruby-grape/grape-swagger/pull/966): Grape 3.0 compatibility - [@numbata](https://github.com/numbata).
|
|
25
|
+
* [#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).
|
|
26
|
+
* [#948](https://github.com/ruby-grape/grape-swagger/pull/948): Grape 2.3.0 and Ruby 3.5 compatibility - [@numbata](https://github.com/numbata).
|
|
27
|
+
|
|
28
|
+
### 2.1.2 (2025-01-07)
|
|
13
29
|
|
|
14
30
|
#### Features
|
|
15
31
|
|
|
@@ -17,130 +33,129 @@
|
|
|
17
33
|
|
|
18
34
|
#### Fixes
|
|
19
35
|
|
|
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.
|
|
36
|
+
* [#943](https://github.com/ruby-grape/grape-swagger/pull/943): Fix route_param documentation and type - [@4ndv](https://github.com/4ndv).
|
|
37
|
+
* [#944](https://github.com/ruby-grape/grape-swagger/pull/944): Amend a few typographic errors - [@pieterocp](https://github.com/pieterocp).
|
|
23
38
|
|
|
24
39
|
|
|
25
|
-
### 2.1.1 (
|
|
40
|
+
### 2.1.1 (2024-09-21)
|
|
26
41
|
|
|
27
42
|
#### Fixes
|
|
28
43
|
|
|
29
|
-
* [#940](https://github.com/ruby-grape/grape-swagger/pull/940): Grape 2.2.0 compatibility - [@padde](https://github.com/padde)
|
|
44
|
+
* [#940](https://github.com/ruby-grape/grape-swagger/pull/940): Grape 2.2.0 compatibility - [@padde](https://github.com/padde).
|
|
30
45
|
|
|
31
46
|
|
|
32
|
-
### 2.1.0 (
|
|
47
|
+
### 2.1.0 (2024-05-14)
|
|
33
48
|
|
|
34
49
|
#### Features
|
|
35
50
|
|
|
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)
|
|
51
|
+
* [#927](https://github.com/ruby-grape/grape-swagger/pull/927): Set default parameter location based on consumes - [@spaceraccoon](https://github.com/spaceraccoon).
|
|
52
|
+
* [#929](https://github.com/ruby-grape/grape-swagger/pull/929): Set query parameter for array of primitive types - [@spaceraccoon](https://github.com/spaceraccoon).
|
|
38
53
|
|
|
39
54
|
#### Fixes
|
|
40
55
|
|
|
41
|
-
* [#926](https://github.com/ruby-grape/grape-swagger/pull/926): Refactor route and namespace combination logic - [@numbata](https://github.com/numbata)
|
|
56
|
+
* [#926](https://github.com/ruby-grape/grape-swagger/pull/926): Refactor route and namespace combination logic - [@numbata](https://github.com/numbata).
|
|
42
57
|
|
|
43
58
|
|
|
44
|
-
### 2.0.3 (
|
|
59
|
+
### 2.0.3 (2024-04-26)
|
|
45
60
|
|
|
46
61
|
#### Fixes
|
|
47
62
|
|
|
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):
|
|
63
|
+
* [#922](https://github.com/ruby-grape/grape-swagger/pull/922): Force request body to be an schema object - [@numbata](https://github.com/numbata).
|
|
64
|
+
* [#923](https://github.com/ruby-grape/grape-swagger/pull/923): Enabled schema definitions for body parameters in DELETE requests - [@numbata](https://github.com/numbata).
|
|
65
|
+
* [#924](https://github.com/ruby-grape/grape-swagger/pull/924): Use mount_path to narrow down urls_for - [@chibicco](https://github.com/chibicco).
|
|
51
66
|
|
|
52
67
|
|
|
53
|
-
### 2.0.2 (
|
|
68
|
+
### 2.0.2 (2024-02-02)
|
|
54
69
|
|
|
55
70
|
#### Fixes
|
|
56
71
|
|
|
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)
|
|
72
|
+
* [#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
73
|
|
|
59
74
|
|
|
60
|
-
### 2.0.1 (
|
|
75
|
+
### 2.0.1 (2024-01-02)
|
|
61
76
|
|
|
62
77
|
#### Features
|
|
63
78
|
|
|
64
|
-
* [#914](https://github.com/ruby-grape/grape-swagger/pull/914): Support Ruby 3.3 - [@LeFnord](https://github.com/LeFnord)
|
|
79
|
+
* [#914](https://github.com/ruby-grape/grape-swagger/pull/914): Support Ruby 3.3 - [@LeFnord](https://github.com/LeFnord).
|
|
65
80
|
|
|
66
81
|
#### Fixes
|
|
67
82
|
|
|
68
|
-
* [#916](https://github.com/ruby-grape/grape-swagger/pull/916): Restore Ruby 3.0 support - [@godfat](https://github.com/godfat)
|
|
83
|
+
* [#916](https://github.com/ruby-grape/grape-swagger/pull/916): Restore Ruby 3.0 support - [@godfat](https://github.com/godfat).
|
|
69
84
|
|
|
70
85
|
|
|
71
|
-
### 2.0.0 (
|
|
86
|
+
### 2.0.0 (2023-11-07)
|
|
72
87
|
|
|
73
88
|
#### Features
|
|
74
89
|
|
|
75
|
-
* [#910](https://github.com/ruby-grape/grape-swagger/pull/910): Allow using Grape v2 - [@ninoseki](https://github.com/ninoseki)
|
|
90
|
+
* [#910](https://github.com/ruby-grape/grape-swagger/pull/910): Allow using Grape v2 - [@ninoseki](https://github.com/ninoseki).
|
|
76
91
|
|
|
77
92
|
#### Fixes
|
|
78
93
|
|
|
79
|
-
* [#903](https://github.com/ruby-grape/grape-swagger/pull/903): Accept `example` documentation parameter for arrays - [@VladMomotov](https://github.com/VladMomotov)
|
|
94
|
+
* [#903](https://github.com/ruby-grape/grape-swagger/pull/903): Accept `example` documentation parameter for arrays - [@VladMomotov](https://github.com/VladMomotov).
|
|
80
95
|
|
|
81
96
|
|
|
82
|
-
### 1.6.1 (
|
|
97
|
+
### 1.6.1 (2023-05-21)
|
|
83
98
|
|
|
84
99
|
#### Fixes
|
|
85
100
|
|
|
86
|
-
* [#868](https://github.com/ruby-grape/grape-swagger/pull/896): Fix parsing endless range values - [@dhruvCW](https://github.com/dhruvCW)
|
|
101
|
+
* [#868](https://github.com/ruby-grape/grape-swagger/pull/896): Fix parsing endless range values - [@dhruvCW](https://github.com/dhruvCW).
|
|
87
102
|
|
|
88
103
|
|
|
89
|
-
### 1.6.0 (
|
|
104
|
+
### 1.6.0 (2023-03-19)
|
|
90
105
|
|
|
91
106
|
#### Features
|
|
92
107
|
|
|
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)
|
|
108
|
+
* [#872](https://github.com/ruby-grape/grape-swagger/pull/872): Add `consumes` and `produces` options to `add_swagger_documentation` - [@spaceraccoon](https://github.com/spaceraccoon).
|
|
109
|
+
* [#868](https://github.com/ruby-grape/grape-swagger/pull/868): Add `default` endpoint option to specify default response - [@dhruvCW](https://github.com/dhruvCW).
|
|
95
110
|
|
|
96
111
|
|
|
97
|
-
### 1.5.0 (
|
|
112
|
+
### 1.5.0 (2022-07-28)
|
|
98
113
|
|
|
99
114
|
#### Features
|
|
100
115
|
|
|
101
|
-
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-)
|
|
116
|
+
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-).
|
|
102
117
|
|
|
103
118
|
#### Fixes
|
|
104
119
|
|
|
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)
|
|
120
|
+
* [#860](https://github.com/ruby-grape/grape-swagger/pull/860): Included githubactions in the dependabot config - [@naveensrinivasan](https://github.com/naveensrinivasan).
|
|
121
|
+
* [#843](https://github.com/ruby-grape/grape-swagger/pull/843): Syntax errors in README.md examples - [@remvee](https://github.com/remvee).
|
|
122
|
+
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil).
|
|
123
|
+
* [#847](https://github.com/ruby-grape/grape-swagger/pull/847): Parse route_param type for nested endpoints - [@dmoss18](https://github.com/dmoss18).
|
|
124
|
+
* [#856](https://github.com/ruby-grape/grape-swagger/pull/856): Remove unused methods in GrapeSwagger::DocMethods::BuildModelDefinition - [@takahashim](https://github.com/takahashim).
|
|
125
|
+
* [#858](https://github.com/ruby-grape/grape-swagger/pull/858): Set permissions for GitHub actions - [@naveensrinivasan](https://github.com/naveensrinivasan).
|
|
126
|
+
* [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick to support Ruby 3.x - [@takahashim](https://github.com/takahashim).
|
|
127
|
+
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work - [@takahashim](https://github.com/takahashim).
|
|
128
|
+
* [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Refactor oapi fetch task - [@Vachman](https://github.com/Vachman).
|
|
129
|
+
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of enum to be Array - [@takahashim](https://github.com/takahashim).
|
|
115
130
|
|
|
116
|
-
### 1.4.3 (
|
|
131
|
+
### 1.4.3 (2022-01-05)
|
|
117
132
|
|
|
118
133
|
#### Fixes
|
|
119
134
|
|
|
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-)
|
|
135
|
+
* [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of `enum` to be `Array` - [@takahashim](https://github.com/takahashim).
|
|
136
|
+
* [#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).
|
|
137
|
+
* [#852](https://github.com/ruby-grape/grape-swagger/pull/852): Fix example to work without error - [@takahashim](https://github.com/takahashim).
|
|
138
|
+
* [#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).
|
|
139
|
+
* [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil).
|
|
140
|
+
* [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-).
|
|
126
141
|
|
|
127
|
-
### 1.4.2 (
|
|
142
|
+
### 1.4.2 (2021-10-22)
|
|
128
143
|
|
|
129
144
|
#### Fixes
|
|
130
145
|
|
|
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-)
|
|
146
|
+
* [#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-).
|
|
147
|
+
* [#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-).
|
|
148
|
+
* [#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
149
|
|
|
135
150
|
|
|
136
|
-
### 1.4.1 (
|
|
151
|
+
### 1.4.1 (2021-09-15)
|
|
137
152
|
|
|
138
153
|
#### Fixes
|
|
139
154
|
|
|
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)
|
|
155
|
+
* [#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
156
|
|
|
142
157
|
|
|
143
|
-
### 1.4.0 (
|
|
158
|
+
### 1.4.0 (2021-03-20)
|
|
144
159
|
|
|
145
160
|
#### Features
|
|
146
161
|
|
|
@@ -152,7 +167,7 @@
|
|
|
152
167
|
* [#822](https://github.com/ruby-grape/grape-swagger/pull/822): Corrected the related parameter lookup on request params - [@Jack12816](https://github.com/Jack12816).
|
|
153
168
|
|
|
154
169
|
|
|
155
|
-
### 1.3.1 (
|
|
170
|
+
### 1.3.1 (2020-11-01)
|
|
156
171
|
|
|
157
172
|
#### Features
|
|
158
173
|
|
|
@@ -163,21 +178,21 @@
|
|
|
163
178
|
* [#811](https://github.com/ruby-grape/grape-swagger/pull/811): Fixes #809: supports utf8 route names - [@LeFnord](https://github.com/LeFnord).
|
|
164
179
|
|
|
165
180
|
|
|
166
|
-
### 1.3.0 (
|
|
181
|
+
### 1.3.0 (2020-09-03)
|
|
167
182
|
|
|
168
183
|
#### Features
|
|
169
184
|
|
|
170
185
|
* [#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
186
|
|
|
172
187
|
|
|
173
|
-
### 1.2.1 (
|
|
188
|
+
### 1.2.1 (2020-07-15)
|
|
174
189
|
|
|
175
190
|
#### Fixes
|
|
176
191
|
|
|
177
192
|
* [#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
193
|
|
|
179
194
|
|
|
180
|
-
### 1.2.0 (
|
|
195
|
+
### 1.2.0 (2020-07-01)
|
|
181
196
|
|
|
182
197
|
#### Features
|
|
183
198
|
|
|
@@ -190,7 +205,7 @@
|
|
|
190
205
|
* [#796](https://github.com/ruby-grape/grape-swagger/pull/796): Support grape 1.4.0 - [@thedanielhanke](https://github.com/thedanielhanke).
|
|
191
206
|
|
|
192
207
|
|
|
193
|
-
### 1.1.0 (
|
|
208
|
+
### 1.1.0 (2020-04-20)
|
|
194
209
|
|
|
195
210
|
#### Features
|
|
196
211
|
|
|
@@ -199,7 +214,7 @@
|
|
|
199
214
|
* [#786](https://github.com/ruby-grape/grape-swagger/pull/786): Use full entity name as a default - [@mrexox](https://github.com/mrexox).
|
|
200
215
|
|
|
201
216
|
|
|
202
|
-
### 1.0.0 (
|
|
217
|
+
### 1.0.0 (2020-02-10)
|
|
203
218
|
|
|
204
219
|
#### Features
|
|
205
220
|
|
|
@@ -207,14 +222,14 @@
|
|
|
207
222
|
* [#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
223
|
|
|
209
224
|
|
|
210
|
-
### 0.34.2 (
|
|
225
|
+
### 0.34.2 (2020-01-20)
|
|
211
226
|
|
|
212
227
|
#### Fixes
|
|
213
228
|
|
|
214
229
|
* [#773](https://github.com/ruby-grape/grape-swagger/pull/773): Freeze rack version to 2.0.8 - [@LeFnord](https://github.com/LeFnord).
|
|
215
230
|
|
|
216
231
|
|
|
217
|
-
### 0.34.0 (
|
|
232
|
+
### 0.34.0 (2020-01-11)
|
|
218
233
|
|
|
219
234
|
#### Features
|
|
220
235
|
|
|
@@ -230,7 +245,7 @@
|
|
|
230
245
|
* [#764](https://github.com/ruby-grape/grape-swagger/pull/764): Fix root element for multi-word entities - [@bikolya](https://github.com/bikolya).
|
|
231
246
|
|
|
232
247
|
|
|
233
|
-
### 0.33.0 (
|
|
248
|
+
### 0.33.0 (2019-06-21)
|
|
234
249
|
|
|
235
250
|
#### Fixes
|
|
236
251
|
|
|
@@ -240,7 +255,7 @@
|
|
|
240
255
|
* [#737](https://github.com/ruby-grape/grape-swagger/pull/737): Add swagger endpoint guard to both doc endpoints - [@urkle](https://github.com/urkle).
|
|
241
256
|
|
|
242
257
|
|
|
243
|
-
### 0.32.1 (
|
|
258
|
+
### 0.32.1 (2018-12-07)
|
|
244
259
|
|
|
245
260
|
#### Fixes
|
|
246
261
|
|
|
@@ -248,7 +263,7 @@
|
|
|
248
263
|
* [#729](https://github.com/ruby-grape/grape-swagger/pull/729): Allow empty security array for endpoints - [@fotos](https://github.com/fotos).
|
|
249
264
|
|
|
250
265
|
|
|
251
|
-
### 0.32.0 (
|
|
266
|
+
### 0.32.0 (2018-11-26)
|
|
252
267
|
|
|
253
268
|
#### Features
|
|
254
269
|
|
|
@@ -259,14 +274,14 @@
|
|
|
259
274
|
* [#720](https://github.com/ruby-grape/grape-swagger/pull/720): Fix: corrected `termsOfService` field name in additional info - [@dblock](https://github.com/dblock).
|
|
260
275
|
|
|
261
276
|
|
|
262
|
-
### 0.31.1 (
|
|
277
|
+
### 0.31.1 (2018-10-23)
|
|
263
278
|
|
|
264
279
|
#### Features
|
|
265
280
|
|
|
266
281
|
* [#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
282
|
|
|
268
283
|
|
|
269
|
-
### 0.31.0 (
|
|
284
|
+
### 0.31.0 (2018-08-22)
|
|
270
285
|
|
|
271
286
|
#### Features
|
|
272
287
|
|
|
@@ -277,14 +292,14 @@
|
|
|
277
292
|
* [#696](https://github.com/ruby-grape/grape-swagger/pull/696): Delegate required properties parsing to model parsers - [@Bugagazavr](https://github.com/Bugagazavr).
|
|
278
293
|
|
|
279
294
|
|
|
280
|
-
### 0.30.1 (
|
|
295
|
+
### 0.30.1 (2018-07-19)
|
|
281
296
|
|
|
282
297
|
#### Features
|
|
283
298
|
|
|
284
299
|
* [#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
300
|
|
|
286
301
|
|
|
287
|
-
### 0.30.0 (
|
|
302
|
+
### 0.30.0 (2018-07-19)
|
|
288
303
|
|
|
289
304
|
#### Features
|
|
290
305
|
|
|
@@ -296,7 +311,7 @@
|
|
|
296
311
|
* [#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
312
|
|
|
298
313
|
|
|
299
|
-
### 0.29.0 (
|
|
314
|
+
### 0.29.0 (2018-05-22)
|
|
300
315
|
|
|
301
316
|
#### Features
|
|
302
317
|
|
|
@@ -311,7 +326,7 @@
|
|
|
311
326
|
* [#672](https://github.com/ruby-grape/grape-swagger/pull/672): Rename 'notes' to 'detail' in README - [@kjleitz](https://github.com/kjleitz).
|
|
312
327
|
|
|
313
328
|
|
|
314
|
-
### 0.28.0 (
|
|
329
|
+
### 0.28.0 (2018-02-03)
|
|
315
330
|
|
|
316
331
|
#### Features
|
|
317
332
|
|
|
@@ -328,7 +343,7 @@
|
|
|
328
343
|
* [#656](https://github.com/ruby-grape/grape-swagger/pull/656): Fix `description` field may be null - [@soranoba](https://github.com/soranoba).
|
|
329
344
|
|
|
330
345
|
|
|
331
|
-
### 0.27.3 (
|
|
346
|
+
### 0.27.3 (2017-07-11)
|
|
332
347
|
|
|
333
348
|
#### Features
|
|
334
349
|
|
|
@@ -339,7 +354,7 @@
|
|
|
339
354
|
* [#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
355
|
|
|
341
356
|
|
|
342
|
-
### 0.27.2 (
|
|
357
|
+
### 0.27.2 (2017-05-11)
|
|
343
358
|
|
|
344
359
|
#### Features
|
|
345
360
|
|
|
@@ -348,14 +363,14 @@
|
|
|
348
363
|
* [#607](https://github.com/ruby-grape/grape-swagger/pull/607): Allow body parameter name to be specified - [@tjwp](https://github.com/tjwp).
|
|
349
364
|
|
|
350
365
|
|
|
351
|
-
### 0.27.1 (
|
|
366
|
+
### 0.27.1 (2017-04-28)
|
|
352
367
|
|
|
353
368
|
#### Features
|
|
354
369
|
|
|
355
370
|
* [#602](https://github.com/ruby-grape/grape-swagger/pull/602): Allow security object to be defined - [@markevich](https://github.com/markevich).
|
|
356
371
|
|
|
357
372
|
|
|
358
|
-
### 0.27.0 (
|
|
373
|
+
### 0.27.0 (2017-03-27)
|
|
359
374
|
|
|
360
375
|
#### Features
|
|
361
376
|
|
|
@@ -371,7 +386,7 @@
|
|
|
371
386
|
* [#593](https://github.com/ruby-grape/grape-swagger/pull/593): Clarify hidden option in readme - [@thogg4](https://github.com/thogg4).
|
|
372
387
|
|
|
373
388
|
|
|
374
|
-
### 0.26.1 (
|
|
389
|
+
### 0.26.1 (2017-02-03)
|
|
375
390
|
|
|
376
391
|
#### Features
|
|
377
392
|
|
|
@@ -386,7 +401,7 @@
|
|
|
386
401
|
* [#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
402
|
|
|
388
403
|
|
|
389
|
-
### 0.26.0 (
|
|
404
|
+
### 0.26.0 (2017-01-09)
|
|
390
405
|
|
|
391
406
|
#### Features
|
|
392
407
|
|
|
@@ -399,7 +414,7 @@
|
|
|
399
414
|
* [#561](https://github.com/ruby-grape/grape-swagger/pull/561): Rename failures to failure in readme - [@justincampbell](https://github.com/justincampbell).
|
|
400
415
|
|
|
401
416
|
|
|
402
|
-
### 0.25.3 (
|
|
417
|
+
### 0.25.3 (2016-12-18)
|
|
403
418
|
|
|
404
419
|
#### Features
|
|
405
420
|
|
|
@@ -413,14 +428,14 @@
|
|
|
413
428
|
* [#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
429
|
|
|
415
430
|
|
|
416
|
-
### 0.25.2 (
|
|
431
|
+
### 0.25.2 (2016-11-30)
|
|
417
432
|
|
|
418
433
|
#### Fixes
|
|
419
434
|
|
|
420
435
|
* [#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
436
|
|
|
422
437
|
|
|
423
|
-
### 0.25.1 (
|
|
438
|
+
### 0.25.1 (2016-11-29)
|
|
424
439
|
|
|
425
440
|
#### Features
|
|
426
441
|
|
|
@@ -433,7 +448,7 @@
|
|
|
433
448
|
* [#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
449
|
|
|
435
450
|
|
|
436
|
-
### 0.25.0 (
|
|
451
|
+
### 0.25.0 (2016-10-31)
|
|
437
452
|
|
|
438
453
|
#### Features
|
|
439
454
|
|
|
@@ -449,7 +464,7 @@
|
|
|
449
464
|
* [#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
465
|
|
|
451
466
|
|
|
452
|
-
### 0.24.0 (
|
|
467
|
+
### 0.24.0 (2016-09-23)
|
|
453
468
|
|
|
454
469
|
#### Features
|
|
455
470
|
|
|
@@ -468,7 +483,7 @@
|
|
|
468
483
|
* [#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
484
|
|
|
470
485
|
|
|
471
|
-
### 0.23.0 (
|
|
486
|
+
### 0.23.0 (2016-08-05)
|
|
472
487
|
|
|
473
488
|
#### Features
|
|
474
489
|
|
|
@@ -484,7 +499,7 @@
|
|
|
484
499
|
* [#483](https://github.com/ruby-grape/grape-swagger/pull/483): Added support for nicknamed routes - [@pbendersky](https://github.com/pbendersky).
|
|
485
500
|
|
|
486
501
|
|
|
487
|
-
### 0.22.0 (
|
|
502
|
+
### 0.22.0 (2016-07-12)
|
|
488
503
|
|
|
489
504
|
#### Features
|
|
490
505
|
|
|
@@ -509,7 +524,7 @@
|
|
|
509
524
|
* [#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
525
|
|
|
511
526
|
|
|
512
|
-
### 0.21.0 (
|
|
527
|
+
### 0.21.0 (2016-06-01)
|
|
513
528
|
|
|
514
529
|
#### Features
|
|
515
530
|
|
|
@@ -525,7 +540,7 @@
|
|
|
525
540
|
* [#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
541
|
|
|
527
542
|
|
|
528
|
-
### 0.20.3 (
|
|
543
|
+
### 0.20.3 (2016-05-09)
|
|
529
544
|
|
|
530
545
|
#### Features
|
|
531
546
|
|
|
@@ -540,7 +555,7 @@
|
|
|
540
555
|
* [#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
556
|
|
|
542
557
|
|
|
543
|
-
### 0.20.2 (
|
|
558
|
+
### 0.20.2 (2016-04-22)
|
|
544
559
|
|
|
545
560
|
#### Fixes
|
|
546
561
|
|
|
@@ -549,7 +564,7 @@
|
|
|
549
564
|
* [#389](https://github.com/ruby-grape/grape-swagger/pull/389): Respect X-Forwarded-Host - [@edvakf](https://github.com/edvakf).
|
|
550
565
|
|
|
551
566
|
|
|
552
|
-
### 0.20.1 (
|
|
567
|
+
### 0.20.1 (2016-04-17)
|
|
553
568
|
|
|
554
569
|
#### Features
|
|
555
570
|
|
|
@@ -561,7 +576,7 @@
|
|
|
561
576
|
* [#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
577
|
|
|
563
578
|
|
|
564
|
-
### 0.20.0 (
|
|
579
|
+
### 0.20.0 (2016-04-09)
|
|
565
580
|
|
|
566
581
|
#### Features
|
|
567
582
|
|
|
@@ -575,12 +590,12 @@
|
|
|
575
590
|
* [#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
591
|
|
|
577
592
|
|
|
578
|
-
### 0.10.5 (
|
|
593
|
+
### 0.10.5 (2016-04-12)
|
|
579
594
|
|
|
580
595
|
* [#344](https://github.com/ruby-grape/grape-swagger/pull/344): Namespace based tag included in Swagger JSON - [@LeFnord](https://github.com/LeFnord).
|
|
581
596
|
|
|
582
597
|
|
|
583
|
-
### 0.10.2 (
|
|
598
|
+
### 0.10.2 (2015-08-19)
|
|
584
599
|
|
|
585
600
|
#### Features
|
|
586
601
|
|
|
@@ -605,13 +620,13 @@
|
|
|
605
620
|
* [#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
621
|
|
|
607
622
|
|
|
608
|
-
### 0.10.1 (
|
|
623
|
+
### 0.10.1 (2015-03-11)
|
|
609
624
|
|
|
610
625
|
* [#227](https://github.com/ruby-grape/grape-swagger/issues/227): Fix: nested routes under prefix not documented - [@dblock](https://github.com/dblock).
|
|
611
626
|
* [#226](https://github.com/ruby-grape/grape-swagger/issues/226): Fix: be defensive with nil exposure types - [@dblock](https://github.com/dblock).
|
|
612
627
|
|
|
613
628
|
|
|
614
|
-
### 0.10.0 (
|
|
629
|
+
### 0.10.0 (2015-03-10)
|
|
615
630
|
|
|
616
631
|
#### Features
|
|
617
632
|
|
|
@@ -631,7 +646,7 @@
|
|
|
631
646
|
* [#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
647
|
|
|
633
648
|
|
|
634
|
-
### 0.9.0 (
|
|
649
|
+
### 0.9.0 (2014-12-19)
|
|
635
650
|
|
|
636
651
|
* [#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
652
|
* [#154](https://github.com/ruby-grape/grape-swagger/pull/154): Allow classes for type declarations inside documentation - [@mrmargolis](https://github.com/mrmargolis).
|
|
@@ -646,7 +661,7 @@
|
|
|
646
661
|
* [#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
662
|
|
|
648
663
|
|
|
649
|
-
### 0.8.0 (
|
|
664
|
+
### 0.8.0 (2014-08-30)
|
|
650
665
|
|
|
651
666
|
#### Features
|
|
652
667
|
|
|
@@ -676,7 +691,7 @@
|
|
|
676
691
|
* Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
|
|
677
692
|
|
|
678
693
|
|
|
679
|
-
### 0.7.2 (
|
|
694
|
+
### 0.7.2 (2014-02-06)
|
|
680
695
|
|
|
681
696
|
* [#84](https://github.com/ruby-grape/grape-swagger/pull/84): Markdown is now Github Flavored Markdown - [@jeromegn](https://github.com/jeromegn).
|
|
682
697
|
* [#83](https://github.com/ruby-grape/grape-swagger/pull/83): Improved support for nested Entity types - [@jeromegn](https://github.com/jeromegn).
|
|
@@ -694,7 +709,7 @@
|
|
|
694
709
|
* [#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
710
|
|
|
696
711
|
|
|
697
|
-
### 0.6.0 (
|
|
712
|
+
### 0.6.0 (2013-06-19)
|
|
698
713
|
|
|
699
714
|
* Added Rails 4 support - [@jrhe](https://github.com/jrhe).
|
|
700
715
|
* Fix: document APIs at root level - [@dblock](https://github.com/dblock).
|
|
@@ -703,17 +718,17 @@
|
|
|
703
718
|
* Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
|
|
704
719
|
|
|
705
720
|
|
|
706
|
-
### 0.5.0 (
|
|
721
|
+
### 0.5.0 (2013-03-28)
|
|
707
722
|
|
|
708
723
|
* Added Grape 0.5.0 support - [@ruby-grape](https://github.com/ruby-grape).
|
|
709
724
|
|
|
710
725
|
|
|
711
|
-
### 0.4.0 (
|
|
726
|
+
### 0.4.0 (2013-03-28)
|
|
712
727
|
|
|
713
728
|
* Support https - [@cutalion](https://github.com/cutalion).
|
|
714
729
|
|
|
715
730
|
|
|
716
|
-
### 0.3.0 (
|
|
731
|
+
### 0.3.0 (2012-10-19)
|
|
717
732
|
|
|
718
733
|
* Added version support - [@agileanimal](https://github.com/agileanimal), [@fknappe](https://github.com/fknappe).
|
|
719
734
|
* Added support for nested parameters - [@ruby-grape](https://github.com/ruby-grape).
|
|
@@ -721,27 +736,27 @@
|
|
|
721
736
|
* Add possibility to hide the documentation paths in the generated swagger documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
722
737
|
|
|
723
738
|
|
|
724
|
-
### 0.2.1 (
|
|
739
|
+
### 0.2.1 (2012-08-17)
|
|
725
740
|
|
|
726
741
|
* Added support for markdown in notes field - [@ruby-grape](https://github.com/ruby-grape).
|
|
727
742
|
* Fix: compatibility with Rails - [@qwert666](https://github.com/qwert666).
|
|
728
743
|
* Fix: swagger UI history - [@ruby-grape](https://github.com/ruby-grape).
|
|
729
744
|
|
|
730
745
|
|
|
731
|
-
### 0.2.0 (
|
|
746
|
+
### 0.2.0 (2012-07-27)
|
|
732
747
|
|
|
733
748
|
* Use resource as root for swagger - [@ruby-grape](https://github.com/ruby-grape).
|
|
734
749
|
* Added support for file uploads, and proper `paramType` - [@ruby-grape](https://github.com/ruby-grape).
|
|
735
750
|
* Added tests - [@nathanvda](https://github.com/nathanvda).
|
|
736
751
|
|
|
737
752
|
|
|
738
|
-
### 0.1.0 (
|
|
753
|
+
### 0.1.0 (2012-07-19)
|
|
739
754
|
|
|
740
755
|
* Added some configurability to the generated documentation - [@ruby-grape](https://github.com/ruby-grape).
|
|
741
756
|
* Adapted to rails plugin structure - [@ruby-grape](https://github.com/ruby-grape).
|
|
742
757
|
* Allowed cross origin, so swagger can be used from official site - [@ruby-grape](https://github.com/ruby-grape).
|
|
743
758
|
|
|
744
759
|
|
|
745
|
-
### 0.0.0 (
|
|
760
|
+
### 0.0.0 (2012-07-19)
|
|
746
761
|
|
|
747
762
|
* Initial public release - [@ruby-grape](https://github.com/ruby-grape).
|