Перечисление сообщений об ошибках в описании сервиса api-blueprint - PullRequest
Новая
       28

Перечисление сообщений об ошибках в описании сервиса api-blueprint

0 голосов
/ 24 мая 2019

Допустим, у меня есть следующее описание сервиса api-blueprint: 

# Group Example

## GET /api/rest/Example{?p}

This service generates a unique ID.

+ Parameters

    + `p` (string, required) - some text

+ Response 200 (application/json)

    + Attributes (object)

        + `hash` (string) - hash value
        + `success` (enum[number]) - value for request
            + Members
                + `0`
                + `1`
        + `error` (number) - error number in case of unsuccessful request
        + `error_text` (string) - error message in case of unsuccessful request

Поле ошибки в моем ответе представляет собой числовое значение от 1 до 2, например, 

1 => incorrect username
2 =< incorrect password

Как я могу перечислить эти сообщения об ошибках также в описании проекта? Я уже пытался определить поле ошибки как enum, но в этом случае в целевом HTML-файле отображаются только номера ошибок, и сообщения будут игнорироваться.
Для рендеринга я использую aglio.

...