grape-swagger icon indicating copy to clipboard operation
grape-swagger copied to clipboard

Add OAPI/swagger v2.0 compliant documentation to your grape API

Results 136 grape-swagger issues
Sort by recently updated
recently updated
newest added

This is based on another PR #880 as it relies on changes to the default parameter type. As per #883, this adds support for primitive type query parameters.

Although `GrapeSwagger::DocMethods::OperationId.build` implements a mangling algorithm to generate an operation ID from a path and method, it can lead to duplicates such as `/api/v4/projects/{id}` and `/api/v4/projects{id}` both evaluating to the...

As documented in the [OpenAPI v2 spec](https://swagger.io/docs/specification/2-0/adding-examples/), the `example` keyword only appears in schema objects and not parameter objects. If the `example` keyword appears in a parameter object, the OpenAPI...

As per the [OpenAPI v2 documentation](https://swagger.io/specification/v2/#fixed-fields-7), `If type is "file", the [consumes](https://swagger.io/specification/v2/#operationConsumes) MUST be either "multipart/form-data", " application/x-www-form-urlencoded" or both and the parameter MUST be [in](https://swagger.io/specification/v2/#parameterIn) "formData".` Currently, `grape-swagger` processes...

Ruby on Rails supports [optional path segments](https://guides.rubyonrails.org/routing.html#bound-parameters), such as: ``` get 'photos(/:id)' ``` would match both `photos/:id` and `photos` paths. However, `grape-swagger` does not recognise these optional path segments. For...

Hi, A repo I'm working on was working perfectly until the recent update from grape-swagger 1.4.2 to 1.5 where I started getting rackup errors . ``` .asdf/installs/ruby/3.1.2/lib/ruby/gems/3.1.0/gems/bundler-2.3.20/lib/bundler/rubygems_integration.rb:308:in `block in replace_bin_path':...

Right now, the description of the model is automatically written as "{MODEL_NAME} Model" and put in the swagger docs. How do we override that?

While trying to improve some parts of Grape, I came across an error in your gem since my code had removed `@options` in `Grape::Router::Route`. This PR replaces the `instance_variable_get` by...

This is rebased version of the branch [oapi-3](https://github.com/ruby-grape/grape-swagger/tree/oapi-3) from #744 Current state: ``` Finished in 11.31 seconds (files took 0.94256 seconds to load) 644 examples, 34 failures, 2 pending ```

I'm using Grape with grape-swagger, entities and representable. Everything works very well (over several projects) until I add this API: ``` module SearchService module Api class Queries < SearchService::App desc...