不推荐的AsyncApi标记通道

Question

我目前正在使用AsyncApi编写API文档。我找不到一个将频道标记为不推荐的例子，有人知道怎么做吗？我试过如下所示，但是在访问api时，没有可见的通道被废弃的迹象。

channels:
  queuing.XXX:
    description: >
      ....
    publish:
      message:
        oneOf:
          - name: XXX
            description: >
              ...
            deprecated: true
            payload:
              $ref: '#/components/schemas/XXX'
...

Answer 1

在当前的AsyncAPI规范中(在编写版本2.4.0时)，您只能在模式对象中使用deprecated关键字。如果您认为在规范中应该允许拒绝消息对象(如您的示例中所示)或通道/操作对象，您可以为该https://github.com/asyncapi/spec/issues创建问题，甚至可以为较新版本的规范创建机箱建议。

您可以检查一下规范在这里的样子，https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md

Answer 2

无法使用某些特殊属性在AsyncAPI中指定不推荐的信道。

请加入AsyncAPI规范库-> https://github.com/asyncapi/spec/issues/305中的相关讨论，并分享您对建议的解决方案的看法。

目前，我们只听取了与维护不同规范(如AsyncAPI、OpenAPI和JSON )相关的人员的意见，而没有从需要它的用户那里得到多少信息。