如何解决“ readOnly”属性可以成为OpenAPI中PUT / POST的一部分吗?
如果在OpenAPI中将属性定义为readOnly
,是否可以合理地说它可以作为请求的一部分而不是可变的?
在潜在的用例中,id
被标记为readOnly
,并且 MAY 是有效负载的一部分,作为资源子集合的一部分。如果包含id
,则引用该子集合的资源。
{
"a","b","lorems": [
{
// he's talking about ME! *blush*
"id": "abc123","name": "A new name for the existing object"
}
]
}
OpenAPI规范中的语言是否可能只是模糊到可以接受?
解决方法
readOnly属性包含在响应中,但不包含在请求中
来源:Read-Only and Write-Only Properties
我对这句话的理解是:您应该不在请求中包含该属性。
我认为他们在writeOnly
部分说得更清楚:
writeOnly属性可以在请求中发送,但不能在响应中发送
我理解的方式是“不应仅将writeOnly用于响应”。使用相同的逻辑,我将readOnly
句子理解为“不应在请求中使用readOnly”。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。