为什么 Apiary 中的属性总是根据需要显示在文档中,即使设置为可选?
Why do attributes in Apiary always show in the documentation as required even though set to optional?
我在数据结构部分创建了一个对象:
## User Base (object)
+ first_name: John (optional, string)
+ last_name: Doe (optional, string)
+ birthday: `1980-12-20` (optional, string)
+ email: john.doe@foo.com (optional, string)
+ password: secret (optional, string)
然后在其适当的资源中,我在我的请求操作中使用该对象:
### Create a new user [POST]
+ Request (application/json)
+ Attributes (User Create)
+ Response 201
在我的文档中,它仍然总是像下图一样显示它是必需的(描述也没有显示在那里)。然而,在生成的 JSON 模式中,一切都是它应该的。
这是一个错误,一个尚未完全支持的功能,还是我在我的标记中做错了什么?
不到 18 小时前确认存在错误:https://github.com/apiaryio/api-blueprint/issues/218
这是已知错误 (https://github.com/apiaryio/api-blueprint/issues/218),我们正在处理它。
谢谢。
我在数据结构部分创建了一个对象:
## User Base (object)
+ first_name: John (optional, string)
+ last_name: Doe (optional, string)
+ birthday: `1980-12-20` (optional, string)
+ email: john.doe@foo.com (optional, string)
+ password: secret (optional, string)
然后在其适当的资源中,我在我的请求操作中使用该对象:
### Create a new user [POST]
+ Request (application/json)
+ Attributes (User Create)
+ Response 201
在我的文档中,它仍然总是像下图一样显示它是必需的(描述也没有显示在那里)。然而,在生成的 JSON 模式中,一切都是它应该的。
这是一个错误,一个尚未完全支持的功能,还是我在我的标记中做错了什么?
不到 18 小时前确认存在错误:https://github.com/apiaryio/api-blueprint/issues/218
这是已知错误 (https://github.com/apiaryio/api-blueprint/issues/218),我们正在处理它。
谢谢。