Skip to content

Commit ad8253b

Browse files
authored
Merge branch 'main' into zallison/fix_createdByAppId_docs
2 parents 148b5a5 + fd5c14d commit ad8253b

743 files changed

Lines changed: 10941 additions & 2080 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.

.gdn/.gdnbaselines

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,6 @@
3939
"tool": "psscriptanalyzer",
4040
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
4141
"createdDate": "2026-02-24 12:06:54Z"
42-
},
43-
"3a37bf64f23749ac738b5da94bdc0511f105855aee640971733d155dad1f9915": {
44-
"signature": "3a37bf64f23749ac738b5da94bdc0511f105855aee640971733d155dad1f9915",
45-
"alternativeSignatures": [],
46-
"target": "scripts/update-permissions-reference-fic.ps1",
47-
"line": 179,
48-
"memberOf": [
49-
"default"
50-
],
51-
"tool": "psscriptanalyzer",
52-
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
53-
"createdDate": "2026-03-24 12:06:54Z"
5442
}
5543
}
5644
}

.gdn/.gdnsuppress

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,6 @@
3939
"tool": "psscriptanalyzer",
4040
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
4141
"createdDate": "2026-02-24 12:06:54Z"
42-
},
43-
"3a37bf64f23749ac738b5da94bdc0511f105855aee640971733d155dad1f9915": {
44-
"signature": "3a37bf64f23749ac738b5da94bdc0511f105855aee640971733d155dad1f9915",
45-
"alternativeSignatures": [],
46-
"target": "scripts/update-permissions-reference-fic.ps1",
47-
"line": 179,
48-
"memberOf": [
49-
"default"
50-
],
51-
"tool": "psscriptanalyzer",
52-
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
53-
"createdDate": "2026-03-24 12:06:54Z"
5442
}
5543
}
5644
}

