grape-swagger 1.4.0 → 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/lib/grape-swagger/doc_methods/move_params.rb +1 -1
- data/lib/grape-swagger/version.rb +1 -1
- data/spec/support/the_paths_definitions.rb +4 -4
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2bc71f9cae392ed1e1fcb574570c75d800d99120c98ad9061b263edf80dc997d
|
|
4
|
+
data.tar.gz: f2cf0bca726860789875007043edb8ce689e7e779eb3273b1f376cb5b161949f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6e6beba3aaba4f3fa5fc152127ad84c5dcae6c44bffecf276ae778e9ce779eba2a90feb40a7110afaffff1afc4ab0af7d2128fddf993ea304621e2a9428e2435
|
|
7
|
+
data.tar.gz: 3190175c602571c28e1cb2678b7c94ce0ac4f663cc163d6dd03c03a0e3fee5b75a80e3ff3a3e3f6e0eb964727cccd5dc7914db32dee98901e2000c0ebd2d33a8
|
data/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,13 @@
|
|
|
9
9
|
* Your contribution here.
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
### 1.4.1 (September 15, 2021)
|
|
13
|
+
|
|
14
|
+
#### Fixes
|
|
15
|
+
|
|
16
|
+
* [#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)
|
|
17
|
+
|
|
18
|
+
|
|
12
19
|
### 1.4.0 (March 20, 2021)
|
|
13
20
|
|
|
14
21
|
#### Features
|
|
@@ -181,7 +181,7 @@ module GrapeSwagger
|
|
|
181
181
|
end
|
|
182
182
|
|
|
183
183
|
def property_keys
|
|
184
|
-
%i[type format description minimum maximum items enum default additionalProperties]
|
|
184
|
+
%i[type format description minimum maximum items enum default additionalProperties example]
|
|
185
185
|
end
|
|
186
186
|
|
|
187
187
|
def deletable?(param)
|
|
@@ -8,7 +8,7 @@ RSpec.shared_context 'the api paths/defs' do
|
|
|
8
8
|
produces: ['application/json'],
|
|
9
9
|
consumes: ['application/json'],
|
|
10
10
|
parameters: [
|
|
11
|
-
{ in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
|
|
11
|
+
{ in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true, example: 23 },
|
|
12
12
|
{ in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
|
|
13
13
|
{ in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
|
|
14
14
|
],
|
|
@@ -31,7 +31,7 @@ RSpec.shared_context 'the api paths/defs' do
|
|
|
31
31
|
{ in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
|
|
32
32
|
{ in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
|
|
33
33
|
{ in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
|
|
34
|
-
{ in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
|
|
34
|
+
{ in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false, example: 'my example string' }
|
|
35
35
|
],
|
|
36
36
|
responses: { 200 => { description: 'put in body /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
|
|
37
37
|
tags: ['in_body'],
|
|
@@ -85,7 +85,7 @@ RSpec.shared_context 'the api paths/defs' do
|
|
|
85
85
|
{
|
|
86
86
|
type: 'object',
|
|
87
87
|
properties: {
|
|
88
|
-
in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
|
|
88
|
+
in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1', example: 23 },
|
|
89
89
|
in_body_2: { type: 'string', description: 'in_body_2' },
|
|
90
90
|
in_body_3: { type: 'string', description: 'in_body_3' }
|
|
91
91
|
},
|
|
@@ -99,7 +99,7 @@ RSpec.shared_context 'the api paths/defs' do
|
|
|
99
99
|
properties: {
|
|
100
100
|
in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
|
|
101
101
|
in_body_2: { type: 'string', description: 'in_body_2' },
|
|
102
|
-
in_body_3: { type: 'string', description: 'in_body_3' }
|
|
102
|
+
in_body_3: { type: 'string', description: 'in_body_3', example: 'my example string' }
|
|
103
103
|
},
|
|
104
104
|
required: [:in_body_1]
|
|
105
105
|
}
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: grape-swagger
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.4.
|
|
4
|
+
version: 1.4.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- LeFnord
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2021-
|
|
12
|
+
date: 2021-09-15 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: grape
|
|
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
203
203
|
- !ruby/object:Gem::Version
|
|
204
204
|
version: '0'
|
|
205
205
|
requirements: []
|
|
206
|
-
rubygems_version: 3.2.
|
|
206
|
+
rubygems_version: 3.2.22
|
|
207
207
|
signing_key:
|
|
208
208
|
specification_version: 4
|
|
209
209
|
summary: Add auto generated documentation to your Grape API that can be displayed
|