在swagger API文档中将部分描述切换为内部

问题描述

我有一个用草率记录的API,我想进行某种切换以使描述的某些部分成为内部。

parameter:
  - name: abc
    description: |
      line1
      line2
      line3
在上面的示例中,

可以引入某种形式的切换,以便在最终文档中不显示第3行。我正在使用openapi-filter.js将对象和属性标记为x-internal,但是我不知道如何执行此操作来切换描述的一部分。

解决方法

OpenAPI中没有功能(据我所知,Swagger中还没有)可隐藏您所描述的部分描述。建议您使用自己的x-internal-info字段或可以为适当的受众群体解析的内容。抱歉,这不是您想要的答案!