ditkrg/rswag
4
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-25 07:16:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

add header type schema support for openapi3

Browse Source
This commit is contained in:
Greg Myers 2020-03-21 23:15:56 +00:00
parent a25307dc69
commit da230a4f3e
4 changed files with 11 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rswag-specs/lib/rswag/specs/example_group_helpers.rb
View File

@ -157,12 +157,6 @@ module Rswag
def header(name, attributes) def header(name, attributes)
metadata[:response][:headers] ||= {} metadata[:response][:headers] ||= {}
## OA3
# if attributes[:type] && attributes[:schema].nil?
# attributes[:schema] = { type: attributes[:type] }
# attributes.delete(:type)
# end
metadata[:response][:headers][name] = attributes metadata[:response][:headers][name] = attributes
end end

3
rswag-specs/lib/rswag/specs/swagger_formatter.rb
View File

@ -127,8 +127,9 @@ module Rswag
def upgrade_request_type!(metadata) def upgrade_request_type!(metadata)
operation_nodes = metadata[:operation][:parameters] || [] operation_nodes = metadata[:operation][:parameters] || []
path_nodes = metadata[:path_item][:parameters] || [] path_nodes = metadata[:path_item][:parameters] || []
header_node = metadata[:response][:headers] ||= {}
(operation_nodes + path_nodes).each do |node| (operation_nodes + path_nodes + [header_node]).each do |node|
if node && node[:type] && node[:schema].nil? if node && node[:type] && node[:schema].nil?
node[:schema] = { type: node[:type] } node[:schema] = { type: node[:type] }
node.delete(:type) node.delete(:type)

14
rswag-specs/spec/rswag/specs/example_helpers_spec.rb
View File

@ -27,20 +27,6 @@ module Rswag
} }
} }
end end
## OA3
# let(:swagger_doc) do
# {
# components: {
# securitySchemes: {
# api_key: {
# type: :apiKey,
# name: 'api_key',
# in: :query
# }
# }
# }
# }
# end
let(:metadata) do let(:metadata) do
{ {

12
rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
View File

@ -28,7 +28,7 @@ module Rswag
{ {
path_item: { template: '/blogs', parameters: [{ type: :string }] }, path_item: { template: '/blogs', parameters: [{ type: :string }] },
operation: { verb: :post, summary: 'Creates a blog', parameters: [{ type: :string }] }, operation: { verb: :post, summary: 'Creates a blog', parameters: [{ type: :string }] },
response: { code: '201', description: 'blog created' }, response: { code: '201', description: 'blog created', headers: { type: :string } },
document: document document: document
} }
end end
@ -55,7 +55,10 @@ module Rswag
parameters: [{ type: :string }], parameters: [{ type: :string }],
summary: 'Creates a blog', summary: 'Creates a blog',
responses: { responses: {
'201' => { description: 'blog created' } '201' => {
description: 'blog created',
headers: { type: :string }
}
} }
} }
} }
@ -78,7 +81,10 @@ module Rswag
parameters: [{ schema: { type: :string } }], parameters: [{ schema: { type: :string } }],
summary: 'Creates a blog', summary: 'Creates a blog',
responses: { responses: {
'201' => { description: 'blog created' } '201' => {
description: 'blog created',
headers: { schema: { type: :string } }
}
} }
} }
} }