Commit Graph

127 Commits

Author SHA1 Message Date
Renier Morales 6b89d4a67f Recurse combination of namespaces when using mounted apps.
Added test and changelog entry.
2014-08-03 18:00:05 -04:00
Cédric Darné 30e8c9257c Fixed model inclusion in models with aliased references. 2014-08-01 07:31:05 -04:00
Antek Drzewiecki f1e91ce990 Added value support for grape enties. 2014-07-30 15:49:04 +02:00
Antek Drzewiecki fd5dfb2b5b Added support for values in form parameters 2014-07-30 12:02:46 +02:00
Daniel Doubrovkine (dB.) @dblockdotorg e81d3052e3 Merge pull request #124 from dblock/api-desc-and-params
Added ability to change the description and parameters of the API endpoints generated by grape-swagger.
2014-07-28 07:43:03 -04:00
Dieter Späth 10e903aef9 combined global models with endpoint entities 2014-07-24 16:11:10 +02:00
dblock 001bb86c28 Fixed undefined method reject for nil:NilClass error on an undefined route. 2014-07-22 10:24:05 -04:00
dblock e1773cd7b7 Added ability to change the description and parameters of the API endpoints generated by grape-swagger. 2014-07-22 09:35:12 -04:00
Daniel Doubrovkine (dB.) @dblockdotorg 28f1bc0c1b Merge pull request #100 from maginatics/FW-Port
Should be able to override the generated nicknames
2014-07-17 07:21:42 -04:00
Dieter Späth 860da153d3 Added support for generating nested models from composed Grape Entities. 2014-07-16 12:20:10 -04:00
Leon Horne 5c9317cdea Adding override of auto generated nickname
Swagger has a nickname filed specified in the 1.2 standard. It is used
to generate an alternate name for code generators to use for that api.
This patch provides a way to override the generated nickname with one
specified in the grape documentation.

    Example:
          desc(
            'Get all the cloud profiles in the system',
            :nickname => 'getAllCloudProfiles',
          )
2014-07-15 19:48:46 -07:00
Tim Warberg ef70deed8d Allow markdown in the API info description. 2014-07-14 11:35:03 -04:00
Renier Morales df82041313 Added support for namespace descriptions. 2014-07-14 11:26:27 -04:00
Levente Bagi 982f71a254 Allow customizing entity name. 2014-07-14 11:09:17 -04:00
Levente Bagi 99b143051a Added responseModel support. 2014-07-14 11:04:15 -04:00
moe 03f1dabf8e Fixed mapping of default to defaultValue. 2014-07-14 10:29:46 -04:00
dblock 26facf470d Added Rubocop, Ruby-style linter. 2014-07-14 09:59:11 -04:00
dblock 642c9bf816 Rewritten .gemspec and removed Jeweler. 2014-07-14 09:36:45 -04:00
Craig S. Cottingham 50e968c93e Fix specs 2014-05-30 11:21:23 -05:00
Craig S. Cottingham 14e4afa82b Convert data types to defined Swagger types 2014-05-30 09:41:51 -05:00
Craig S. Cottingham 865acf999c Allow returning arrays 2014-05-30 09:41:34 -05:00
Craig S. Cottingham 2f35d85bb8 Add #is_primitive? and #generate_typeref 2014-05-28 15:09:06 -05:00
Craig S. Cottingham d205202ddc Fix non-reentrantness in #parse_entity_models 2014-05-28 14:42:32 -05:00
Craig S. Cottingham 9a9d85f56d Change the way required properties in models are indicated in the JSON 2014-05-28 14:34:12 -05:00
Craig S. Cottingham 50541bdf2a Clean up authorizations 2014-05-28 13:51:18 -05:00
Craig S. Cottingham 4302ea187d Clean up commented-out code 2014-05-28 11:29:54 -05:00
Craig S. Cottingham 60e3012a7f Fix API paths and add a default description 2014-05-28 11:23:41 -05:00
Craig S. Cottingham 239a348e8b Remove unneeded (and disallowed according to spec) elements from the root documentation 2014-05-28 10:42:54 -05:00
Craig S. Cottingham f88ada91a7 Fix file upload elements 2014-05-28 10:42:27 -05:00
Craig S. Cottingham 26e13fa9c5 Clean up output in lib/grape-swagger.rb 2014-05-27 13:21:02 -05:00
Craig S. Cottingham a25e9ef5a6 Add comment to add authorizations to operations 2014-05-26 15:49:58 -05:00
Craig S. Cottingham af690af14e Check for complex types in parse_params 2014-05-12 16:46:00 -05:00
Craig S. Cottingham 55fc2206cf Clean up after merge of PR #104 2014-05-12 15:15:23 -05:00
Craig S. Cottingham 376a327212 Merge branch 'refs/heads/pr/104' into swagger-ui
Conflicts:
	lib/grape-swagger.rb
2014-05-12 14:46:38 -05:00
Craig S. Cottingham b69cdaaa93 Correctly handle arrays of items and complex types in params 2014-05-12 12:54:54 -05:00
Craig S. Cottingham 87c8c7b638 Properly describe arrays in parse_entity_models() 2014-05-12 11:30:06 -05:00
Craig S. Cottingham 32ea455b08 Lots of changes to make API doc compatible with swagger-ui
Conflicts:
	README.markdown
	lib/grape-swagger.rb
2014-05-12 11:29:03 -05:00
Mauro Torres 6691ba2faf Adds support for models and body param type 2014-04-24 16:53:24 -03:00
Tim Vandecasteele ff90e1c387 Revert removal of swagger_doc prefix in apis listing. 2014-02-05 09:03:29 +01:00
Tim Vandecasteele 67f72f0b15 Render markdown as GFM, especially for code blocks. 2014-02-04 14:01:16 +01:00
Tim Vandecasteele 598d028db0 Revert Merge pull request #84 from MongoHQ/gfm
Compatibility with jruby was lost.
2014-02-04 13:55:18 +01:00
Jon Daniel 225c91e10a added formatting options to swagger metadata
Trying to use the current version of grape-swagger with swagger-ui resulted in
some headaches because by default grape-swagger generates API meta-data in XML
but swagger-ui and the rest of our APIs at my organization are expecting JSON.

To solve this problem I added a section to setup options called `:formatting`.
This hash can accept `:format`, `:default_format`, and
`:default_error_formatter`. These options can be passed in when calling
`add_swagger_documentation`.

Example

```ruby

add_swagger_documentation format: :json

```
2014-02-04 11:42:43 +01:00
Caleb Woods fb75eedf16 Adding support for form parameters for PUT and PATCH method types 2014-02-04 10:57:37 +01:00
dm1try 64fb8e90a9 if base_path is relative make it absolute using request.base_uri 2014-02-04 10:34:07 +01:00
Tim Vandecasteele 317c29b597 Update spec for datatype and add in headers. 2014-02-04 10:32:43 +01:00
Phobos98 a8bc4c9748 Add dataType to the params output 2014-02-04 10:30:10 +01:00
Tim Vandecasteele 5400575aa9 When no default value given, also don't put it in the json. 2014-02-04 10:26:27 +01:00
John Griffin accf771041 support defaultValue on params and headers 2014-02-04 10:14:31 +01:00
Jerome Gravel-Niquet b548623bd3 Follow 1.2 specs more precisely. 2014-02-04 10:03:54 +01:00
Jerome Gravel-Niquet 37b66aca31 DRYing the entity name parsing 2014-02-04 09:30:28 +01:00