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
+41-37Lines changed: 41 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,18 @@ Once the author responds, follow the appropriate workflow below.
30
30
31
31
## Common Setup and Processes
32
32
33
-
The following sections describe setup steps and processes that are common to both documentation scenarios. Reference these sections as needed during your workflow.
33
+
The following sections describe setup steps and processes that are common to all documentation scenarios. Reference these sections as needed during your workflow.
34
+
35
+
### Source Priority for Conflict Resolution
36
+
37
+
When information conflicts between sources, use this priority order:
38
+
39
+
1.**Documentation Plan** (highest authority — defines scope and intent of the changes)
40
+
2.**API.md** (authoritative for API behavior and descriptions)
41
+
3.**Doc stubs** (structural template — use for metadata, types, and autogenerated content)
42
+
4.**Existing documentation** (reference for patterns and consistency)
43
+
44
+
If a conflict is significant, flag it to the author in the final summary but follow the priority order above to proceed without blocking.
34
45
35
46
### Common Setup: Verify Working Branch
36
47
@@ -63,13 +74,13 @@ How to determine values to replace TODO placeholders in the following front matt
63
74
Before beginning any documentation process, instruct the author to add all required files to the `temp-docstubs` folder in this workspace:
64
75
65
76
**For Scenario 1 (Fresh APIs / beta changes):**
66
-
- Autogenerated doc stubs (*.md files from Graph Studio)
77
+
- Autogenerated doc stubs (*.md files)
67
78
- API.md file describing the capabilities being added/changed
68
79
- Autogenerated changelog file (changelog_*.json)
69
80
70
81
**For Scenario 2 (Promotion from beta to v1.0):**
71
82
- Documentation Plan documenting what is being promoted
72
-
-**Optional:**Autogenerated doc stubs (*.md files from Graph Studio for v1.0)
83
+
-**Optional:**Autogenerated doc stubs (*.md files for v1.0)
73
84
- Autogenerated changelog file (changelog_*.json)
74
85
75
86
**Important notes about temp-docstubs:**
@@ -113,7 +124,7 @@ After authoring documentation, update the appropriate changelog file in the `cha
113
124
-**IMPORTANT:** A changelog record is NOT just the ChangeList array. A complete changelog record consists of:
- API method files in beta include an autogenerated national cloud support statement immediately before the `## Permissions` header. Example include statement for all clouds support:
- Remove this include statement when promoting to v1.0
422
+
402
423
---
403
424
404
425
## Scenario 1: Author fresh APIs / fresh API changes to beta
@@ -408,7 +429,7 @@ Fully qualify any type (including enum types) that is defined in a subnamespace
408
429
**See [Common Setup: temp-docstubs Folder](#common-setup-temp-docstubs-folder)** for instructions on setting up the temp-docstubs folder.
409
430
410
431
For this scenario, the author should add these files to `temp-docstubs`:
411
-
- Autogenerated doc stubs (*.md files from Graph Studio)
432
+
- Autogenerated doc stubs (*.md files)
412
433
- API.md file describing the capabilities being added/changed
413
434
- Autogenerated changelog file (changelog_*.json)
414
435
@@ -520,7 +541,7 @@ After gathering all inputs, analyze the Documentation Plan to understand the ful
520
541
521
542
For this scenario, the author should add these files to `temp-docstubs`:
522
543
- Documentation Plan documenting what is being promoted
523
-
-**Optional:**Autogenerated doc stubs (*.md files from Graph Studio for v1.0)
544
+
-**Optional:**Autogenerated doc stubs (*.md files for v1.0)
524
545
- Autogenerated changelog file (changelog_*.json)
525
546
526
547
#### Input 1: Documentation Plan
@@ -1000,7 +1021,7 @@ Based on the documentation plan, the work will fall into two categories:
1000
1021
-**Target locations:**
1001
1022
- API method files go in `${workspaceFolder}/api-reference/beta/api/` or `${workspaceFolder}/api-reference/v1.0/api/`
1002
1023
- Resource files go in `${workspaceFolder}/api-reference/beta/resources/` or `${workspaceFolder}/api-reference/v1.0/resources/`
1003
-
- Permissions files go in `${workspaceFolder}/api-reference/beta/includes/permissions/` or `${workspaceFolder}/api-reference/v1.0/includespermissions/`
1024
+
- Permissions files go in `${workspaceFolder}/api-reference/beta/includes/permissions/` or `${workspaceFolder}/api-reference/v1.0/includes/permissions/`
1004
1025
1005
1026
### 2. Updates to existing reference files
1006
1027
-**Source:** Existing files in the microsoft-graph-docs repository
@@ -1151,7 +1172,7 @@ When authoring or updating documentation, ensure compliance with these standards
- Actions/functions: Use name without binding parameter
1153
1174
- For update operations, verify the return type: If the response is a `204` response code, the return type column should say "None"; it should not list a resource type
1154
-
-Root resources might not have any properties or methods; the sections should still be present with "None." as the content
1175
+
-Root resources might not have any properties or methods; the sections should still be present with "None." as the content
1155
1176
- Document any navigation properties in the Relationships section
1156
1177
1157
1178
**Properties:**
@@ -1249,7 +1270,11 @@ Before working on any file, apply these rules to both resource and API files:
1249
1270
4.**Methods table:**
1250
1271
-**For Entity Type resources:**
1251
1272
- Only Entity Type resources might have a Methods table, but not always
1252
-
- {to be filled later}
1273
+
- Consult the Documentation Plan and API.md to determine which operations (List, Create, Get, Update, Delete, actions, functions) are supported for this resource
1274
+
- Add only the supported methods to the Methods table using the format from the autogenerated doc stub
1275
+
- Use succinct method names (avoid repeating the resource name); for CRUD operations use: List, Create, Get, Update, Delete
1276
+
- For actions and functions, use a friendly operation name, not the title of the API operation file. For example, instead of "ediscoveryHoldPolicy: retryPolicy", use "Retry hold policy". Avoid duplicating the resource name in the method name
1277
+
- If no methods are supported for this resource, use "None." as the content of the Methods section
1253
1278
-**For Complex Type resources:**
1254
1279
- These have the text "None." instead of a Methods table
1255
1280
@@ -1352,10 +1377,12 @@ Before working on any file, apply these rules to both resource and API files:
1352
1377
-**Note:** Type references in tables should follow [Reference Standards: Namespace Qualification](#reference-standards-namespace-qualification)
1353
1378
1354
1379
8.**Response section:**
1355
-
- Leave it mostly unchanged
1380
+
- Preserve the autogenerated response structure, status codes, and return types; do not rewrite or reformat these elements
1381
+
- Only modify the Response section to:
1382
+
- Add error-related information or special response-related notes documented in the API.md or Documentation Plan
1383
+
- Fix inaccuracies if the return type or status code doesn't match the API.md
1356
1384
-**Note:** Return types should follow [Reference Standards: Namespace Qualification](#reference-standards-namespace-qualification)
1357
-
- Call out any special error-related information or response-related information
1358
-
- Example: An API that returns multiple object types might return an `@odata.type` property for each object to help differentiate each object type in the collection
1385
+
- Example: An API that returns multiple object types might return an `@odata.type` property for each object to help differentiate each object type in the collection
1359
1386
1360
1387
9.**Examples section:**
1361
1388
- Follow HTTP-only example formatting (see [Common Process: Handling Code Snippets in Examples](#common-process-handling-code-snippets-in-examples))
@@ -1617,29 +1644,6 @@ Create a dedicated topic for the enumeration. This option is rarely applicable.
1617
1644
- Update introductory text (for Options 2 & 3) to list the new members that require the header
1618
1645
- Update inline descriptions to include the new members in the header note
1619
1646
1620
-
- Identify what needs to be changed based on the API changes summary
1621
-
- Review API.md file(s) for additional context
1622
-
- Check for consistency with related files
1623
-
1624
-
2. **Make targeted changes:**
1625
-
- Update only what's necessary according to the changes summary
1626
-
- Preserve existing formatting and structure
1627
-
- Maintain compliance with standards
1628
-
- Use information from API.md file(s) to inform updates
1629
-
1630
-
3. **Validate the changes:**
1631
-
- Check the **Problems** window for markdown lint errors and correct them
1632
-
- Verify all links point to existing files
1633
-
- Ensure examples use pseudo-values not data types
1634
-
- Confirm all required sections are present and in correct order
1635
-
- If there are multiple blank lines in a row, replace them with a single blank line
1636
-
1637
-
4. **Review with user:**
1638
-
- Summarize the changes made (both new files and updates)
1639
-
- List all files that were copied or modified
1640
-
- Confirm the updates meet their requirements
1641
-
- Address any additional feedback
1642
-
1643
1647
## Execution approach
1644
1648
1645
1649
1. **Parse the Documentation Plan:**
@@ -1955,7 +1959,7 @@ Before completing Scenario 4 tasks, verify:
1955
1959
- [ ] No markdown lint errors
1956
1960
- [ ] Changelog, What's new, and TOC mapping updated only if appropriate
1957
1961
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
Configure the [cloudPcExternalPartnerAgentSetting](../resources/cloudpcexternalpartneragentsetting.md) of the [cloudPcExternalPartner](../resources/cloudpcexternalpartner.md) object. This setting is used for RMM partner agent installation. RMM partners must contact the Microsoft team to complete onboarding and add the agent URL prefix to the allow list before using this API. If `autoDeploymentEnabled` is enabled, the new provisioned Cloud PC is triggered agent deployment automatically. Currently supports only Windows 365 Business Cloud PC.
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
POST /deviceManagement/virtualEndpoint/externalPartners/{cloudPcExternalPartnerId}/configureAgent
40
+
```
41
+
42
+
## Request headers
43
+
44
+
|Name|Description|
45
+
|:---|:---|
46
+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
47
+
|Content-Type|application/json. Required.|
48
+
49
+
## Request body
50
+
51
+
In the request body, supply a JSON representation of the parameters.
52
+
53
+
The following table lists the parameters that are required when you call this action.
54
+
55
+
|Parameter|Type|Description|
56
+
|:---|:---|:---|
57
+
|agentSetting|[cloudPcExternalPartnerAgentSetting](../resources/cloudpcexternalpartneragentsetting.md)|The agent settings associated with the external partner.|
58
+
59
+
60
+
## Response
61
+
62
+
If successful, this action returns a `204 No Content` response code.
Trigger agent deployment for a set of Windows 365 Cloud PCs that are provisioned, and return an activity ID. This API is supported when the connection is enabled and the agent setting is configured. Currently, only support Windows 365 business Cloud PC.
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
0 commit comments