blue_bird

blue_bird copied to clipboard

Implement support to generate Swagger Documentation. See: https://github.com/KittyHeaven/blue_bird/pull/12

rhazdon

We should add warnings - if path parameters or query parameters are missing in api documentation

woylie

Array query params

5

I'm going to preface this by saying I don't think this is [supported by API Blueprint right now](https://github.com/apiaryio/api-blueprint/issues/240), but I figured it could be useful as work continues on Swagger...

mmcc

Define best practices for defining api docs centrally

1

Currently, all the api doc macros are meant to be used within the controllers. It might be better if some definitions (i.e. shared parameters, warnings etc.) would be defined in...

woylie

Including request body XML in output documentation

4

My test: ```elixir test "creates support_request and returns support_request ID when data is valid", %{conn: conn} do body = ~s( #{@create_attrs.sampler_id} #{@create_attrs.contact_name} #{@create_attrs.contact_email} #{@create_attrs.title} #{@create_attrs.details} ) conn = conn |>...

DavidOliver

Path, query and body params should be handled better. * Define shared parameters globally. * Support API Blueprint [attributes section](https://apiblueprint.org/documentation/specification.html#def-attributes-section) * Support Swagger [schema object](https://swagger.io/specification/#schema-object-80) * Support Swagger [parameters definition...

woylie

Sharing params

1

We have quite a few query parameters that are shared across many routes, so it makes a lot of sense for us to share as much as we can there....

mmcc

Right now, BlueBird doesn't support api versioning. Everything is put into one single documentation. However, a version must be specified in Swagger. I suggest to gradually add support for api...

woylie

False warning for put/patch when using resources macro

3

`Phoenix.Router.resources` defines both a PATCH route and a PUT route for the `:update` operation. In your controller, you will only have one function for both routes, and that means, you...

woylie