Документирование параметров запроса с помощью схемы элементов API

Я пытаюсь задокументировать параметр запроса в API Blueprint, но я не совсем уверен, правильно ли я это сделал. Ресурс выглядит следующим образом: 

DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}

Этот запрос деактивирует пользователя, в то время как следующий удалит объект пользователя: 

DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true

Вот план уценки, который у меня есть для этого: 

## 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. Неужели это только я? неправильное понимание графического интерфейса или параметры запроса должны быть задокументированы другим способом?

2 12
apiary.io

2 ответа:

Ваш чертеж в полном порядке, проблема в том, что текущая документация пасеки не обрабатывает параметры URI правильно.

Не могли бы вы попробовать новую документацию? Он должен правильно обрабатывать параметры URI.

Параметры URI

Edit

Правильный шаблон URI должен быть: 

http://baasar.apiary-mock.com/user/{appId}/{userId}{?force}
13

Мой локон запрос: 

curl -k -u username:password https://api.techie8.io/api/1.0/bits?bit_type=1

План пасеки: 

## Bits Collection [/bits?bit_type={bit_type}]

### List Latest bits [GET]

List all bits recently inserted into database.

+ Parameters
    + bit_type (number, optional, `1`) ... Type of bit to retrieve: 1: Bits, 2: Newsletter
0