Menu
I have the following YAML fragment:
description: | "API for bean consuming applications. Examples: painted pony, lima bean" Swagger editor interprets the colon (:) as a special character, despite the quotation marks.
According to the accepted answer to this question, the colon should not be treated as special character.
Is this a bug of Swagger or is an escape sequence needed to use the colon in quoted text literals?
I tried to find this out using the YAML specification but gave up.
How do I have to read that spec to answer the question?
Is there a difference between single quotes (') and double quotes (") in YAML?
Does the pipe (|) or the greater than (>) construction only influence the line break handling or the handling of special characters, too?
795
Use quotes in YAML if your value includes special characters. For example, these special characters may require quotes: {, }, [, ], ,, &, :, *, #, ?, |. -, <. >, =, !, %, @, \. It is not necessary to use quotes when a single special character is surrounded by spaces, for example, * with spaces on both sides.
In double quoted strings if you need to include a literal double quote in your string you can escape it by prefixing it with a backslash \ (which you can in turn escape by itself). In single quoted strings the single quote character can be escaped by prefixing it with another single quote, basically doubling it.
To add a space between characters of a string, call the split() method on the string to get a character array, then call the join() method on the array to join the characters with a space separator. The String split() method splits a string in an array of substrings, using the specified separator.
I would consider this a bug in swagger, but I have seen problems in other editors e.g. when highlighting YAML.
When a string scalar is surrounded by single quotes '....' the only escaping within that string that can be done is inserting a double single quote to indicate a single quote:
'It''s a good question' When double quotes, "....", go around a scalar string you use backslash (\) for escaping, and you have to escape at least the backslash and the double quotes. In addition you can escape other special characters like linefeed (\n) and escape an end-of-line by preceding it by a backslash.
The YAML spec says there is no way to escape characters inside literal scalars ( starting with |), so you cannot insert extra newlines, or other escape sequences withing these.
For the folded style (>), the escaping behaviour is as with literal scalars.
All string scalars except for plain scalars (those without any quotes or >/|) can contain : followed by space without problem, and if an editor interprets that differently, that is understandable (as full YAML parsing is expensive), but incorrect.
167
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
