Skip to content

Commit 6f34621

Browse files
authored
Merge pull request #28305 from microsoftgraph/main
Merge to publish.
2 parents ae9cfce + d3c4b24 commit 6f34621

24 files changed

Lines changed: 861 additions & 27 deletions

.gdn/.gdnbaselines

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,41 @@
1616
"b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be": {
1717
"signature": "b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be",
1818
"alternativeSignatures": [
19-
"79e125fb7927450b0ebb02d6b3ddb03d7a6a971e21dfdc1c246ba8fd39f0969e"
19+
"79e125fb7927450b0ebb02d6b3ddb03d7a6a971e21dfdc1c246ba8fd39f0969e",
20+
"11e53a6e53ef601debd4d1a4dc1ca3d451cd0c96df1892e7f5685b8c6d01769b"
2021
],
21-
"target": "update-permissions-reference.ps1",
22+
"target": "scripts/update-permissions-reference.ps1",
2223
"line": 170,
2324
"memberOf": [
2425
"default"
2526
],
2627
"tool": "psscriptanalyzer",
2728
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
2829
"createdDate": "2024-08-26 12:06:54Z"
30+
},
31+
"11e53a6e53ef601debd4d1a4dc1ca3d451cd0c96df1892e7f5685b8c6d01769b": {
32+
"signature": "11e53a6e53ef601debd4d1a4dc1ca3d451cd0c96df1892e7f5685b8c6d01769b",
33+
"alternativeSignatures": [],
34+
"target": "scripts/update-permissions-reference.ps1",
35+
"line": 177,
36+
"memberOf": [
37+
"default"
38+
],
39+
"tool": "psscriptanalyzer",
40+
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
41+
"createdDate": "2026-02-24 12:06:54Z"
42+
},
43+
"261f3837d9978ecb7637c62a4ced8a0eb843e19a07557738ce232dc24410ac96": {
44+
"signature": "261f3837d9978ecb7637c62a4ced8a0eb843e19a07557738ce232dc24410ac96",
45+
"alternativeSignatures": [],
46+
"target": "update-permissions-reference-fic.ps1",
47+
"line": 179,
48+
"memberOf": [
49+
"default"
50+
],
51+
"tool": "psscriptanalyzer",
52+
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
53+
"createdDate": "2026-02-24 12:06:54Z"
2954
}
3055
}
3156
}

