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

enable swagger empty body responses

Browse Source
This commit is contained in:
psmandzich 2020-07-21 09:50:47 +02:00
parent bec4f16676
commit 347f9da32e
3 changed files with 61 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -129,9 +129,9 @@ module Rswag
end end
def upgrade_content!(mime_list, target_node) def upgrade_content!(mime_list, target_node)
target_node.merge!(content: {})
schema = target_node[:schema] schema = target_node[:schema]
return if mime_list.empty? || schema.nil? return if mime_list.empty? || schema.nil?
target_node.merge!(content: {})
mime_list.each do |mime_type| mime_list.each do |mime_type|
# TODO upgrade to have content-type specific schema # TODO upgrade to have content-type specific schema

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

@ -127,6 +127,56 @@ module Rswag
) )
end end
context 'with empty content' do
let(:swagger_doc) do
{
openapi: '3.0.1',
basePath: '/foo',
schemes: ['http', 'https'],
host: 'api.example.com',
components: {
securitySchemes: {
myClientCredentials: {
type: :oauth2,
flow: :application,
token_url: :somewhere
},
myAuthorizationCode: {
type: :oauth2,
flow: :accessCode,
token_url: :somewhere
},
myImplicit: {
type: :oauth2,
flow: :implicit,
token_url: :somewhere
}
}
}
}
end
it 'converts query and path params, type: to schema: { type: }' do
expect(swagger_doc.slice(:paths)).to match(
paths: {
'/blogs' => {
parameters: [{ schema: { type: :string } }],
post: {
parameters: [{ schema: { type: :string } }],
summary: 'Creates a blog',
responses: {
'201' => {
description: 'blog created',
headers: { schema: { type: :string } }
}
}
}
}
}
)
end
end
it 'converts basePath, schemas and host to urls' do it 'converts basePath, schemas and host to urls' do
expect(swagger_doc.slice(:servers)).to match( expect(swagger_doc.slice(:servers)).to match(
servers: { servers: {

40
test-app/swagger/v1/swagger.json
View File

@ -21,14 +21,10 @@
], ],
"responses": { "responses": {
"204": { "204": {
"description": "Valid credentials", "description": "Valid credentials"
"content": {
}
}, },
"401": { "401": {
"description": "Invalid credentials", "description": "Invalid credentials"
"content": {
}
} }
} }
} }
@ -49,14 +45,10 @@
], ],
"responses": { "responses": {
"204": { "204": {
"description": "Valid credentials", "description": "Valid credentials"
"content": {
}
}, },
"401": { "401": {
"description": "Invalid credentials", "description": "Invalid credentials"
"content": {
}
} }
} }
} }
@ -80,14 +72,10 @@
], ],
"responses": { "responses": {
"204": { "204": {
"description": "Valid credentials", "description": "Valid credentials"
"content": {
}
}, },
"401": { "401": {
"description": "Invalid credentials", "description": "Invalid credentials"
"content": {
}
} }
} }
} }
@ -105,9 +93,7 @@
], ],
"responses": { "responses": {
"201": { "201": {
"description": "blog created", "description": "blog created"
"content": {
}
}, },
"422": { "422": {
"description": "invalid request", "description": "invalid request",
@ -148,9 +134,7 @@
], ],
"responses": { "responses": {
"406": { "406": {
"description": "unsupported accept header", "description": "unsupported accept header"
"content": {
}
} }
} }
} }
@ -252,9 +236,7 @@
} }
}, },
"404": { "404": {
"description": "blog not found", "description": "blog not found"
"content": {
}
} }
} }
} }
@ -282,9 +264,7 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "blog updated", "description": "blog updated"
"content": {
}
} }
}, },
"requestBody": { "requestBody": {