RAML как документировать вложенные параметры

Как документировать вложенные параметры (независимо от запроса или тела) с помощью RAML? Например:

{ 
  "credentials: {
    "login": "some-login",
    "key": "some-key"
  }
}

documentation raml
person Sebastian    schedule 22.05.2015    source источник
comment
Что вы имеете в виду под вопросом или телом?   -  person David Dossot    schedule 22.05.2015
comment
@DavidDossot Я имел в виду, что независимо от того, передавал ли я параметры в запросе URL или в сообщении.   -  person Sebastian    schedule 23.05.2015
comment
Под запросом вы имеете в виду раздел запроса URI?   -  person David Dossot    schedule 23.05.2015

Ответы (1)


arrow_upward
0
arrow_downward

Это объект JSON, поэтому его необходимо указать в схеме JSON и называть его запрос или ответ.

person David Dossot    schedule 22.05.2015
comment
Да, но как насчет параметров postbody, у которых должна быть такая схема? - person Sebastian; 23.05.2015
comment
Из вашего комментария под вопросом кажется, что эти параметры также могут быть переданы как параметры запроса. Здесь вы, кажется, предлагаете передать их в сущности тела как application/x-www-form-urlencoded или multipart/form-data. Измените свой вопрос и сделайте более понятными различные сценарии, которые вы хотите поддерживать. - person David Dossot; 23.05.2015