Swagger документация: Как обновить содержимое тела - PullRequest
0 голосов
/ 14 апреля 2020

Я новичок в документации по swagger API, так что ищу вашу поддержку. Я на пути к созданию локона. В редакторе swagger я написал ниже код в разделе определения

definitions: 
  Instrument_users:
    type: "object"
    required:
    - "proposal_id" 
    - "user_id" 
    - "data_access_role"
    properties:
      proposal_id:
        type: "integer"
        example: "244"
      user_id:
        type: "integer"
        example: "1010"        
      data_access_role:
        type: "integer"
        example: "2"    
        default: "2"
    xml:
      name: "Instrument_users"    

, который генерирует тело, как указано ниже в правой части редактора

{
  "proposal_id": "244",
  "user_id": "1010",
  "data_access_role": "2"
}

Какой код мне нужен напишите, чтобы ожидать ниже содержания тела в правом разделе чванства

{ "proposal_user":
{
  "proposal_id": "244",
  "user_id": "1010",
  "data_access_role": "2"
}}

Спасибо

1 Ответ

1 голос
/ 16 апреля 2020

Вы должны написать это:

definitions:
  Instrument_users:
    type: "object"
    properties:
      proposal_user:
        type: "object"
        properties:
          proposal_id:
            type: "string"
            example: "244"
          user_id:
            type: "string"
            example: "1010"
          data_access_role:
            type: "string"
            example: "2"
...