Api-blueprint: параметры с подчеркиванием, которые имеют примерные значения с подчеркиванием, не работают

Созданный на 12 февр. 2016 · 7Комментарии · Источник: apiaryio/api-blueprint

## Underscores [/somepath/{?template_type}]

### Get Underscores [GET]

Parameters
  + template_type: advocacy_post (string, required) the template type 
...

Не работает. Всегда интерпретирует сквозные подчеркивания как нечто странное и вызывает синтаксические ошибки. Попытки избежать их с помощью% 5f не работают, потому что параметр не проходит должным образом в консоли при выполнении запроса. Единственное, что я обнаружил, что работает, - это убрать второе подчеркивание и сделать параметр следующим образом:
+ template_type: advocacy post (string, required) the template type
Я могу обойтись этим, но это не очень хорошо, потому что в образце должен быть подчеркивание. Все допустимые значения для этого параметра имеют подчеркивание, поэтому я могу заставить его работать, только вставив примерное значение, которое никогда не сработает.

Language Awaiting Validation Question

Источник

bennettellis

👍2

Самый полезный комментарий

Ключи и значения параметров, содержащие зарезервированный символ ( _ ), должны быть экранированы (заключены в обратные кавычки).

+ Parameters
    + `template_type`: `advocacy_post` (string, required) the template type

Примечание : _Существует известная проблема [ составитель # 123 ] с использованием обратных кавычек в параметрах.

kylef 12 февр. 2016

👍6 👎1

Все 7 Комментарий

+ Parameters
    + `template_type`: `advocacy_post` (string, required) the template type

kylef 12 февр. 2016

👍6 👎1

обратные кавычки не решают проблему.

bennettellis 12 февр. 2016

👍1

@kylef, поскольку это стоит, касается параметров, а не атрибутов (параметры на данный момент используют другой механизм синтаксического анализа)

zdne 15 февр. 2016

Комментарий @kylef теперь должен работать в парсере

pksunkara 6 апр. 2016

Привет.

Эта проблема решена? У меня аналогичная проблема, когда наш идентификатор сеанса имеет подчеркивание, и я получаю предупреждение Parser, что

specifying parameter 'appointment_hub_session_id (string, required, `ejMPAfFLPd2W_NCieglc4Y4hfBlPE4xI-IpwYNJOKMdBbXqiZGAJXfVL0icgmROgIs5V7GWBe5SSuusb1MFEQw' as required supersedes its default value, declare the parameter as 'optional' to specify its default value on line 51

Чертеж API:

+ Parameters

    + appointment_hub_session_id (string, required, `ejMPAfFLPd2W_NCieglc4Y4hfBlPE4xI-IpwYNJOKMdBbXqiZGAJXfVL0icgmROgIs5V7GWBe5SSuusb1MFEQw==`) - Id of appointment hub session.

Если я изменю « _ » на « - », все будет работать нормально и предупреждений не будет.

С наилучшими пожеланиями.

daniyel 25 апр. 2018

Да, думаю, это было. В то время, когда я ввел эту проблему, обратные кавычки для параметров не работали. Не совсем уверен, когда это было исправлено, но я знаю, что они работают. Вам нужно сделать что-то вроде упомянутого выше экранирования обратной кавычки, поэтому для меня это было:

+ Parameters: 

    + `template_type`: `advocacy_post` (enum[string], required) - the template type

Однако ваш синтаксис неверен, поэтому дело не только в обратных кавычках, но и в том, как вы указали параметр. Вы действительно хотите что-то вроде этого (я временно добавил это в свою документацию по пасеке для тестирования, и он прошел проверку и отлично работает).

+ Parameters

    + `appointment_hub_session_id`: `ejMPAfFLPd2W_NCieglc4Y4hfBlPE4xI-IpwYNJOKMdBbXqiZGAJXfVL0icgmROgIs5V7GWBe5SSuusb1MFEQw==` (string, required) - Id of appointment hub session

Надеюсь, это поможет.

О, также вы НЕ должны избегать обратных кавычек в шаблоне URI.

bennettellis 25 апр. 2018

👍1

@bennettellis Спасибо за быстрый ответ. Ваше решение сработало.

daniyel 25 апр. 2018

Была ли эта страница полезной?

0 / 5 - 0 рейтинги