Skip to content

update readme to reflect JSON format class in pr #359 #401

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

Closed
wants to merge 1 commit into from
Closed

update readme to reflect JSON format class in pr #359 #401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Consider adding a viewer to enhance the generated documentation. By itself rspec

```ruby
RspecApiDocumentation.configure do |config|
config.format = :json
config.format = :JSON
end
```

Expand Down Expand Up @@ -188,7 +188,7 @@ RspecApiDocumentation.configure do |config|
config.docs_dir = Rails.root.join("doc", "api")

# An array of output format(s).
# Possible values are :json, :html, :combined_text, :combined_json,
# Possible values are :JSON, :html, :combined_text, :combined_json,
# :json_iodocs, :textile, :markdown, :append_json, :slate,
# :api_blueprint, :open_api
config.format = [:html]
Expand Down Expand Up @@ -245,7 +245,7 @@ RspecApiDocumentation.configure do |config|
end

# Change how the post body is formatted by default, you can still override by `raw_post`
# Can be :json, :xml, or a proc that will be passed the params
# Can be :JSON, :xml, or a proc that will be passed the params
config.request_body_formatter = Proc.new { |params| params }

# Change how the response body is formatted by default
Expand Down