How to document QueryBuilder parameters?

[anychmguy]

Hi
I'm usin https://github.com/spatie/laravel-query-builder in my API, which requires parameters like:

https://example.org/api/cars?filter[model_id]=1&filter[brand_id]=2

But when trying to write API Blueprint for this, this package does not render well those parameters.

I tried the following variations:

But it does not print nothing in the parameters section

Also tried encoding the characters

But it prints the codes instead of the characters:

Also tried escaping the parameters:

but it does not print the parameters section

[M165437]

Thanks! I will have a look.

[M165437]

@anychmguy API Blueprint doesn't support associative arrays as url parameteres. Have a look at the discussion of api-blueprint/issues/240. There is an MSON RFC proposal addressing this issue, but it hasn't been implemented yet.

In the meantime, plain parameters are an easy way to add basic filtering:

## Cars [/cars{?model}{&brand}]

Cars API

### Gets a list of cars [GET]

Get the list of registered cars

+ Request
    + Headers

        Authorization: Bearer <token>

+ Parameters
    + model: `123` (number) - Model of the Car
    + brand: `456` (number) - Brand of the Car