Swagger：refで説明を追加

Question

彼の定義が参照するオブジェクトプロパティに説明を追加します。そのような何か：

 newCreditCard: 
     type: object 
     properties: 
      billingPhone: 
      description: Phone number of the card holder 
      $ref: "#/definitions/PhoneNumber" 

しかし、エディタはdescriptionプロパティがスキップされますことを警告：

Extra JSON Reference properties will be ignored: description 

私は（しかし闊歩UIのため、編集者のために働く少ないエレガントな回避策を発見しましたわからないことは、あなたのSwaggers仕様でそれを行うにはどうすればよい闊歩UIの3.0.2バージョン）

 newCreditCard: 
     type: object 
     properties: 
      billingPhone: 
      description: Phone number of the card holder 
      allOf: 
      - $ref: "#/definitions/PhoneNumber" 

に最新のアップデートによるものもありますか？

ありがとうございました！

Answer 1

同じレベルの$refに何かを追加すると、無視されます。

JSON $ refを定義https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3

正しい方法は、参照されるオブジェクトに説明を提供することです。

Answer 2

descriptionプロパティをPhoneNumberの定義に移動するだけで済みます。あなたのオリジナルのポストは、あなたがPhoneNumberを定義しているか表示されませんが、このスニペットは、警告なしに検証します。

definitions: 
    phoneNumber: 
    type: string 
    description: Phone number of the card holder 

    newCreditCard: 
    type: object 
    properties: 
     billingPhone: 
     $ref: "#/definitions/phoneNumber" 

この答えはあなたが探しているものでない場合は、質問を言い換えてください。私たちはあなたが達成しようとしていることを知る必要があります。