Parser is failing on description within response

[egiraudy]

According to the specification, a response may contain a description (see below), but the api-console parser fails when there is such an element.

From http://raml.org/spec.html:

/media/{mediaid}/content:
displayName: Content
get:
description: |
Get a media file.
responses:
200:
body:
"/":
description: |
Returns the media file.

Responses MAY contain a description property that further clarifies why the response was emitted. Response descriptions are particularly useful for describing error conditions.

[usarid]

Hmm, I just tried (in the APi Designer, which has the console embedded in it) and it's doing just fine:

#%RAML 0.8
title: Test
/:
  get:
    description: |
      The GET method
    responses:
      200:
        description: |
          The response to the GET method

What error are you getting, and could you attach the entire RAML file?

[egiraudy]

sorry, i should have been more accurate...

The parser fails when the description is under body or under the media-type:

Here is the error
"context":"while validating body","context_mark":null,"message":"property:
'description' is invalid in a body"

And here is an example:

#%RAML 0.8
title: Test
/:
get:
responses:
200:
body:
description: |
fail 1
application/xml:
description: |
fail 2

Also, after re-reading the spec, it is not clear if this is allowed of if
the example in the spec is wrong...

Thanks!

On Wed, Jul 9, 2014 at 9:21 AM, Uri Sarid notifications@github.com wrote:

Hmm, I just tried (in the APi Designer, which has the console embedded in
it) and it's doing just fine:

#%RAML 0.8title: Test/:
get:
description: |
The GET method
responses:
200:
description: |
The response to the GET method

What error are you getting, and could you attach the entire RAML file?

—
Reply to this email directly or view it on GitHub
#65 (comment).

[sichvoge]

That is definitely not valid RAML and I can't find the example in the spec anymore. Closing it for now