.github/prompts/author-api-docs/deprecate-retire.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ If the author has already described the deprecation in sufficient detail (e.g.,
7676
| Instead of... | Use... |
7777
|---------------|--------|
7878
| Documentation Plan | The author's prompt — extract what is being deprecated, the alternative/workaround, milestone date, and blog post link |
79-
| Autogenerated changelog | Ask the author if a changelog and What's New update are needed. If yes, use the [manual changelog authoring](common.md#manually-authoring-changelog-entries) process |
79+
| Autogenerated changelog | Changelog and What's New are **always required** for deprecations and retirements. If no autogenerated changelog file exists, use the [manual changelog authoring](common.md#manually-authoring-changelog-entries) process. Ask the author only for WorkloadArea and SubArea if not inferrable. |
8080

8181
**What you still need from the author** (ask if not provided):
8282
- What specifically is being deprecated (resource, method, property, enum, etc.)
8383
- The alternative API or workaround
8484
- The milestone/sunset date
8585
- Blog post URL (if available)
8686
- Which version(s): beta, v1.0, or both
87-
- WorkloadArea and SubArea for the changelog (if one is needed)
87+
- WorkloadArea and SubArea for the changelog (if not inferrable)
8888

8989
## Key principles
9090

@@ -190,10 +190,22 @@ See [Deprecating enumerations](.github/prompts/author-api-docs/enumerations.md#d
190190

191191
## Supporting updates
192192

193-
**Changelog:** Change type: "Deprecation". Include API set/entities, link to topics and blog post. See [Updating the Changelog](common.md#updating-the-changelog).
193+
Changelog and What's New updates are always required for deprecations and retirements. This applies to all deprecated or retired schema artifacts — resources, properties, relationships, enums, methods.
194+
195+
**Changelog:** Change type: "Deprecation" or "Deletion". Include API set/entities, link to topics and blog post. See [Updating the Changelog](common.md#updating-the-changelog).
194196

195197
**What's New:** Describe deprecation, link to deprecated API and alternative, link to blog post. See [Updating What's New](common.md#updating-whats-new).
196198

199+
**What's New description patterns for deprecations and retirements:**
200+
201+
- **Deprecated resource:** `Deprecated the [resourceName](/graph/api/resources/{filename}?view=graph-rest-{version}&preserve-view=true) resource type. Use [alternativeName](/graph/api/resources/{alt-filename}?view=graph-rest-{version}&preserve-view=true) instead.`
202+
- **Deprecated property:** `Deprecated the **propertyName** property on the [resourceName](/graph/api/resources/{filename}?view=graph-rest-{version}&preserve-view=true) resource type. Use the **alternativeProperty** property instead.`
203+
- **Deprecated method:** `Deprecated the [methodName](/graph/api/{filename}?view=graph-rest-{version}&preserve-view=true) method. Use [alternativeMethod](/graph/api/{alt-filename}?view=graph-rest-{version}&preserve-view=true) instead.`
204+
- **Deprecated enum/member:** `Deprecated the `memberName` member in the **enumName** enumeration type.`
205+
- **Retired resource:** `Removed the **resourceName** resource type and associated methods.`
206+
207+
For v1.0-only links, omit the `?view=graph-rest-beta&preserve-view=true` query string.
208+
197209
---
198210

199211
## Mixed scenarios
@@ -356,6 +368,7 @@ In addition to the [base quality checklist](common.md#base-quality-checklist), v
356368
**Supporting updates:**
357369
- [ ] Changelog: Change type "Deprecation", links to topics/blog
358370
- [ ] What's New: describes deprecation, links to API/alternative/blog
371+
- [ ] What's New includes entries for all deprecated schema artifacts (resources, properties, enums, methods)
359372

360373
**Mixed scenarios:**
361374
- [ ] Non-deprecation tasks processed first

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Document within the **Properties** section of the resource that uses the enum. T
8989
```
9090

9191
2. **Create table:**
92-
- Columns: **Member** and **Description**
92+
- Columns: **Member** (required) and **Description** (optional)
9393
- List members in ascending order by numeric value (without exposing numeric values)
9494
- **For evolvable enums:**
9595
- Include `unknownFutureValue` member
@@ -133,7 +133,7 @@ Create a dedicated topic for the enumeration. This option is rarely applicable.
133133
2. **Add Members H2 section:**
134134
- **For evolvable enums (if members follow unknownFutureValue):**
135135
- Add introductory text before the table (same as Option 2)
136-
- Table with columns: **Member** and **Description**
136+
- Table with columns: **Member** (required) and **Description** (optional)
137137
- List members in ascending order by numeric value (without exposing values)
138138
- **For evolvable enums:**
139139
- Include `unknownFutureValue` member
@@ -257,21 +257,23 @@ Create a dedicated topic for the enumeration. This option is rarely applicable.
257257
- [ ] For evolvable enums with members after unknownFutureValue: Prefer header note included in property description
258258
- [ ] **Option 2 (Parent resource):**
259259
- [ ] H3 section "{enum-type} values" added after Properties table
260-
- [ ] Table has Member and Description columns
260+
- [ ] Table has Member column (required) and Description column (optional)
261261
- [ ] Members listed in ascending order by numeric value (values not exposed)
262262
- [ ] For evolvable enums: unknownFutureValue description is "Evolvable enumeration sentinel value. Do not use."
263263
- [ ] For evolvable enums with members after unknownFutureValue: Introductory text about Prefer header included
264264
- [ ] Properties table links to H3 section
265+
- [ ] Parent resource property description excludes inline value listing (values are accessible via linked H3 section)
265266
- [ ] For subnamespaces: Fully qualified enum name used
266267
- [ ] **Option 3 (Separate topic):**
267268
- [ ] File created with correct naming convention
268269
- [ ] Title is "{enum-type} enum type"
269270
- [ ] Description mentions evolvable enumeration if applicable
270-
- [ ] Members H2 section with Member and Description columns
271+
- [ ] Members H2 section with Member column (required) and Description column (optional)
271272
- [ ] For evolvable enums: unknownFutureValue description is "Evolvable enumeration sentinel value. Don't use."
272273
- [ ] For evolvable enums with members after unknownFutureValue: Introductory text about Prefer header included
273274
- [ ] For subnamespaces: Namespace attribute added in page annotation
274275
- [ ] Parent resource Properties table links to enum topic
276+
- [ ] Parent resource property description excludes inline value listing (values are accessible via linked enum topic)
275277

276278
### For updating existing enumerations
277279

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

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ If the author has already described the promotion in sufficient detail (e.g., na
7070
| Documentation Plan | The author's prompt — extract which resources, methods, or properties are being promoted |
7171
| API.md | The author's pasted content (XML, CSDL, JSON) + existing documentation in the repo |
7272
| Doc stubs | Existing files in the repo — search for them by resource name, namespace, or file path |
73-
| Autogenerated changelog | Ask the author if they can provide an autogenerated changelog in `temp-docstubs`. If not, use the [manual changelog authoring](common.md#manually-authoring-changelog-entries) process |
73+
| Autogenerated changelog | Changelog and What's New are **always required** for promotions to v1.0. If no autogenerated changelog file exists, use the [manual changelog authoring](common.md#manually-authoring-changelog-entries) process. Ask the author only for WorkloadArea and SubArea if not inferrable. |
7474

7575
**What you still need from the author** (ask if not provided or inferrable):
7676
- Which specific resources/methods/properties are being promoted
7777
- Whether this is a full or partial promotion
7878
- Whether there are deviations from beta (renames, type changes, structural differences)
79-
- WorkloadArea and SubArea for the changelog (if one is needed)
79+
- WorkloadArea and SubArea for the changelog (if not inferrable)
8080

8181
**Do not block** on missing formal inputs when the author's prompt provides enough context to proceed.
8282

@@ -189,6 +189,8 @@ Remove "(preview)" from TOC entries as applicable:
189189

190190
### Step 5: Update changelog and What's new
191191

192+
Changelog and What's New updates are always required for promotions. This applies to all promoted schema artifacts — resources, properties, relationships, enums, methods.
193+
192194
1. **Add changelog entries:**
193195
- Use the autogenerated changelog doc stub (JSON file) provided by the author
194196
- Add entries for all APIs and resources being promoted to v1.0
@@ -198,6 +200,16 @@ Remove "(preview)" from TOC entries as applicable:
198200
- Add entries to the [What's new](https://learn.microsoft.com/en-us/graph/whats-new-overview) topic for the promoted APIs
199201
- Highlight that these APIs are now generally available (GA) in v1.0
200202

203+
**What's New description patterns for GA promotions:**
204+
205+
- **Promoted resource:** `Added the [resourceName](/graph/api/resources/{filename}) resource type to the v1.0 endpoint.`
206+
- **Promoted property:** `Added the **propertyName** property to the [resourceName](/graph/api/resources/{filename}) resource type in v1.0.`
207+
- **Promoted enum:** `Added the **enumName** enumeration type to the v1.0 endpoint.`
208+
- **Promoted method:** `Added the [methodName](/graph/api/{filename}) method to the [resourceName](/graph/api/resources/{filename}) resource type in v1.0.`
209+
- **Promoted enum member:** Added the `memberName` member to the **enumName** enumeration type in v1.0.
210+
211+
Note: For v1.0 links, do NOT append `?view=graph-rest-beta&preserve-view=true` query strings.
212+
201213
## Partial promotions
202214

203215
When only some properties, methods, or relationships of a resource are being promoted (the v1.0 resource already exists):
@@ -319,6 +331,7 @@ In addition to the [base quality checklist](common.md#base-quality-checklist), v
319331
**For changelog and What's new:**
320332
- [ ] Changelog entries added using autogenerated JSON stub
321333
- [ ] What's new topic updated with GA announcement
334+
- [ ] What's New includes entries for all promoted schema artifacts (resources, properties, enums, methods)
322335

323336
**Final verification — Scenario 2 specific:**
324337
- [ ] All resource files promoted and updated

.github/prompts/author-api-docs/public-preview.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ If the author has already described the change in sufficient detail (e.g., paste
6767
| Documentation Plan | The author's prompt — extract scope, files, resources, and changes directly from their message |
6868
| API.md | The author's pasted content (XML, CSDL, JSON) + existing documentation in the repo |
6969
| Doc stubs | Existing files in the repo — search for them by resource name, namespace, or file path |
70-
| Autogenerated changelog | Ask the author if a changelog and What's New update are needed. If yes, use the [manual changelog authoring](common.md#manually-authoring-changelog-entries) process |
70+
| Autogenerated changelog | Changelog and What's New are **always required** for schema changes (new resources, properties, enums, methods, deprecations). If no autogenerated changelog file exists, use the [manual changelog authoring](common.md#manually-authoring-changelog-entries) process. Ask the author only for WorkloadArea and SubArea if not inferrable. |
7171

7272
**What you still need from the author** (ask if not provided or inferrable):
7373
- Which version: beta, v1.0, or both
@@ -497,6 +497,30 @@ For all API changes, include the following updates as applicable:
497497

498498
See the shared processes in [`common.md`](.github/prompts/author-api-docs/common.md) for complete instructions on each of these processes.
499499

500+
### When changelog and What's New are required
501+
502+
Changelog and What's New updates are required whenever a doc stub changelog file is provided or the Documentation Plan includes schema changes. This includes — but is not limited to:
503+
504+
| Change type | Changelog required | What's New required |
505+
|-------------|-------------------|---------------------|
506+
| New resource type (EntityType, ComplexType) | ✅ Yes | ✅ Yes |
507+
| New API method (action, function) | ✅ Yes | ✅ Yes |
508+
| New property on existing resource | ✅ Yes | ✅ Yes |
509+
| New relationship on existing resource | ✅ Yes | ✅ Yes |
510+
| New enumeration type | ✅ Yes | ✅ Yes |
511+
| New enum member on existing enum | ✅ Yes | ✅ Yes |
512+
| Deprecation or removal | ✅ Yes | ✅ Yes |
513+
514+
**What's New description patterns for common changes:**
515+
516+
- **New resource:** `Added the [resourceName](/graph/api/resources/{filename}?view=graph-rest-beta&preserve-view=true) resource type.`
517+
- **New property:** `Added the **propertyName** property to the [resourceName](/graph/api/resources/{filename}?view=graph-rest-beta&preserve-view=true) resource type.`
518+
- **New enum:** `Added the **enumName** enumeration type.`
519+
- **New method:** `Added the [methodName](/graph/api/{filename}?view=graph-rest-beta&preserve-view=true) method to the [resourceName](/graph/api/resources/{filename}?view=graph-rest-beta&preserve-view=true) resource type.`
520+
- **New enum member:** `Added the `memberName` member to the **enumName** enumeration type.`
521+
522+
For v1.0, omit the `?view=graph-rest-beta&preserve-view=true` query string from links.
523+
500524
After gathering all inputs, analyze the Documentation Plan to understand the full scope of work.
501525

502526
## Quality checklist
@@ -594,6 +618,8 @@ In addition to the [base quality checklist](common.md#base-quality-checklist), v
594618
- [ ] All TOC changes made if applicable
595619
- [ ] All properties referencing updated enumerations have been updated
596620
- [ ] All permissions files copied
621+
- [ ] Changelog entry added for all schema changes (new resources, properties, enums, methods, deprecations)
622+
- [ ] What's New entry added for all schema changes (matches changelog scope)
597623

598624
**For polymorphic collections (if applicable):**
599625
- [ ] Polymorphism detected from Documentation Plan notes

0 commit comments

Comments
 (0)