.gdn/.gdnsuppress

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,41 @@
1616
"b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be": {
1717
"signature": "b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be",
1818
"alternativeSignatures": [
19-
"79e125fb7927450b0ebb02d6b3ddb03d7a6a971e21dfdc1c246ba8fd39f0969e"
19+
"79e125fb7927450b0ebb02d6b3ddb03d7a6a971e21dfdc1c246ba8fd39f0969e",
20+
"11e53a6e53ef601debd4d1a4dc1ca3d451cd0c96df1892e7f5685b8c6d01769b"
2021
],
21-
"target": "update-permissions-reference.ps1",
22+
"target": "scripts/update-permissions-reference.ps1",
2223
"line": 170,
2324
"memberOf": [
2425
"default"
2526
],
2627
"tool": "psscriptanalyzer",
2728
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
2829
"createdDate": "2024-08-26 12:06:54Z"
30+
},
31+
"11e53a6e53ef601debd4d1a4dc1ca3d451cd0c96df1892e7f5685b8c6d01769b": {
32+
"signature": "11e53a6e53ef601debd4d1a4dc1ca3d451cd0c96df1892e7f5685b8c6d01769b",
33+
"alternativeSignatures": [],
34+
"target": "scripts/update-permissions-reference.ps1",
35+
"line": 177,
36+
"memberOf": [
37+
"default"
38+
],
39+
"tool": "psscriptanalyzer",
40+
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
41+
"createdDate": "2026-02-24 12:06:54Z"
42+
},
43+
"261f3837d9978ecb7637c62a4ced8a0eb843e19a07557738ce232dc24410ac96": {
44+
"signature": "261f3837d9978ecb7637c62a4ced8a0eb843e19a07557738ce232dc24410ac96",
45+
"alternativeSignatures": [],
46+
"target": "update-permissions-reference-fic.ps1",
47+
"line": 179,
48+
"memberOf": [
49+
"default"
50+
],
51+
"tool": "psscriptanalyzer",
52+
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
53+
"createdDate": "2026-02-24 12:06:54Z"
2954
}
3055
}
3156
}

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

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Before beginning any documentation process, instruct the author to add all requi
7777
- Files should be deleted from temp-docstubs after documentation is complete
7878
- Always reference the temp-docstubs folder when asking for or reading input files
7979
- Never ask the author to provide absolute file paths outside the workspace
80+
- **Automated validation:** A validation script prevents temporary files from being accidentally committed (see [Common Process: Validation](#common-process-validation))
8081

8182
### Common Process: Updating the Changelog
8283

@@ -211,10 +212,7 @@ Use the JSON template and examples from **templates/changelog-patterns.md**.
211212

212213
**Step 7: Validate the entry**
213214

214-
Follow the complete validation checklist in **templates/changelog-patterns.md** and run:
215-
```powershell
216-
.\validate-changelog-json.ps1
217-
```
215+
Follow the complete validation checklist in **templates/changelog-patterns.md** and see [Common Process: Validation](#common-process-validation) for running the validation script.
218216

219217
### Common Process: Updating What's New
220218

@@ -303,6 +301,31 @@ Content-type: application/json
303301

304302
**When promoting from beta to v1.0:** Remove SDK snippets and tab markers for files copied from beta; keep only HTTP examples (see [Scenario 2](#scenario-2-promote-apis-from-beta-to-v10)).
305303

304+
### Common Process: Validation
305+
306+
After making documentation changes, run these validation scripts to ensure compliance:
307+
308+
**Validate changelog JSON files:**
309+
```powershell
310+
.\scripts\validate-changelog-json.ps1
311+
```
312+
- Validates all changelog files in the `changelog/` folder
313+
- Checks schema compliance, required properties, and formatting
314+
- Must pass before committing changelog updates
315+
316+
**Validate temp-docstubs cleanup:**
317+
```powershell
318+
.\scripts\validate-temp-docstubs.ps1
319+
```
320+
- Verifies that only `temp-docstubs-instructions.md` remains in temp-docstubs folder
321+
- Prevents accidental commit of temporary input files
322+
- Run after completing Doc Stubs Cleanup
323+
324+
**When validation fails:**
325+
- Review error messages to identify issues
326+
- Correct the problems in the affected files
327+
- Re-run validation until all checks pass
328+
306329
---
307330

308331
### Reference Standards: Namespace Qualification
@@ -719,6 +742,7 @@ Remove "(preview)" from TOC entries as applicable:
719742
- [ ] All TOC entries updated
720743
- [ ] Changelog and What's new updated
721744
- [ ] No markdown lint errors remain
745+
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
722746
- [ ] Provided summary of all files created/modified to author
723747

724748
---
@@ -960,6 +984,7 @@ When combining deprecation with new APIs/promotions:
960984
**Final:**
961985
- [ ] All Summary items addressed
962986
- [ ] No markdown lint errors
987+
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
963988
- [ ] Summary provided to author
964989

965990
---
@@ -1809,6 +1834,7 @@ Before completing any authoring task, verify:
18091834
- [ ] All TOC changes made if applicable
18101835
- [ ] All properties referencing updated enumerations have been updated
18111836
- [ ] All permissions files copied
1837+
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
18121838
- [ ] Provided summary of all files created/modified to author
18131839

18141840
---
@@ -1928,6 +1954,7 @@ Before completing Scenario 4 tasks, verify:
19281954
- [ ] Examples use pseudo-values, not data types
19291955
- [ ] No markdown lint errors
19301956
- [ ] Changelog, What's new, and TOC mapping updated only if appropriate
1957+
- [ ] Validation completed (see [Common Process: Validation](#common-process-validation))
19311958
- [ ] Summary of changes provided to author
19321959

19331960
---
@@ -1947,6 +1974,10 @@ After completing the documentation work and providing the final summary to the a
19471974
- If the author confirms, delete all files from `temp-docstubs` folder except `temp-docstubs-instructions.md`
19481975
- Confirm deletion: "Cleanup complete. All temporary files have been removed from the temp-docstubs folder."
19491976

1977+
4. **Validate cleanup:**
1978+
- See [Common Process: Validation](#common-process-validation) for validation instructions
1979+
- If validation passes, confirm: "Validation passed: temp-docstubs folder is ready for commit."
1980+
19501981
**Note:** The `temp-docstubs-instructions.md` file should never be deleted as it provides important guidance for future authoring sessions.
19511982

19521983
If you cannot resolve all issues or confirm information against API.md, notify the author to manually address remaining problems.

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

Lines changed: 84 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,62 @@ While not required, providing these files significantly improves review quality
4949

5050
---
5151

52+
## Common Process: Validation
53+
54+
As part of the review process, validate that automated validation scripts pass. These scripts ensure compliance with required standards and prevent common errors.
55+
56+
### Validate changelog JSON files
57+
58+
After reviewing changelog changes, run the changelog validation script:
59+
60+
```powershell
61+
.\scripts\validate-changelog-json.ps1
62+
```
63+
64+
**Purpose:**
65+
- Validates all changelog files in the `changelog/` folder against the schema
66+
- Checks schema compliance, required properties, and formatting
67+
- Ensures proper JSON structure and required metadata
68+
69+
**What it validates:**
70+
- Complete record structure (ChangeList array + Id, Cloud, Version, CreatedDateTime, WorkloadArea, SubArea)
71+
- GUID consistency across ChangeList items and record-level Id
72+
- Cloud value is "prd" (or "Prod" - case variations allowed)
73+
- Version value is "v1.0" or "beta"
74+
- CreatedDateTime in ISO 8601/RFC 3339 format with fractional seconds and Z suffix
75+
- WorkloadArea and SubArea match CDK taxonomy
76+
77+
**Must pass before:** Approving PR with changelog updates
78+
79+
### Validate temp-docstubs cleanup (if applicable)
80+
81+
If reviewing changes that involved the temp-docstubs folder, verify cleanup:
82+
83+
```powershell
84+
.\scripts\validate-temp-docstubs.ps1
85+
```
86+
87+
**Purpose:**
88+
- Verifies that only `temp-docstubs-instructions.md` remains in temp-docstubs folder
89+
- Prevents accidental commit of temporary input files (autogenerated doc stubs, API.md files, changelog files)
90+
91+
**Must pass before:** Approving PR that touched temp-docstubs folder
92+
93+
### When validation fails
94+
95+
**If validation scripts report errors:**
96+
1. Review error messages to identify specific issues
97+
2. Flag the issues in your review report under "Critical Issues (Must Fix)"
98+
3. Provide guidance on correcting the problems
99+
4. Request author to re-run validation after fixes
100+
5. Do not approve until all validation checks pass
101+
102+
**Common validation failures:**
103+
- Changelog: Missing required properties, incorrect date format, malformed JSON
104+
- temp-docstubs: Temporary files not removed before commit
105+
106+
---
107+
52108
## Review Guidelines
53109

54110
The review process applies guidelines from three authoritative sources. You should check all sets of guidelines without duplication:
@@ -145,22 +201,24 @@ For files in `api-reference/v1.0/resources/` and `api-reference/beta/resources/`
145201

146202
### Changelog Files Review
147203

148-
For files in `changelog/`, verify structure matches [templates/changelog-patterns.md](templates/changelog-patterns.md).
204+
For files in `changelog/`, verify structure matches [templates/changelog-patterns.md](templates/changelog-patterns.md) and run validation (see [Common Process: Validation](#common-process-validation)).
149205

150206
**Required Elements:**
151207
- [ ] Complete changelog record structure (ChangeList array + Id, Cloud, Version, CreatedDateTime, WorkloadArea, SubArea)
152208
- [ ] Same GUID in all ChangeList items and record-level Id
153-
- [ ] Cloud value is "prd"
209+
- [ ] Cloud value is "prd" (or "Prod")
154210
- [ ] Version value is "v1.0" or "beta"
155211
- [ ] CreatedDateTime in ISO 8601/RFC 3339 format with fractional seconds and Z suffix (e.g., "2025-11-17T17:38:10.4694969Z")
156212
- [ ] Description links use full URLs with en-us locale
157213
- [ ] WorkloadArea and SubArea match CDK taxonomy (https://aka.ms/msgraphcdk)
214+
- [ ] Validation script passes (see [Common Process: Validation](#common-process-validation))
158215

159216
**Common Issues:**
160217
- [ ] Multiple unrelated API elements in single ChangeList item
161218
- [ ] Missing or vague descriptions
162219
- [ ] Malformed links or missing en-us locale
163220
- [ ] Incomplete record structure (missing metadata)
221+
- [ ] Validation script failures
164222

165223
### Version-Specific Validation
166224

@@ -252,7 +310,16 @@ Group files by type:
252310

253311
For each file, apply the appropriate review checklist from above.
254312

255-
### Step 4: Report Findings
313+
### Step 4: Run Validation Scripts
314+
315+
Run automated validation scripts to ensure compliance (see [Common Process: Validation](#common-process-validation)):
316+
317+
1. **If changelog files were modified:** Run `.\scripts\validate-changelog-json.ps1`
318+
2. **If temp-docstubs folder is present in the branch:** Run `.\scripts\validate-temp-docstubs.ps1`
319+
320+
Include validation results in your review report. Flag any validation failures as critical issues.
321+
322+
### Step 5: Report Findings
256323

257324
Provide a structured review report:
258325

@@ -275,7 +342,7 @@ For each file with issues, list:
275342
- Suggested fix (when applicable)
276343
- Line numbers or section references
277344

278-
### Step 5: Optional - Suggest Fixes
345+
### Step 6: Optional - Suggest Fixes
279346

280347
If requested, provide specific edits to fix identified issues.
281348

@@ -304,6 +371,10 @@ If requested, provide specific edits to fix identified issues.
304371
**Files with Issues:** 3
305372
**Files Approved:** 5
306373

374+
**Validation Results:**
375+
- ✓ Changelog validation passed (.\scripts\validate-changelog-json.ps1)
376+
- ✓ temp-docstubs validation passed (.\scripts\validate-temp-docstubs.ps1)
377+
307378
---
308379

309380
## Critical Issues (Must Fix)
@@ -345,6 +416,8 @@ If requested, provide specific edits to fix identified issues.
345416
- Current: "Added property"
346417
- Suggestion: "Added the **newProperty** property to enable..."
347418

419+
### API overview updates
420+
- If an API Overview topic covers the same APIs, consider updating it to reflect new capabilities and changes for better discoverability and context for users.
348421
---
349422

350423
## Files Approved
@@ -362,11 +435,13 @@ If requested, provide specific edits to fix identified issues.
362435

363436
1. **Start with file classification** - Understanding file types helps apply the right rules
364437
2. **Check metadata first** - Validate namespace, doc_type, and version before content review
365-
3. **Use find/search** - Look for TODO placeholders across all files
366-
4. **Validate links** - Ensure all referenced resources and types exist and are correctly linked
367-
5. **Check consistency** - Resource names, namespaces, and terminology should be consistent across all files
368-
6. **Compare with context** - If Summary of API changes (documentation-plan.md file) or API.md provided, validate against them first
369-
7. **Flag autogeneration issues** - If doc stubs appear to have over-generated content, mention this
438+
3. **Run validation scripts early** - Check changelog and temp-docstubs validation before detailed review
439+
4. **Use find/search** - Look for TODO placeholders across all files
440+
5. **Validate links** - Ensure all referenced resources and types exist and are correctly linked
441+
6. **Check consistency** - Resource names, namespaces, and terminology should be consistent across all files
442+
7. **Compare with context** - If Summary of API changes (documentation-plan.md file) or API.md provided, validate against them first
443+
8. **Flag autogeneration issues** - If doc stubs appear to have over-generated content, mention this
444+
9. **Include validation results** - Always report validation script results in your review summary
370445

371446
---
372447

0 commit comments

Comments
 (0)