Unable to use json arrays in API Blueprint response

[TUNER88]

Example

/**
 * Show all categories
 *
 * Get a JSON representation of all the categories.
 *
 * @Get("/{?page,pageSize}")
 * @Versions({"v1"})
 * @Parameters({
 *      @Parameter("page", description="The page of results to view.", default=1),
 *      @Parameter("pageSize", description="The amount of results per page.", default=20)
 * })
 * @Response(200, body={"data": "foo", "bar": []})
 */
public function index(Request $request)
{
}

Generates following error message:

[Doctrine\Common\Annotations\AnnotationException]                                                                            
[Syntax Error] Expected PlainValue, got '\' at position 407 in method App\Http\Controllers\Api\CategoryController::index().  

How can I escape [ and ]?

[lightvision]

It's a parser limitation. The answer was already here on closed issues, but instead of [] you must use {}.

[TUNER88]

@lightvision array and object are different datatypes, it so dread API tests would fail. Documentation and real API should return same responses, otherwise the documentation is incorrect.

[lightvision]

You must {} in documentation. When rendered it will have the correct [] for responses. And to be complete: its an annotaion parser limitation. Check your generated md documentation file and you will see the correct formated response.

[jasonlewis]

As @lightvision has said it's a limitation of the parser. But the resulting documentation that's generated will be correct. You just need to use curly braces in your docblocks, even for arrays.

[jasonlewis]

Perhaps one day I'll see if I can find away around the limitation, but it's not a big issue right now.

[TUNER88]

Thx, I've got it. Some notes about this limitation in docs would be really nice.