Update README.md

Author: LeFnord

.gitignore

@@ -30,4 +30,5 @@ Gemfile.lock
 # For MacOS:
 #
 .DS_Store
-.project
+.project
+example.json

Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gemspec
 
-case version = ENV['GRAPE_VERSION'] || '~> 0.9.0'
+case version = ENV['GRAPE_VERSION'] || '~> 0.13.0'
 when 'HEAD'
   gem 'grape', github: 'ruby-grape/grape'
 else

README.md

@@ -1,5 +1,7 @@
 # grape-swagger
 
+## *don't us it, it is a work in progress version, to upgrade to swagger 2.0 spec*
+
 [![Gem Version](https://badge.fury.io/rb/grape-swagger.svg)](http://badge.fury.io/rb/grape-swagger)
 [![Build Status](https://travis-ci.org/ruby-grape/grape-swagger.svg?branch=master)](https://travis-ci.org/ruby-grape/grape-swagger)
 [![Dependency Status](https://gemnasium.com/ruby-grape/grape-swagger.svg)](https://gemnasium.com/ruby-grape/grape-swagger)
@@ -95,7 +97,8 @@ Allow markdown in `detail`/`notes`, default is `nil`. (disabled) See below for d
 
 #### hide_format
 
-Don't add `.(format)` to the end of URLs, default is `false`.
+~~Don't add `.(format)` to the end of URLs, default is `false`.~~  
+`.(format)` would always be removed.
 
 #### api_version
 
@@ -501,17 +504,37 @@ end
 
 ## Response documentation
 
-You can also document the HTTP status codes with a description and a specified model that your API returns with the following syntax.
+You can also document the HTTP status codes with a description ~~and a specified model~~ that your API returns with one of the following syntax.
+
+``` ruby
+desc 'thing', http_codes: [ { code: 400, message: "Invalid parameter entry" } ]
+get '/thing' do
+  ...
+end
+```
+
+``` ruby
+desc 'thing' do
+  params Entities::Something.documentation
+  http_codes [ { code: 400, message: "Invalid parameter entry" } ]
+end
+get '/thing' do
+  ...
+end
+```
 
 ``` ruby
 get '/', http_codes: [
-  [200, 'Ok', Entities::Client],
-  [400, "Invalid parameter entry"]
+  { code: 200, message: 'Ok' },
+  { code: 400, message: "Invalid parameter entry" }
 ] do
   ...
 end
 ```
 
+If no status code is defined [defaults](/lib/grape-swagger/endpoint.rb#L121) would be taken.
+
+
 ## Contributing to grape-swagger
 
 See [CONTRIBUTING](CONTRIBUTING.md).

grape-swagger.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = 'A simple way to add auto generated documentation to your Grape API that can be displayed with Swagger.'
   s.license     = 'MIT'
 
-  s.add_runtime_dependency 'grape', '>= 0.8.0'
+  s.add_runtime_dependency 'grape'
   s.add_runtime_dependency 'grape-entity'
 
   s.add_development_dependency 'rake'
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rouge', '~> 1.6.1'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'awesome_print'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

lib/grape-swagger.rb

@@ -1,11 +1,14 @@
 require 'grape'
 require 'grape-swagger/version'
+require 'grape-swagger/endpoint'
 require 'grape-swagger/errors'
 require 'grape-swagger/doc_methods'
 require 'grape-swagger/markdown'
 require 'grape-swagger/markdown/kramdown_adapter'
 require 'grape-swagger/markdown/redcarpet_adapter'
 
+require "awesome_print"
+
 module Grape
   class API
     class << self
@@ -155,66 +158,68 @@ def standalone_sub_namespaces(name, namespaces)
         sub_namespaces
       end
 
-      def get_non_nested_params(params)
-        # Duplicate the params as we are going to modify them
-        dup_params = params.each_with_object({}) do |(param, value), dparams|
-          dparams[param] = value.dup
-        end
-
-        dup_params.reject do |param, value|
-          is_nested_param = /^#{ Regexp.quote param }\[.+\]$/
-          0 < dup_params.count do |p, _|
-            match = p.match(is_nested_param)
-            dup_params[p][:required] = false if match && !value[:required]
-            match
-          end
-        end
-      end
-
-      def parse_array_params(params)
-        modified_params = {}
-        array_param = nil
-        params.each_key do |k|
-          if params[k].is_a?(Hash) && params[k][:type] == 'Array'
-            array_param = k
-            modified_params[k] = params[k]
-          else
-            new_key = k
-            if !array_param.nil? && k.to_s.start_with?(array_param.to_s + '[')
-              new_key = array_param.to_s + '[]' + k.to_s.split(array_param)[1]
-              modified_params.delete array_param
-            end
-            modified_params[new_key] = params[k]
-          end
-        end
-        modified_params
-      end
-
-      def parse_enum_or_range_values(values)
-        case values
-        when Range
-          parse_range_values(values) if values.first.is_a?(Integer)
-        when Proc
-          values_result = values.call
-          if values_result.is_a?(Range) && values_result.first.is_a?(Integer)
-            parse_range_values(values_result)
-          else
-            { enum: values_result }
-          end
-        else
-          { enum: values } if values
-        end
-      end
-
-      def parse_range_values(values)
-        { minimum: values.first, maximum: values.last }
-      end
-
       def create_documentation_class
         Class.new(Grape::API) do
           extend GrapeSwagger::DocMethods
         end
       end
+
+
+      # def get_non_nested_params(params)
+      #   # Duplicate the params as we are going to modify them
+      #   dup_params = params.each_with_object({}) do |(param, value), dparams|
+      #     dparams[param] = value.dup
+      #   end
+      #
+      #   dup_params.reject do |param, value|
+      #     is_nested_param = /^#{ Regexp.quote param }\[.+\]$/
+      #     0 < dup_params.count do |p, _|
+      #       match = p.match(is_nested_param)
+      #       dup_params[p][:required] = false if match && !value[:required]
+      #       match
+      #     end
+      #   end
+      # end
+      #
+      # def parse_array_params(params)
+      #   modified_params = {}
+      #   array_param = nil
+      #   params.each_key do |k|
+      #     if params[k].is_a?(Hash) && params[k][:type] == 'Array'
+      #       array_param = k
+      #       modified_params[k] = params[k]
+      #     else
+      #       new_key = k
+      #       if !array_param.nil? && k.to_s.start_with?(array_param.to_s + '[')
+      #         new_key = array_param.to_s + '[]' + k.to_s.split(array_param)[1]
+      #         modified_params.delete array_param
+      #       end
+      #       modified_params[new_key] = params[k]
+      #     end
+      #   end
+      #   modified_params
+      # end
+      #
+      # def parse_enum_or_range_values(values)
+      #   case values
+      #   when Range
+      #     parse_range_values(values) if values.first.is_a?(Integer)
+      #   when Proc
+      #     values_result = values.call
+      #     if values_result.is_a?(Range) && values_result.first.is_a?(Integer)
+      #       parse_range_values(values_result)
+      #     else
+      #       { enum: values_result }
+      #     end
+      #   else
+      #     { enum: values } if values
+      #   end
+      # end
+      #
+      # def parse_range_values(values)
+      #   { minimum: values.first, maximum: values.last }
+      # end
+
     end
   end
 end