Set default format to be .json.

[sunnyrjuneja]

Fixes:
https://github.com/tim-vandecasteele/grape-swagger/issues/244
ruby-grape/grape-swagger-rails#11

Perhaps more. Not sure if we need any specs for this.

[dblock]

I definitely think we should have specs, some behavior has changed, right?

[dblock]

It also needs a CHANGELOG and an UPGRADING entry.

[dmitry]

Since that change is it possible to access to the resources with the .json extension postfix?

[dmitry]

@whatasunnyday can you please update changelog and upgrading files?

[sunnyrjuneja]

@dmitry Sure.

[dmitry]

@whatasunnyday 👍
@dblock I believe everything is ready to be merged now.

[dblock]

hide => hid

[dblock]

I still think this needs a test! We're changing behavior, what prevents a future committer to revert it?

[sunnyrjuneja]

I actually agree 100% but I'm quite confused the current state of the tests. The tests fail for grape 0.10.0 to 0.11.0 but pass on HEAD. Why is this?

I was thinking to change https://github.com/tim-vandecasteele/grape-swagger/blob/master/spec/default_api_spec.rb, specifically:

    subject do
      get '/swagger_doc'
      JSON.parse(last_response.body)
    end

to

    subject do
      get '/swagger_doc.json'
      JSON.parse(last_response.body)
    end

but the tests pass even though I changed format: :json. I do not understand if the tests are testing anything at all!

[sunnyrjuneja]

Also, the tests here should be folded into default_api_spec.rb.

https://github.com/tim-vandecasteele/grape-swagger/blob/master/spec/non_default_api_spec.rb#L583-L612

Update:

I've removed areas in the tests that specify format: :json. I moved the test that checked if format: :json worked correctly into the default api spec. Is this the right idea? Should I change where the tests call for /swagger_doc to /swagger_doc.json and /swagger_doc/resource to /swagger_doc/resource.json? Will this solve the failing tests? Would like guidance before moving forward.

[dblock]

Right, we are likely missing tests around this, this is a good time to add them.

With your change Grape 0.10.0, 0.11.0, etc. are broken by default. So we can't ship this, it looks like it's as simple as requesting with .json vs. without .json, but I am not 100% sure what to do about it. Either way we want this PR not to break any tests ;)

[LeFnord]

please re-target against swagger-1.2 branch or close