@@ -30,6 +30,25 @@ To make using the specs in these contexts easier, follow these guidelines:
30
30
- Use inline Markdown links judiciously.
31
31
Don't link to readily searchable information, such as internet RFCs or Uncyclopedia.
32
32
33
+ ### Markdown in long descriptions
34
+
35
+ Operations and parameters may need more information that can fit in one sentence.
36
+ In that case, split your descriptions into two or more paragraphs:
37
+
38
+ ``` yaml
39
+ description : |
40
+ First sentence as short description (no markdown, just plain text).
41
+
42
+ More information in separate paragraphs after an empty line.
43
+ You can use **Markdown** here.
44
+ ` ` `
45
+
46
+ Use the ` |` character to write multi-line descriptions.
47
+
48
+ The first sentence can be used as a _short description_ in environments that don't support Markdown,
49
+ such as the [Algolia CLI](https://github.com/algolia/cli/).
50
+ After an empty line, you can provide more context.
51
+
33
52
# # Capitalization
34
53
35
54
In general, follow the capitalization of the API.
@@ -170,15 +189,6 @@ but you can expand it.
170
189
Add paragraphs with more information that users might need when using this endpoint,
171
190
such as limitations, side effects, or any other information that can't be expressed in the schema.
172
191
173
- Use the ` | ` character for multiline descriptions:
174
-
175
- ``` yaml
176
- description : |
177
- A multiline description.
178
-
179
- Multi-paragraph even.
180
- ` ` `
181
-
182
192
# # Properties and parameter descriptions
183
193
184
194
Use a noun phrase to describe what the parameter represents, without articles.
0 commit comments