swaggard 4.1.1 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 22712f08a524289197fef03b0fa4b6e2f9b76bb998c78909ca0b8459a240b0fd
|
|
4
|
+
data.tar.gz: c6002db5029e1013e0597a041dae4ce1ce03622e5245647bd9249d2524e5ccaf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a4cc784c4e3f5e930e5be443bc3c026da984194087c939867eea961e77b5259b4ec84daef72802bfbb44519cf2da5fb2834bdacc7eaafdc62e94cf4a213b2ee3
|
|
7
|
+
data.tar.gz: 06e9c4079d1dd6ae1f12a6bdd69b79279ae1d2481629e15a11b6beab3900fe1957f8b32b083951512a2dcc819eadbe6fe979b963ba177ba0b0f6bfc0bfab96e5
|
|
@@ -19,6 +19,7 @@ module Swaggard
|
|
|
19
19
|
@summary = (yard_object.docstring.lines.first || '').chomp
|
|
20
20
|
@parameters = []
|
|
21
21
|
@responses = []
|
|
22
|
+
@deprecated = false
|
|
22
23
|
|
|
23
24
|
@description = (yard_object.docstring.lines[1..-1] || []).map(&:chomp).reject(&:empty?).compact.join("\n")
|
|
24
25
|
@http_method = verb
|
|
@@ -32,6 +33,8 @@ module Swaggard
|
|
|
32
33
|
case yard_tag.tag_name
|
|
33
34
|
when 'operation_id'
|
|
34
35
|
@operation_id = "#{@tag.name}.#{value}"
|
|
36
|
+
when 'deprecated'
|
|
37
|
+
@deprecated = true
|
|
35
38
|
when 'query_parameter'
|
|
36
39
|
@parameters << Parameters::Query.new(value)
|
|
37
40
|
when 'form_parameter'
|
|
@@ -98,6 +101,8 @@ module Swaggard
|
|
|
98
101
|
doc['requestBody'] = build_form_request_body(form_params)
|
|
99
102
|
end
|
|
100
103
|
|
|
104
|
+
doc['deprecated'] = true if @deprecated
|
|
105
|
+
|
|
101
106
|
doc
|
|
102
107
|
end
|
|
103
108
|
|
data/lib/swaggard/version.rb
CHANGED
data/lib/swaggard.rb
CHANGED
|
@@ -24,6 +24,7 @@ module Swaggard
|
|
|
24
24
|
def register_custom_yard_tags!
|
|
25
25
|
::YARD::Tags::Library.define_tag('Controller\'s tag', :tag)
|
|
26
26
|
::YARD::Tags::Library.define_tag('Operation id', :operation_id)
|
|
27
|
+
::YARD::Tags::Library.define_tag('Deprecated', :deprecated)
|
|
27
28
|
::YARD::Tags::Library.define_tag('Query parameter', :query_parameter)
|
|
28
29
|
::YARD::Tags::Library.define_tag('Form parameter', :form_parameter)
|
|
29
30
|
::YARD::Tags::Library.define_tag('Body required', :body_required)
|
data/spec/fixtures/api.json
CHANGED