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/common.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,6 +219,21 @@ After updating the changelog, update the What's new section in `concepts/whats-n
219
219
- For **v1.0** documentation: Do NOT append any query string parameters
220
220
- Example format: `Added the [resourceName](/graph/api/resources/resourcename) resource to manage XYZ.`
221
221
222
+
**Authoring principles for What's New entries:**
223
+
224
+
-**Lead with the doc action verb.** Start with "Added", "Updated", or "Changed" to signal what was documented. For new resources, use `Added the [resource](/path) resource type and related methods for...`. For new properties or relationships on an existing resource, use `Added the **propertyName** relationship to the [resource](/path) resource.` For new enum members, use `Added the \`memberName\` member to the [enumName](/path) enumeration...` and describe the capability it enables.
225
+
-**Describe the capability, not the objects.** Say what users can now *do*. Do not enumerate properties, methods, complex types, or enumerations — those are discoverable from the linked pages.
226
+
-**Do not say "new"** — the section context implies it. Do not qualify with the API version — the section structure (v1.0 vs. beta) already communicates this.
227
+
-**Link only to the root entry point** — the entity type, function, or property that triggers the capability. If the change introduces an entity type, everything else (properties, methods, complex types) depends on it and doesn't need separate mention. If the change is a function or property addition, link to that and its parent resource.
228
+
-**Keep entries to 1–4 sentences.**
229
+
230
+
| Scenario | ❌ Avoid | ✅ Correct |
231
+
|----------|----------|-----------|
232
+
| New entity type with operations | List the resource, each method, and every complex type separately. |`Added the [driveItem](/graph/api/resources/driveitem) resource type and related methods for managing drive items. Use it to list, get, create, update, and delete files and folders.`|
233
+
| New function + property addition | List the function, the property, and all supporting complex types. |`Added support for programmatic FIDO2 passkey registration. Use the [creationOptions](/graph/api/fido2authenticationmethod-creationoptions) function to get WebAuthn credential creation options, then complete registration by posting the **publicKeyCredential** property to the [fido2AuthenticationMethod](/graph/api/resources/fido2authenticationmethod) resource.`|
234
+
| New property or relationship on existing resource | Name all new properties individually. |`Added the **inheritedAppRoleAssignments** and **inheritedOauth2PermissionGrants** relationships to the [agentIdentity](/graph/api/resources/agentidentity) resource. Use these to retrieve the permissions an agent identity inherits from its parent blueprint service principal.`|
235
+
| New enum member | List only the enum type without explaining the capability, where possible. |`Added \`targetAgentIdentitySponsorOrOwner\` to the filter options for [access package assignments](/graph/api/accesspackageassignment-filterbycurrentuser), enabling sponsors and owners of agent identities to view access package activity for the agent identities they manage.` |
236
+
222
237
### Updating the Table of Contents (TOC)
223
238
224
239
After updating What's new, update the appropriate TOC mapping file to make new documentation discoverable:
Copy file name to clipboardExpand all lines: api-reference/beta/api/approvedclientapp-get.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,7 @@ If successful, this method returns a `200 OK` response code and a [approvedClien
58
58
59
59
### Request
60
60
The following example shows a request.
61
+
# [HTTP](#tab/http)
61
62
<!-- {
62
63
"blockType": "request",
63
64
"name": "get_approvedclientapp"
@@ -67,6 +68,36 @@ The following example shows a request.
67
68
GET https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration/approvedClientApps/cd57c330-a543-4249-9486-c1c257341de6
0 commit comments