Skip to content

Fix inconsistencies between PowerShell snippets and JSON export examples in plan-export docs #275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blindzero merged 2 commits into from
Mar 22, 2026
Merged

Fix inconsistencies between PowerShell snippets and JSON export examples in plan-export docs #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74a39c7
Initial plan
Copilot Mar 22, 2026
8d71c4b
Make example calls consistent and adhere to real schema of export
Copilot Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/specs/plan-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ This bound prevents unbounded snapshot artifacts while keeping the marker audita
```json
"plan": {
"id": "plan-001",
"mode": "PlanOnly",
"mode": null,
"steps": []
}
```
Expand All @@ -177,7 +177,7 @@ This bound prevents unbounded snapshot artifacts while keeping the marker audita
| ------ | ------------ |
| id | Unique identifier of the plan |
| createdAt | (Optional) ISO-8601 UTC timestamp |
| mode | Plan lifecycle state |
| mode | Plan lifecycle state (`null` when not explicitly set on the plan object) |
| steps | Ordered list of step objects |

---
Expand Down
2 changes: 1 addition & 1 deletion docs/use/plan-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Plan export is useful to:
## Export a plan

```powershell
$request = New-IdleRequest -LifecycleEvent 'Joiner' -CorrelationId (New-Guid) -IdentityKeys @{
$request = New-IdleRequest -LifecycleEvent 'Joiner' -CorrelationId (New-Guid) -Actor 'HR-System' -IdentityKeys @{
EmployeeId = '12345'
} -Intent @{
Department = 'IT'
Expand Down
Loading