Changes

Latest

6.1.0

backward compatibility to use json or JSON in format configuration, pull request
Fixes API Blueprint route's always grouping, pull request

6.0.0

Recognize JSON API response as JSON, pull request
Parameters accept a value option for fixed values, pull request
Fixes undefining client_method when set to the same client_method, pull request
Remove special chars from dirnames, pull request
Fix API blueprint documentation, pull request
Change extension for Markdown from .markdown to .md, pull request
Change Json classnames to JSON, pull request
Add index template and api explanation for Slate formatter, pull request
Slate resource explanation, pull request
Add OpenAPI Specification support (Version 2.0), pull request
API Blueprint view object respects required: false for parameters now, pull request
Documentation obromios, pull request

5.1.0

Allow skipping documentation for a whole spec, pull request
Add common api description before resources sections (closes #354), pull request
Fix integer as header value, pull request
Don't evaluate original parameter name when custom method is provided , pull request

5.0.0

Use tables to represent markdown response fields, pull request
Use direct path to rake file, pull request
Turn off URL globbing parser for curl get requests, pull request
Fixes example: incompatibility with Ruby >= 2.4 (Integer unification), pull request
Clean out uploaded data from arrays, pull request
Fix Slate template, pull request
Adds API Blueprint, pull request

4.9.0

Feature/slate generator tweaks, pull request
Another attempt at adding explanations to resources, pull request
Use tables to represent markdown parameters, pull request
Ignore case sensitivity when filtering headers, pull request
Custom parameter method, pull request
Remove all windows-illegal characters from filenames, pull request
Make SlateWriter output cURL cmd in separate tab, pull request
Escape query_strings in DSL , pull request
Fix formatting of nested response_field scopes, pull request
Rely on tilde versioning for rspec, pull request

4.8.0

Update license, pull request
remove json as a runtime dependency, pull request
Add a writer for Slate, pull request

4.7.0

JSON Content-Type matcher is more inclusive, pull request
rename config post_body_formatter to be request_body_formatter, pull request
Pass rspec the right --order option (default or defined), pull request
Allow Class Resources, call #to_s for defined resource_name, pull request
Ensure that DIRECTORY_MAPPINGS is available, pull request

4.6.0

infer response_field description from name + scope, pull request
Fix Content-Type Header, pull request

4.5.0

added 'route' url and http 'method' for all JsonIndex examples, pull request
disable_dsl_* methods documentation
Ability to set nested scopes, pull request
Remove ASCII_8BIT encoded data from response body
Pretty print JSON in response body
Set value of nested params, pull request
Infer parameter description from scope, pull request
Only load railtie if Rails::Railtie is defined, pull request

4.4.0

Fix for #to_json on empty hash creating bad params payload, pull request
extra_params use Hash#deep_merge! instead of merge, pull request
Show headers section only if the associated string is present, pull request
Remove explanation escaping, pull request
Add explanation method to documentation, pull request
Add acceptance to RSpec::Rails::DIRECTORY_MAPPINGS, pull request
Remove <p> style from default stylesheet, pull request
ClientBase#clean_out_uploaded_data
Configuration for disabling the status DSL
Allow resource name be a Class, pull request
Remove leading slashes from dirname, pull request
headers ending in "id" are displayed correctly, pull request
Test against latest ruby and rspec 3.x, pull request
Add bundler gem tasks, pull request

4.3.0

Fix required css style, pull request
encoding request_body to utf-8 for Chinese post params, pull request
Make DSL work with config.disable_monkeypatching!, pull request
Add HttpTestClient, pull request

4.2.0

Ensure response_body is escaped in html_example template, pull request
Add basic stylesheet to generated HTML, pull request
Don't generate JSON if raw_post is defined, pull request
Remove rspec version strictness, pull request

4.1.0

Set a default post body formatter, pull request
Use Rack::Utils.parse_nested_query instead of a custom implementation, issue

4.0.0

Set gem version requirements in the gemspec
Upgrade to rspec 3, pull request
Support non-ascii characters in description, pull request
Add response_field DSL, pull request

3.1.0

Restrict to rspec version 2.x
Markdown format, pull request

3.0.0

Add config options #response_headers_to_include and #request_headers_to_include, pull request
Fix cURL generation when nil headers are passed, pull request
Add license to gemspec, pull request
Rake task to generate docs in same order as specs, pull request
Pull out a cURL user when using basic auth, pull request, pull request
Fix uploaded data breaking docs generation, issue
Strip out non ascii characters in generated documentation, issue
All writers inherit from base writer, pull request
Add writer that appends to generated documentation instead of completely overwriting, pull request
Require ruby 2.0.0 to pass on travis
No longer require webmock unless you're using OAuth2MACClient
Escape cURL header values, issue
Allow cURL header filtering, issue
Remove ruby 1.9.2 support on travis
Decode HTTP Basic Authentication header and generate cURL example command with username and password, pull request

2.0.0

Remove deprecated DSL methods
Add in textile writer, pull request
Allow parameter to not be call for extra parameters to work, pull request
Set headers in example level, issue

1.1.0

Update minimum RSpec to 2.14
Deprecate required_parameters for :require => true options on parameter calls
Deprecate scope_parameters for :scope => 'scope' options on parameter calls
Move default folder to doc/api, issue

1.0.0

Remove assets, pull request
Move writers into RspecApiDocumentation::Writers namespace
Remove unknown class Examplegroup, pull request
Fixed: If only the exclusion filter was set then it was ignored
Better format of cURL headers, issue
Generate nicer JSON, pull request

0.9.2

Add deprecation notices for Wurl and notice for assets being removed in HTML output.

0.9.1

Update cURL output for HEAD and PATCH

0.9.0

Letting a header, example
Serialize arrays and hashes properly, pull request
Fix for do_request and extra parameters containing path params and query string params, pull request
Fix curl output, pull request
Add route and method to outputted JSON, pull request
Allow nil params, pull request

0.8.0

Add an empty space between multiple responses in combined text writer
Writer for IODocs [thanks areina]
Support multibyte descriptions [thanks mataki]

0.7.1

Fix flipped request and response keys in template

0.7.0

Combined text writer for Raddocs
Added api_name configuration, which affects the HTML output.
Added response_status alias to status if you have status as a variable in a spec
Removed passing headers into ClientBase, you set headers via the DSL header "Accept", "application/json", see #36
- If you are subclassing any client base and overriding the headers call, it now accepts a fourth parameter, headers, that are the headers based on the specs.
url_prefix now has a leading / and no trailing /

0.6.0

Added wURL - Thanks TildeWill
- Use the WurlWriter to try it out

0.5.2

Split out DSL into multiple source files
Update for latest rspec

0.5.1

Bug fixes around requiring dependencies

0.5.0

Remove Rack::Test hard dependency
JSON keys in a request changed:
- method -> request_method
- route -> request_path
TestClient became RackTestClient in removing Rack::Test
OAuth2MACClient added, currently only supports client credentials
last_response was hidden, use one of the following methods to access responses data
- response_headers
- status
- response_body
helper methods added for asserting on callbacks
- request_method
- request_headers
- request_body

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Changes

Changes

Latest

6.1.0

6.0.0

5.1.0

5.0.0

4.9.0

4.8.0

4.7.0

4.6.0

4.5.0

4.4.0

4.3.0

4.2.0

4.1.0

4.0.0

3.1.0

3.0.0

2.0.0

1.1.0

1.0.0

0.9.2

0.9.1

0.9.0

0.8.0

0.7.1

0.7.0

0.6.0

0.5.2

0.5.1

0.5.0

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally