POST parameters support in RAML

Question

I'd like to ask if there is any support for POST parameters in RAML. And if there is - what is the syntax. I've browsed spec 0.8 and spec 1.0 roughly (actually I'm bound to 0.8, since many tools don't support 1.0 yet). I didn't find POST parameters support, but maybe I just missed something.

So what do I mean by POST parameters? These can be either of the two (sorry, I don't know their formal names, if there are any):

• HTTP plain parameters, key=value, each parameter in one line, such as

  name=John Doe amount=5 which is not really handy (e.g. no nesting)

• parameters as JSON object, just a JSON with all its syntax allowed (server-side needs to parse this json); such as:

  {"name":"John Doe","amount":"5"}

Different server-side API implementations use either 1st or 2nd one. Anyway, how does RAML support these?

Answer 1

As it is shown in this reference https://github.com/raml-org/raml-spec/wiki/Breaking-Changes:

For raml 0.8:

body:
  application/x-www-form-urlencoded:
    formParameters:
      name:
        description: name on account
        type: string
        example: Naruto Uzumaki
      gender:
        enum: ["male", "female"]

Is the equivalent in raml 1.0 to:

body:
  application/x-www-form-urlencoded:
    properties:
      name:
        description: name on account
        type: string
        example: Naruto Uzumaki
      gender:
        enum: ["male", "female"]

So what it changes is the formParameters attribute to the properties one.