You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/prompts/author-api-docs.prompt.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -297,6 +297,17 @@ Fully qualify any type (including enum types) that is defined in a subnamespace
297
297
- For API methods: `{resourcename}-{operation}.md`
298
298
- For subnamespace resources: `{subnamespace}-{resourcename}.md`
299
299
300
+
**Linking to API and resource files:**
301
+
- When linking from an API file to a resource file or enum file, always prefix the link path with `../resources/`
302
+
- When linking from a resource file to an API file, always prefix the link path with `../api/`
303
+
- When linking from a resource file to another resource file or enum file, always prefix the link path with `../resources/`
304
+
- When linking from an API file to another API file, always prefix the link path with `../api/`
305
+
- Examples:
306
+
- From API file: `[user](../resources/user.md)`
307
+
- From API file: `[security alert](../resources/security-alert.md)`
308
+
- From resource file: `[Get security alert](../api/security-alert-get.md)`
309
+
- From resource file: `[alertStatus](../resources/security-alertstatus.md)`
310
+
300
311
**Beta disclaimer:**
301
312
- All beta documentation must include the beta disclaimer immediately after the namespace declaration
302
313
- Use the standard boilerplate text for beta disclaimers
@@ -1313,6 +1324,7 @@ When a new relationship is added to an existing resource:
1313
1324
1314
1325
3.**Update property description:**
1315
1326
- List all possible values in the description
1327
+
-**For flagged enums:** Add "This flagged enumeration allows multiple members to be selected simultaneously." before listing the possible values
1316
1328
-**For evolvable enums (if unknownFutureValue is last member):**
1317
1329
- Format: "The possible values are: `value1`, `value2`, `unknownFutureValue`."
1318
1330
-**For evolvable enums (if members follow unknownFutureValue):**
@@ -1335,12 +1347,19 @@ Document within the **Properties** section of the resource that uses the enum. T
1335
1347
1336
1348
1.**Create H3 section after Properties table:**
1337
1349
- Title: "{enum-type} values"
1350
+
1338
1351
-**For evolvable enums (if members follow unknownFutureValue):**
1339
1352
- Add introductory text before the table:
1340
1353
```markdown
1341
1354
The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations).
1342
1355
Use the `Prefer: include-unknown-enum-members` request header to get the following members in this evolvable enum: `value3`.
1343
1356
```
1357
+
-**For flagged enums:**
1358
+
- Append the following boilerplate text to the introductory text before the table:
1359
+
```markdown
1360
+
The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations).
1361
+
Use the `Prefer: include-unknown-enum-members` request header to get the following members in this evolvable enum: `value3`. This flagged enumeration allows multiple members to be selected simultaneously.
1362
+
```
1344
1363
1345
1364
2.**Create table:**
1346
1365
- Columns: **Member** and **Description**
@@ -1381,6 +1400,7 @@ Create a dedicated topic for the enumeration. This option is rarely applicable.
1381
1400
1.**Create enum topic:**
1382
1401
- Title: "{enum-type} enum type"
1383
1402
- Single sentence describing the enum's purpose
1403
+
-**For flagged enums:** Append "This flagged enumeration allows multiple members to be selected simultaneously." to the introductory text.
1384
1404
-**For evolvable enums:** Mention it's an evolvable enumeration
0 commit comments