Skip to content

Commit e7376c7

Browse files
authored
Merge pull request #28050 from microsoftgraph/author-api-docs-prompt-minor-updates
Minor updates
2 parents 59f94ec + 94aabab commit e7376c7

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

.github/prompts/author-api-docs.prompt.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,17 @@ Fully qualify any type (including enum types) that is defined in a subnamespace
297297
- For API methods: `{resourcename}-{operation}.md`
298298
- For subnamespace resources: `{subnamespace}-{resourcename}.md`
299299

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+
300311
**Beta disclaimer:**
301312
- All beta documentation must include the beta disclaimer immediately after the namespace declaration
302313
- Use the standard boilerplate text for beta disclaimers
@@ -1313,6 +1324,7 @@ When a new relationship is added to an existing resource:
13131324

13141325
3. **Update property description:**
13151326
- 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
13161328
- **For evolvable enums (if unknownFutureValue is last member):**
13171329
- Format: "The possible values are: `value1`, `value2`, `unknownFutureValue`."
13181330
- **For evolvable enums (if members follow unknownFutureValue):**
@@ -1335,12 +1347,19 @@ Document within the **Properties** section of the resource that uses the enum. T
13351347

13361348
1. **Create H3 section after Properties table:**
13371349
- Title: "{enum-type} values"
1350+
13381351
- **For evolvable enums (if members follow unknownFutureValue):**
13391352
- Add introductory text before the table:
13401353
```markdown
13411354
The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations).
13421355
Use the `Prefer: include-unknown-enum-members` request header to get the following members in this evolvable enum: `value3`.
13431356
```
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+
```
13441363

13451364
2. **Create table:**
13461365
- Columns: **Member** and **Description**
@@ -1381,6 +1400,7 @@ Create a dedicated topic for the enumeration. This option is rarely applicable.
13811400
1. **Create enum topic:**
13821401
- Title: "{enum-type} enum type"
13831402
- 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.
13841404
- **For evolvable enums:** Mention it's an evolvable enumeration
13851405

13861406
2. **Add Members H2 section:**

0 commit comments

Comments
 (0)