ditkrg/rswag
4
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-23 06:16:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
494 Commits 6 Branches 28 Tags 8.6 MiB
master
Commit Graph

26 Commits

Author SHA1 Message Date
Blake Erickson
989aab656f
Revert "Add a macro for complexes multiparts" 2021-03-06 14:52:49 -07:00
Blake Erickson
f7036b7e5a
Merge pull request #300 from sobrinho/master 
Add a macro for complexes multiparts
 2021-03-06 10:22:54 -07:00
Jamie Macey
0a9487b328 make spec output less noisy 2020-10-17 13:34:17 -07:00
Gabriel Sobrinho
f8dbd98bbc
Add a macro for complexes multiparts 
This will allow to describe multipart in a short way, like JSON payload:

Before:

    put 'Creates a blog with thumbnail' do
      consumes 'multipart/form-data'
      parameter name: :title, in: :formData, type: :string, required: true
      parameter name: :content, in: :formData, type: :string, required: true
      parameter name: :file, in: :formData, type: :file, required: true

      let(:blog) { FactoryBot.build(:blog) }
      let(:title) { blog.title }
      let(:content) { blog.content }
      let(:file) { blog.file }

      ...
    end

After:

    put 'Creates a blog with thumbnail' do
      consumes 'multipart/form-data'
      parameter name: :blog, in: :formData, schema: { '$ref' => '#/definitions/blog' }

      let(:blog) { FactoryBot.attributes_for(:blog) }

      ...
    end

Your mileage may vary but you can always choose the best option.
 2020-04-16 22:38:35 -03:00
Greg Myers
965f14406f add support for oneOf anyOf allOf 2020-04-05 00:36:25 +01:00
Greg Myers
2b239ef0f3 Reverted some files related to definitions changes 2020-03-21 17:04:41 +00:00
Greg Myers
b5e210cd96 Merge branch 'openapi/master' into openapi/merge 2020-03-20 15:38:40 +00:00
Nathan Broadbent
e5eb44191c Use RSpec.describe to fix IRB context warning in Rails console 2019-10-17 16:40:31 +07:00
Jay Danielian
b8dcc8fe30 Adds support for proper requestBody examples. Adds mechanism to allow for adding additional ways to add request body examples 
Can add externalValue or  it will work and produce valid swagger spec.

The Symbol name matching the let parameter is always required
 2019-07-21 15:03:37 -04:00
Jay Danielian
4c2097e017 Fixes response_validator to handle 3.0 responses and validate against the schema. 
JSON::Validator already handles anyOf oneOf schema definitions, so those can be passed in and validation errors are returned properly
 2019-07-20 14:33:51 -04:00
Jay Danielian
cd348b53f8 Adds anyOf support to requestBody 2019-07-20 13:50:38 -04:00
Jay Danielian
28bcc121ba formatting 2019-07-17 20:10:10 -04:00
Jay Danielian
aa133b90fc Adds request_body_multipart method which enables schema properties to be written for multipart upload body 
Will inspect the provided hash and add the property file_name to the parameters collection so upload and 3.0 output will work properly
 2019-07-17 20:07:30 -04:00
Jay Danielian
c820bb75e0 Modifies parameters and body request/responses to output 3.0 syntax for basic operations. 
SwaggerEditor passes basic output
 2019-07-14 17:28:11 -04:00
Jay Danielian
297cc447c8 Gets v3 request example saving as well as response example saving 
Adds rubocop to the gemset

adds guard to the gemset for testing
 2019-07-05 15:59:47 -04:00
Jay Danielian
768a1a1d43 Initial commit for trying to produce and consume v3 swagger 2019-06-29 18:12:21 -04:00
domaindrivendev
ad9cd5de66 Support paired security requirements - e.g. basic and apiKey 2017-08-21 01:07:47 -07:00
domaindrivendev
732cab994c simplify validation blocks and use correct scope 2017-07-21 22:26:14 -07:00
domaindrivendev
b16198377b Merge branch 'add-formData-support' of https://github.com/thg303/rswag into thg303-add-formData-support 2017-07-21 14:25:29 -07:00
domaindrivendev
97c2a39cfa Refactor request_factory & response_validator 2017-07-20 23:42:40 -07:00
ali.q
182ee093f4 add formData support 2017-05-11 05:06:46 +04:30
vinhbachsy
0b0acfe4c7 Rename response_examples to examples for consistent DSL 
Special handling `examples` invocation with no parameters to avoid
overriding the `examples` method of rspec-core ExampleGroup
 2016-10-19 03:04:03 +08:00
vinhbachsy
5cf376891a Validate response headers based on specified header 
Add validate_headers step in response validator.
Using JSON::Validator with validate header value with swagger header 
object.
 2016-10-18 21:46:35 +08:00
vinhbachsy
10dd37896f Support setting examples for response 
Add helper method `response_examples` to inject response examples to swagger
 2016-10-18 21:46:35 +08:00
richie
4d675056c1 Support parameters provided at the 'path' level 2016-10-13 18:17:19 -07:00
richie
c558098c39 rename to rswag plus major refactor - almost a rewrite 2016-10-11 18:31:12 -07:00