Adding version to path only possible via configuration key 'version'?

[cank]

This is for grape-swagger (0.20.2).

Not sure if this is a bug or an undocumented configuration option, but I am unable to get the version to correctly appear in the JSON file under 'paths' unless I do the following:

add_swagger_documentation(
  version: 'v1',
  add_version: true,
)

This will produce:

"paths": {
  "/api/v1/experiments": {
  }
}

The configuration instructions in README.md lists api_version as a configuration option, but not version. This is clearly the intended behavior as shown here:

grape-swagger/lib/grape-swagger/doc_methods/path_string.rb

Line 16 in 7913a9e

if options[:version] && options[:add_version]

and in tests here:

https://github.com/ruby-grape/grape-swagger/blob/master/spec/lib/path_string_spec.rb

Should the documentation be updated to reflect this?

[dblock]

Yes definitely. This is probably something that was added recently by @LeFnord. Thanks for contributing!

[LeFnord]

thanks for pointing …

[LeFnord]

have a look on it … #405

[LeFnord]

corrected behaviour:

• version of the API, also used in a path would be taken from grape version
• the documentation version could be set via doc_version

this could be confusing, but I think the intention of that is, one have a gem/engine, where the API would be implemented, this could be a semantic version, and should also be documented …

[ZeroInputCtrl]

the add_swagger_documentation version should be in the upgrade guide as it used to be api_version.

[dblock]

@BaneOfSerenity I think you make a good point, would you please contribute?

[ZeroInputCtrl]

@dblock would be glad to, i should have something by the end of the day. ^.^