Документирование параметров запроса с помощью API Blueprint
Я пытаюсь задокументировать параметр запроса в API Blueprint, но я не совсем уверен, правильно ли я это сделал. Ресурс выглядит так:
DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}
Этот запрос деактивирует пользователя, в то время как следующий объект удалит объект пользователя:
DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true
Это уценка Blueprint для этого:
## 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
Однако при рендеринге с использованием пасеки я вижу толькоforce
в списке параметров, но теперь это показано в примере URL. Это только я неправильно понимаю GUI или параметры запроса должны быть задокументированы другим способом?