Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

RAML validation fails with ":" in description #258

Closed
kumaranae opened this issue May 19, 2017 · 9 comments
Closed

RAML validation fails with ":" in description #258

kumaranae opened this issue May 19, 2017 · 9 comments
Assignees

Comments

@kumaranae
Copy link

Hi Team,

we have a JaxRS API with documentation that contains ":" in it, like "HH:MM:SS". Once we generated a RAML file using Maven plugin, i tried to validate the RAML file using online validation tools. Its fails saying error as below,

Underlying error while parsing YAML syntax: 'mapping values are not allowed here in 'reader', line 126, column 41: ... description: cancels the job: stops the job's execution and ... ^

If am correct, the description should be closed with double quote which will escape the ":" character.

Regards,
Kumaran.A.E

@jpbelang
Copy link
Contributor

Ok, know where that is. Will fix in the week-end.

@jpbelang
Copy link
Contributor

I did a fairly narrow fix: if a line ends with a ":", I quote. Is this your use case ?

@jpbelang jpbelang self-assigned this May 19, 2017
@kumaranae
Copy link
Author

Below snippet from my RAML,

/firmwareUpgradeBatch/{batchName}/cancel:
post:
description: cancels the job: stops the job's execution and sets its status to canceled

@jpbelang
Copy link
Contributor

My mistake: it's not just ending. it's ": ". I'll make it more general.

Thanks.

@jpbelang
Copy link
Contributor

Try it again. Thanks for your input, BTW.

@kumaranae
Copy link
Author

Hi.

This changed worked as expected. thanks for your quick response. Please let me know once you merged it.

@jpbelang
Copy link
Contributor

jpbelang commented May 22, 2017

It should be merged end of May (for 2.0.1).

Thanks.

@kumaranae
Copy link
Author

Hi,

Where can i find this fix?

@jpbelang
Copy link
Contributor

Right now only in 2.0.1 branch.

@jstoiko jstoiko closed this as completed Jul 12, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants