Si un trait de soulignement est à la fois dans un nom Attribute
et dans sa valeur d'exemple, l'analyseur traite la ligne entière comme le nom d'attribut avec une valeur nulle.
Par exemple ce plan :
# GET /message
+ Response 200 (text/plain)
+ Attributes
+ some_thing: an_example_thing
L'analyse par Drafter donne ceci :
_version: "3.0"
metadata: []
name: ""
description: ""
element: "category"
resourceGroups:
-
name: ""
description: ""
resources:
-
element: "resource"
name: ""
description: ""
uriTemplate: "/message"
model: {}
parameters: []
actions:
-
name: ""
description: ""
method: "GET"
parameters: []
attributes:
relation: ""
uriTemplate: ""
content: []
examples:
-
name: ""
description: ""
requests: []
responses:
-
name: "200"
description: ""
headers:
-
name: "Content-Type"
value: "text/plain"
body: ""
schema: ""
content:
-
element: "dataStructure"
name: null
typeDefinition:
typeSpecification:
name: null
nestedTypes: []
attributes: []
sections:
-
class: "memberType"
content:
-
content:
name:
literal: "some_thing: an_example_thing"
description: ""
valueDefinition:
values: []
typeDefinition:
typeSpecification:
name: null
nestedTypes: []
attributes: []
sections: []
class: "property"
content: []
content:
-
element: "category"
content:
-
element: "resource"
name: ""
description: ""
uriTemplate: "/message"
model: {}
parameters: []
actions:
-
name: ""
description: ""
method: "GET"
parameters: []
attributes:
relation: ""
uriTemplate: ""
content: []
examples:
-
name: ""
description: ""
requests: []
responses:
-
name: "200"
description: ""
headers:
-
name: "Content-Type"
value: "text/plain"
body: ""
schema: ""
content:
-
element: "dataStructure"
name: null
typeDefinition:
typeSpecification:
name: null
nestedTypes: []
attributes: []
sections:
-
class: "memberType"
content:
-
content:
name:
literal: "some_thing: an_example_thing"
description: ""
valueDefinition:
values: []
typeDefinition:
typeSpecification:
name: null
nestedTypes: []
attributes: []
sections: []
class: "property"
content: []
De même, cela est mal analysé par Apiary et la syntaxe est mal mise en évidence.
Hé, si vous lisez la spécification MSON, vous pouvez voir que _ est un caractère réservé. Veuillez utiliser des backticks pour échapper au mot entier. Voici un exemple:
+ `some_thing`: `an_example_thing`
Veuillez noter qu'il y a une amélioration UX prévue au #210
Les gars, on peut faire ça :
+ Parameters
+ `grant_type`: `refresh_token` (string, required) - Tipo de concessão
Fonctionne très bien!
Semble pas vraiment. Si le paramètre et la valeur ont des traits de soulignement, JSON est rendu de manière incorrecte. Comme
+ aaa_bbb: `ccc_ddd` (string, required) - Example
Oui, dans ce cas, vous devez entourer aaa_bbb
avec `
Commentaire le plus utile
Hé, si vous lisez la spécification MSON, vous pouvez voir que _ est un caractère réservé. Veuillez utiliser des backticks pour échapper au mot entier. Voici un exemple:
Veuillez noter qu'il y a une amélioration UX prévue au #210