Skip to content

Commit 3aa9440

Browse files
authored
Merge pull request #28046 from microsoftgraph/main
Merge to publish.
2 parents 08fcb64 + 62b4e42 commit 3aa9440

959 files changed

Lines changed: 2395 additions & 2067 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 64 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,16 @@ Before beginning the documentation process, first ask the author which documenta
1616
1. Author fresh APIs / fresh API changes to beta
1717
2. Promote APIs from beta to v1.0
1818
3. Document deprecated APIs
19-
4. Other documentation tasks (cleanup, backfilling, maintenance, etc.)
19+
4. Other documentation tasks (cleanup, backfilling, maintenance, manual changelog authoring, etc.)
2020

2121
**Please respond with 1, 2, 3, or 4 to proceed.**
2222

2323
Once the author responds, follow the appropriate workflow below.
2424

2525
**Note:** Scenario 3 (deprecation) can be combined with Scenario 1 or 2. If the Summary of API changes includes both deprecation and other changes (new APIs, promotions, updates), the workflow will handle mixed scenarios by processing non-deprecation tasks first, then applying deprecation documentation.
2626

27+
**Note:** For Scenario 4, if the author needs to manually create a changelog entry for non-schema changes (throttling, query capabilities, permissions), refer to [Common Process: Manually Authoring Changelog Entries](#common-process-manually-authoring-changelog-entries).
28+
2729
---
2830

2931
## Common Setup and Processes
@@ -72,7 +74,7 @@ After authoring documentation, update the appropriate changelog file in the `cha
7274
"Id": "{unique-guid}",
7375
"Cloud": "Prod",
7476
"Version": "beta",
75-
"CreatedDateTime": "{ISO-8601-DateTime}",
77+
"CreatedDateTime": "{YYYY-MM-DDTHH:mm:ss.fffffffZ}",
7678
"WorkloadArea": "{WorkloadArea}",
7779
"SubArea": "{SubArea}"
7880
}
@@ -86,7 +88,7 @@ After authoring documentation, update the appropriate changelog file in the `cha
8688
- `Id` (unique GUID for this set of changes)
8789
- `Cloud` (e.g., "Prod")
8890
- `Version` (e.g., "beta" or "v1.0")
89-
- `CreatedDateTime` (ISO-8601 DateTime)
91+
- `CreatedDateTime` (ISO 8601/RFC 3339 DateTime with fractional seconds and Z suffix)
9092
- `WorkloadArea` (e.g., "Security")
9193
- `SubArea` (may be empty string)
9294

@@ -118,19 +120,76 @@ After authoring documentation, update the appropriate changelog file in the `cha
118120
"Id": "1e2218aa-5dbc-4c74-a0fe-1d06e90b451c",
119121
"Cloud": "Prod",
120122
"Version": "beta",
121-
"CreatedDateTime": "2026-01-07T08:37:50.5865153Z",
123+
"CreatedDateTime": "2025-11-17T17:38:10.4694969Z",
122124
"WorkloadArea": "Security",
123125
"SubArea": ""
124126
}
125127
```
126128

127129
- **DO NOT:**
128130
- Copy only the ChangeList items and insert them into an existing record
129-
- Modify the Id, CreatedDateTime, or other metadata from the autogenerated file
131+
- Modify the Id, CreatedDateTime (ISO 8601/RFC 3339 format), or other metadata from the autogenerated file
130132
- Create a new record structure manually
131133

132134
- **Result:** The changelog file should have the new record added at the beginning of the changelog array, with all subsequent records following it
133135

136+
### Common Process: Manually Authoring Changelog Entries
137+
138+
In some cases, API changes don't trigger automatic changelog generation because they don't involve schema changes. These typically include:
139+
- Throttling metric updates
140+
- Query capability changes (e.g., $filter support, $expand support, $top max/default page size)
141+
- Custom query option support
142+
- Permission support changes
143+
- Other behavioral changes that don't modify the API schema
144+
145+
For these scenarios, you must manually author the changelog entry.
146+
147+
**When to use manual changelog authoring:**
148+
- The author indicates there are API changes but no autogenerated changelog file exists in temp-docstubs
149+
- The author explicitly requests manual changelog creation
150+
- Changes involve throttling, query capabilities, permissions, or other non-schema modifications
151+
152+
**Manual changelog authoring workflow:**
153+
154+
**Step 1: Determine if manual authoring is needed**
155+
- Ask if an autogenerated changelog exists in `temp-docstubs/`
156+
- If no autogenerated changelog exists and there are API changes to document, manual authoring is required
157+
158+
**Step 2: Gather required information from the author**
159+
160+
Collect the following details for each API change (refer to **templates/changelog-patterns.md** for complete property definitions):
161+
162+
**Required ChangeList properties:** ChangedApiName, ApiChange, ChangeType, Target, Description
163+
164+
**Required record-level properties:** Version, WorkloadArea, SubArea
165+
166+
**Note:** Cloud is always "prd" - no need to ask the author.
167+
168+
**Step 3: Generate GUID and timestamp**
169+
170+
Refer to **templates/changelog-patterns.md** "GUID Generation" and "CreatedDateTime" sections for generation commands and requirements.
171+
172+
**Step 4: Construct the changelog JSON**
173+
174+
Use the JSON template and examples from **templates/changelog-patterns.md**.
175+
176+
**Step 5: Determine target changelog file**
177+
- If the change affects a specific workload, add to the appropriate workload changelog file (e.g., `changelog/Microsoft.AAD.LCM.json`)
178+
- For general non-schema changes, add to `changelog/Manual.NonWorkloadChanges.json`
179+
- Ask the author which changelog file to use if uncertain
180+
181+
**Step 6: Add the manually created record**
182+
- Follow the same process as [Common Process: Updating the Changelog](#common-process-updating-the-changelog) Step 3
183+
- Insert the manually created changelog record as the FIRST item in the `"changelog"` array
184+
- Ensure proper JSON formatting
185+
186+
**Step 7: Validate the entry**
187+
188+
Follow the complete validation checklist in **templates/changelog-patterns.md** and run:
189+
```powershell
190+
.\validate-changelog-json.ps1
191+
```
192+
134193
### Common Process: Updating What's New
135194

136195
After updating the changelog, update the What's new section in `concepts/whats-new-overview.md`:

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

Lines changed: 32 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ All content must align with the [Microsoft Style Guide](https://docs.microsoft.c
7171

7272
### 2. API Docs Authoring Guidelines
7373

74-
Reference the [author-api-docs.prompt.md](.github/prompts/author-api-docs.prompt.md) file for:
75-
- Namespace qualification rules
76-
- General formatting rules (alphabetical ordering, file naming conventions, beta disclaimer)
77-
- TOC structure requirements
78-
- Changelog format and structure
79-
- What's new formatting
74+
Reference [author-api-docs.prompt.md](.github/prompts/author-api-docs.prompt.md) for:
75+
- **Reference Standards: Namespace Qualification** - Namespace qualification rules for subnamespace types
76+
- **Reference Standards: General Formatting Rules** - Alphabetical ordering, file naming conventions, beta disclaimer
77+
- **Common Process: Updating the Changelog** - Changelog format and structure
78+
- **Common Process: Updating What's New** - What's new formatting and link rules
79+
- **Common Process: Updating the Table of Contents (TOC)** - TOC structure requirements
8080

8181
### 3. API Docs Review Guidelines
8282

@@ -145,22 +145,22 @@ For files in `api-reference/v1.0/resources/` and `api-reference/beta/resources/`
145145

146146
### Changelog Files Review
147147

148-
For files in `changelog/`:
148+
For files in `changelog/`, verify structure matches [templates/changelog-patterns.md](templates/changelog-patterns.md).
149149

150150
**Required Elements:**
151-
- [ ] Complete changelog record structure (ChangeList, Id, Cloud, Version, CreatedDateTime, WorkloadArea, SubArea)
152-
- [ ] Same Id value across the complete changelog record (record-level Id matches all ChangeList item Ids within that record)
153-
- [ ] Cloud value is `Prod`
154-
- [ ] Version value is `v1.0` or `beta`
155-
- [ ] Proper UTC DateTime format for CreatedDateTime
156-
- [ ] Links use full HTTP URLs with en-us locale
157-
- [ ] Links include version parameter without preserve-view=true
158-
159-
**Common Issues to Flag:**
160-
- [ ] Multiple API elements in single record
161-
- [ ] Missing or incorrect descriptions
162-
- [ ] Malformed links
163-
- [ ] Incomplete record structure (missing metadata properties)
151+
- [ ] Complete changelog record structure (ChangeList array + Id, Cloud, Version, CreatedDateTime, WorkloadArea, SubArea)
152+
- [ ] Same GUID in all ChangeList items and record-level Id
153+
- [ ] Cloud value is "prd"
154+
- [ ] Version value is "v1.0" or "beta"
155+
- [ ] CreatedDateTime in ISO 8601/RFC 3339 format with fractional seconds and Z suffix (e.g., "2025-11-17T17:38:10.4694969Z")
156+
- [ ] Description links use full URLs with en-us locale
157+
- [ ] WorkloadArea and SubArea match CDK taxonomy (https://aka.ms/msgraphcdk)
158+
159+
**Common Issues:**
160+
- [ ] Multiple unrelated API elements in single ChangeList item
161+
- [ ] Missing or vague descriptions
162+
- [ ] Malformed links or missing en-us locale
163+
- [ ] Incomplete record structure (missing metadata)
164164

165165
### Version-Specific Validation
166166

@@ -178,46 +178,26 @@ For files in `changelog/`:
178178

179179
## Namespace Qualification Review
180180

181-
Verify proper namespace qualification following these rules:
182-
183-
**Fully qualify types in these contexts ONLY:**
184-
- Resource topic: Type column in Properties tables
185-
- Resource topic: Type column in Relationships tables
186-
- Resource topic: Return type column in Methods tables
187-
- Method topic: Type column in Path parameters tables
188-
- Method topic: Type column in Function parameters tables
189-
- Method topic: Type column in Query parameters tables
190-
- Method topic: Type column in Request body tables
191-
- Method topic: Method return type in Response section
192-
193-
**File naming for subnamespaces:**
194-
- [ ] Files for subnamespace resources prepend subnamespace name
195-
- [ ] Examples: `callrecords-callrecord.md`, `security-alert.md`
196-
- [ ] Lowercase with `microsoft.graph.` prefix removed
181+
Verify proper namespace qualification following the rules detailed in [author-api-docs.prompt.md - Reference Standards: Namespace Qualification](.github/prompts/author-api-docs.prompt.md#reference-standards-namespace-qualification).
197182

198-
**HTTP requests for actions/functions in subnamespaces:**
199-
- [ ] Namespace of binding parameter type specified in HTTP request
200-
- [ ] Example: `POST /me/microsoft.graph.callRecords.getDirectRoutingCalls`
183+
**Quick checklist:**
184+
- [ ] Files for subnamespace resources prepend subnamespace name (e.g., `callrecords-callrecord.md`, `security-alert.md`)
185+
- [ ] Lowercase with `microsoft.graph.` prefix removed
186+
- [ ] Namespace of binding parameter type specified in HTTP request for actions/functions
187+
- [ ] Types in subnamespaces are fully qualified in table Type columns and Response sections
201188

202189
---
203190

204191
## Formatting and Style Review
205192

206-
**File naming:**
207-
- [ ] All filenames are lowercase
208-
- [ ] Hyphens separate words
209-
- [ ] Resource files: `{resourcename}.md`
210-
- [ ] API method files: `{resourcename}-{operation}.md`
211-
- [ ] Subnamespace files: `{subnamespace}-{resourcename}.md`
212-
213-
**Alphabetical ordering:**
214-
- [ ] Properties in Properties tables
215-
- [ ] Relationships in Relationships tables
216-
- [ ] H3 sections in What's new (within each month)
193+
Verify compliance with formatting rules detailed in [author-api-docs.prompt.md - Reference Standards: General Formatting Rules](.github/prompts/author-api-docs.prompt.md#reference-standards-general-formatting-rules).
217194

218-
**Markdown formatting:**
195+
**Quick checklist:**
196+
- [ ] All filenames are lowercase with hyphens separating words
197+
- [ ] Properties and Relationships tables in alphabetical order
198+
- [ ] H3 sections in What's new in alphabetical order (within each month)
219199
- [ ] Symbol names wrapped in backticks: `MyClass`, `handleClick()`
220-
- [ ] File references formatted as links (not backticks): [path/file.ts](path/file.ts)
200+
- [ ] File references formatted as links: [path/file.ts](path/file.ts)
221201
- [ ] Enum values styled with inline code (backticks)
222202
- [ ] Resource/property references styled with **bold** or links
223203

api-reference/beta/api/intune-androidforwork-androiddeviceownerenrollmentprofile-setenrollmenttimedevicemembershiptarget.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidforwork-androidmanagedstoreaccountenterprisesettings-addapps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidforwork-androidmanagedstoreaccountenterprisesettings-requestenterpriseupgradeurl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidforwork-androidmanagedstoreaccountenterprisesettings-retrievestorelayout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidforwork-androidmanagedstoreaccountenterprisesettings-setstorelayout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidfotaservice-zebrafotaconnector-approvefotaapps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidfotaservice-zebrafotaconnector-connect.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.Read.All|
30+
|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

api-reference/beta/api/intune-androidfotaservice-zebrafotaconnector-disconnect.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ One of the following permissions is required to call this API. To learn more, in
2525

2626
|Permission type|Permissions (from least to most privileged)|
2727
|:---|:---|
28-
|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All|
28+
|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
2929
|Delegated (personal Microsoft account)|Not supported.|
30-
|Application|DeviceManagementConfiguration.ReadWrite.All|
30+
|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All|
3131

3232
## HTTP Request
3333
<!-- {

0 commit comments

Comments
 (0)