是";评论「;OpenAPI3.0规范或Swagger编辑器中的受保护字?
我目前正在使用Swagger编辑器(v3.1.9)和OpenAPI3规范编写API规范 我得到了一些特殊的行为,特别是我命名的模式组件是";评论「;OpenAPI3.0规范或Swagger编辑器中的受保护字?,swagger,swagger-editor,openapi,Swagger,Swagger Editor,Openapi,我目前正在使用Swagger编辑器(v3.1.9)和OpenAPI3规范编写API规范 我得到了一些特殊的行为,特别是我命名的模式组件Comment Comment: description: "A comment on an asset or submission" allOf: - $ref: "#/components/schemas/Message" type: object properties: parent: on
Comment
Comment:
description: "A comment on an asset or submission"
allOf:
- $ref: "#/components/schemas/Message"
type: object
properties:
parent:
oneOf:
- $ref: "#/components/schemas/Asset"
- $ref: "#/components/schemas/Submission"
在UI中,它呈现为(无消息继承)
但是,如果我将其重命名为其他名称,比如commentation
,它将完全呈现(从消息继承):
我能想到的唯一一件事是,在openapi规范或Swagger编辑器中的任何一个或两个中都有一个保留的注释词。我想知道的主要问题是,这是否真的是一个bug,或者我是否应该避免使用这个名称(如果是这样的话,如果我应该避免使用任何其他名称)不,
Comment
不是保留字。您的模式是正确的
模式呈现问题似乎是一个现已修复的bug。您的模式在最新的Swagger编辑器中正确呈现
Comment {
description: A comment on an asset or submission
parent {
oneOf -> {
}
v {
}
}
}
Commentary{
description: A comment on an asset or submission
id string($uuid)
example: f1907c82-2c5f-4f60-8cd9-12647d411822
author User{...}
body string
example: Lorem ipsum dolor sit amet
message_type string
example: DiscussionPost
parent {
oneOf -> Asset{...}
Submission{...}
}
}