Skip to content

Documentation obromios #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oestrich merged 7 commits into from
Aug 23, 2018
Merged

Documentation obromios #387

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0c3d328
Change declaration in gemfile for raddocs
Jul 30, 2018
ab3c6b7
Add :html option to config.format in acceptance_helper
Jul 31, 2018
7742d4a
Make README documentation clearer for Viewers section
Jul 31, 2018
eb9079c
Alter example spec section
Jul 31, 2018
522a909
Annotate the Sample App section of the REAMDE
Jul 31, 2018
e70edb3
Upgrade nokogiri to fix security flaw
Jul 31, 2018
93e7684
Revise README to leave in open_api example spec
Jul 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add :html option to config.format in acceptance_helper 
At present, only option is :open_api, but this does not
produce output that is easily readable by user.

When the problem with the :json option is fixed see issue
#382
I suggest that :json option is added as well, users can
see output using raddocs.
  • Loading branch information
Chris Drane committed Jul 31, 2018
commit ab3c6b7e9192ae874b471a47befcd0ea89c4c9ac
2 changes: 1 addition & 1 deletion example/spec/acceptance_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'rspec_api_documentation/dsl'

RspecApiDocumentation.configure do |config|
config.format = [:open_api]
config.format = [:open_api, :html]
config.curl_host = 'http://localhost:3000'
config.api_name = "Example App API"
config.api_explanation = "API Example Description"
Expand Down