Come sfuggire ai due punti e ad altri caratteri speciali in una stringa YAML?

Question

Ho il seguente frammento YAML:

description: | 
    "API for bean consuming applications. 
    Examples: painted pony, lima bean" 

Swagger editor interpreta i due punti (:) come un carattere speciale, nonostante le virgolette.

In base alla risposta accettata allo this question, i due punti non devono essere considerati come caratteri speciali.

Si tratta di un errore di Swagger o di una sequenza di escape necessaria per utilizzare i due punti in letterali di testo quotati?

Ho cercato di scoprirlo usando lo YAML specification ma ho rinunciato.

Come devo leggere quella specifica per rispondere alla domanda?

C'è una differenza tra virgolette singole (') e virgolette (") in YAML?

La tubazione (|) o la struttura di dimensioni maggiori di (>) influisce solo sulla gestione dell'interruzione di linea o sulla gestione di caratteri speciali?

Answer 1

Considererei un errore in swagger, ma ho riscontrato problemi in altri editor, ad es. quando si evidenzia YAML.

Quando uno scalare stringa è circondato da single quotes'....' l'unica fuga all'interno di quella stringa che può essere fatto è l'inserimento di una doppia virgoletta per indicare una sola offerta:

'It''s a good question' 

Quando double quotes, "....", andare in giro un stringa scalare si utilizza la barra rovesciata (\) per l'escape e si deve sfuggire almeno la barra rovesciata e le doppie virgolette. Inoltre puoi sfuggire ad altri caratteri speciali come il linefeed (\n) e sfuggire a un fine riga precedendolo con una barra rovesciata.

Le specifiche YAML indicano che c'è no way to escape characters inside literal scalars (a partire da |), ma questo non è il modo, ad es. PyYAML si comporta (e mi rendo conto che neanche il mio ruamel.yaml). Con questi puoi usare il backslash per inserire per es. newlines extra.

Per lo stile piegato (>) non esiste un riferimento esplicito all'escaping o meno.

Tutti gli scalari stringa tranne scalari semplici (quelli senza le virgolette o >/|) può contenere : seguito da uno spazio senza problemi, e se un editore interpreta che in modo diverso, questo è comprensibile (come la piena YAML analisi è costoso), ma errato.

Answer 2

Ho avuto lo stesso identico problema e ho scoperto che l'utilizzo del codice di escape HTML funziona con :, che è quello a cui ho fatto ricorso.