Кураж наследования в объектах

Question

Я хочу, чтобы документировать некоторые завернутые JSon документы:

Action: 
    required: 
     - description 
     - name 
    properties: 
     description: 
     type: string 
     format: string 
     name: 
     type: string 
     format: string 
    Actor: 
    required: 
     - gpn 
    properties: 
     gpn: 
     type: string 
     format: string 
    Object: 
    required: 
     - image 
     - type 
     - url 
    properties: 
     image: 
     type: string 
     format: string 
     type: 
     type: string 
     format: string 
     url: 
     type: string 
     format: string 
    CreateActivity: 
    required: 
     - action 
     - actor 
     - object 
     - title 
     - externalID 
    properties: 
     action: 
     $ref: Action 
     actor: 
     $ref: Actor 
     object: 
     $ref: Object 
     title: 
     type: string 
     format: string 
     externalID: 
     type: string 
     format: string 

И Я это с $ref в Swagger

пути:

/activity: 
    get: 
     description: Returns an activity 
     operationId: fetchActivity 
     produces: 
     - application/json 
     parameters: 
     - name: externalActivityID 
      in: query 
      required: true 
      type: string 
     responses: 
     200: 
      description: existing activity 
      schema: 
      $ref: CreateActivity 
     default: 
      description: unexpected error 
      schema: 
      $ref: ErrorModel 

Результат ISN» (кроме того, я копировал подход из зоомагазина). Я хочу, чтобы объект со связанными записями (т. Е. Action, Actor и Object находятся в CreateActivity с именами полей) и связали запрос с объектом CreateActivity.

Скриншоты показывают реальную ситуацию:

Объект с отсутствующими "подобъектов"

И недостающее звено в документации развязность:

Answer 1

Это известная проблема с редактором swagger.

Пожалуйста, смотрите здесь - https://github.com/swagger-api/swagger-editor/issues/217.

Кроме того, когда вы используете "type": "string", нет необходимости добавлять "format":"string", так как он не содержит никакой информации. Поле "format" используется для точного определения "type".