rspec_api_documentation-open_api 0.2.2 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dd0494e891fbd0fee7a0103bcfae6a13bc696e97805bf087cbf759e5c55f8275
4
- data.tar.gz: 5f945c77b66e94560cd627bba6890bbc8abdc4708a05f1aa89f23ca709f08a20
3
+ metadata.gz: 1dde492d63d90024fe9422a60071ef652d73edc41f25f1d1e853d9a0be6b779d
4
+ data.tar.gz: 18302d402309fdfbc801674956396382d3361db4e9ad1b72f3a070238fdc5689
5
5
  SHA512:
6
- metadata.gz: 26b079ad9a3e6d87cc17d6164dd488bd1fddb3d1ee970726c8ee48fc4b00507967a76f13f8a07b80aee98d5e52f0b82adc3abef98fa3ae5ed84ebd1bb28b7191
7
- data.tar.gz: ab2b1d2612725ea551d24507b52bf3fcc954d8c462556f46adb2038e05319065202c094a5a29b6688cc1ca0209222aadb7a23c9ce3f65795bd0e6889837cbcb8
6
+ metadata.gz: 3703c3af28fc4f6d654d1cd7162593c83a41918a9b4964e7349237776a2cdf44d9455af875dd54debdcb082abf41a8fe0a783fba6ee4b178704c1a59d92dc2fd
7
+ data.tar.gz: 22f5038f469058ac6fb6d542c1a9fb3cabfd6319dc13c464c54effed6150350b85a1fe42b86254d8e9aef6b13600afb0276b91562cdeadbc45236b7c11c57386
data/README.md CHANGED
@@ -1,28 +1,27 @@
1
1
  # RspecApiDocumentation::OpenApi
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec_api_documentation/open_api`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ Adds `open_api_json` and `open_api_yaml` output format to `rspec_api_documentation`.
4
+ This gem is developed to be used at [Cookpad](https://github.com/cookpad/) to create openAPI spec using [`rspec_api_documentation`](https://github.com/zipmark/rspec_api_documentation) gem.
6
5
 
7
6
  ## Installation
8
7
 
9
8
  Add this line to your application's Gemfile:
10
9
 
11
10
  ```ruby
12
- gem 'rspec_api_documentation-open_api'
11
+ gem 'rspec_api_documentation-open_api', '~>0.2.2'
13
12
  ```
14
13
 
15
14
  And then execute:
16
15
 
17
16
  $ bundle
18
17
 
19
- Or install it yourself as:
18
+ Or install it yourself by:
20
19
 
21
20
  $ gem install rspec_api_documentation-open_api
22
21
 
23
22
  ## Usage
24
23
 
25
- in *spec/spec_helper.rb* Put
24
+ in *spec/spec_helper.rb* add
26
25
  ```rb
27
26
  RspecApiDocumentation.configure do |config|
28
27
  config.format = :open_api_json # for json file
@@ -35,8 +34,8 @@ RspecApiDocumentation.configure do |config|
35
34
  end
36
35
  ```
37
36
 
38
- Change default host and servers spec using
39
- ```
37
+ You can change other default configuration using
38
+ ```rb
40
39
  RspecApiDocumentation.configure do |config| # These are defaults
41
40
  config.open_api = {
42
41
  "info": {
@@ -70,7 +69,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
70
69
 
71
70
  ## Contributing
72
71
 
73
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec_api_documentation-open_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
72
+ Bug reports and pull requests are welcome on GitHub at https://github.com/aadityataparia/rspec_api_documentation-open_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
74
73
 
75
74
  ## License
76
75
 
@@ -78,4 +77,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
78
77
 
79
78
  ## Code of Conduct
80
79
 
81
- Everyone interacting in the RspecApiDocumentation::OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec_api_documentation-open_api/blob/master/CODE_OF_CONDUCT.md).
80
+ Everyone interacting in the RspecApiDocumentation::OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aadityataparia/rspec_api_documentation-open_api/blob/master/CODE_OF_CONDUCT.md).
@@ -1,5 +1,5 @@
1
1
  module RspecApiDocumentation
2
2
  module OpenApi
3
- VERSION = "0.2.2"
3
+ VERSION = "0.2.3"
4
4
  end
5
5
  end
@@ -88,7 +88,7 @@ module RspecApiDocumentation
88
88
  }
89
89
  }
90
90
  }
91
- }
91
+ } if !responses["401"]
92
92
  [{ "bearerAuth" => [] }]
93
93
  else
94
94
  [{ "basicAuth" => [] }]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rspec_api_documentation-open_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.2.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Aaditya Taparia
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-05-30 00:00:00.000000000 Z
11
+ date: 2018-06-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rspec_api_documentation