スワッガーファイル（YAML）の説明をオーバーロードしています

Question

スワッガーファイルを書き込む際に問題があります。私がパラメータを記述するとき、記述はこの同じパラメータの$ refの記述によってオーバーロードされます（下記の例を参照してください）。

a-body: 
    description: The body 
    type: object 
    properties: 
     my_param: 
     description: Full description 
     $ref: '#/definitions/reference' 

definitions: 
    reference: 
     type: object 
     required: [req] 
     description: an http reference 
     properties: 
      req: 
      type: string 

結果： the description is overloaded

は、誰かが私はこの通過してください得るのを助けることができますか？

Answer 1

$refは、すべての兄弟プロパティを上書きします。つまり、$refの動作です。あなたは、のようなものを使用してこの問題を回避しようとすることができます：

my_param: 
    description: Full description 
    allOf: 
    - $ref: '#/definitions/reference' 

これが闊歩エディタと闊歩UIで動作します。

feature requestがOpenAPI仕様リポジトリにあり、$refを他のプロパティと組み合わせるより良い方法を提供します。