Documentando parâmetros de consulta com o API Blueprint
Estou tentando documentar um parâmetro de consulta no API Blueprint, mas não tenho certeza se o fiz corretamente. O recurso fica assim:
DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}
Essa solicitação desativaria o usuário, enquanto o seguinte excluiria o objeto de usuário:
DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true
Esta é a remarcação do Blueprint que tenho para isso:
## User [/user/{appId}/{userId}]
Handle user objects
+ Parameters
+ appId (required, number, `1`) ... Application ID (`appId`)
+ userId (required, number, `1`) ... Numeric `userId` of the User object to manage
### Remove an User [DELETE]
+ Parameters
+ force (optional, boolean, `false`) ... Set to `true` to remove instead of deactivate
+ Response 204
No entanto, ao renderizar isso com o Apiary, vejo apenasforce
na lista de parâmetros, mas agora é mostrado no URL de exemplo. Isso é apenas eu que entendi mal a GUI ou os parâmetros de consulta devem ser documentados de outra maneira?