apiblueprint - 如何在 API Blueprint(MSON) 中引用枚举值

Question

我正在使用 API Blueprint和 Agilo呈现我的 API 文档。使用枚举类型时，我观察到一种奇怪的行为。响应未显示定义的枚举值，而架构显示所有枚举值(这是预期的)以及声明的值(“星期一”- 引用实际值)。

数据结构部分

# Data Structures

## Days (enum[string])
+ `Monday`
+ `Tuesday`
+ `Wednesday`
+ `Thursday`

## ListEntry
- playOrder: 1 (number)
- Id: 37a21975a499494f03367 (string)
- programDay: `Tuesday` (Days)

## `sample-request-200`
- id: 58828b2941cc351348 (string)
- startDate: `2019-08-01T11:00:00.000Z` (string)
- endDate: `2019-08-05T11:55:59.000Z` (string)
- Language: `en-US` (string)
- entries: ListEntry (array[object])

API 请求文档部分

+ Request
+ Headers

        Content-Type: application/json

+ Attributes (sample-request-200)

实际

---- JSON Body ----  

    {
      "playOrder": 1,
      "Id": "37a21975a499494f03367",
      "programDay": "Hello, world!" // Agilo shows "Hello,World" when some error occurred
    }

-----Generated Schema-----  

"programDay": {
              "type": "string",
              "enum": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Monday"
              ]
            }

欲购

 ---- JSON Body ----
    {
      "playOrder": 1,
      "Id": "37a21975a499494f03367",
      "programDay": "Monday"
    }


-----Generated Schema-----  

"programDay": {
              "type": "string",
              "enum": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday"
              ]
            }

关于如何使用 API 蓝图 (MSON) 中定义的枚举数据结构的任何想法。不确定如何引用对象中的枚举值。

使用如下引用枚举值是否正确？

- programDay: `Tuesday` (Days)

Answer 1

结构:

# Data Structures
## Device (enum)
+ `mobile`
+ `desktop`

像这样使用:

+ Request (multipart/form-data)
    + Attributes
        + `id`: abc (required)
        + `device` (Device)

结果: