Skip to content

Fix plan-export.md example to use correct New-IdlePlan syntax#123

Merged
blindzero merged 4 commits intowebsitefrom
copilot/sub-pr-121-again
Jan 28, 2026
Merged

Fix plan-export.md example to use correct New-IdlePlan syntax#123
blindzero merged 4 commits intowebsitefrom
copilot/sub-pr-121-again

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 28, 2026

Summary

Corrected the plan export example to match the actual New-IdlePlan API contract.

Motivation

The example used incorrect syntax: .json workflow extension, non-existent -IdentityId parameter, and omitted the mandatory lifecycle request object creation.

Type of Change

  • Documentation update

Changes

  • Changed workflow file extension from .json to .psd1
  • Added New-IdleLifecycleRequest call to create proper request object
  • Updated New-IdlePlan to use mandatory -Request parameter

Before

$plan = New-IdlePlan -WorkflowPath './workflows/joiner.json' -IdentityId 'jdoe'

After

$request = New-IdleLifecycleRequest -LifecycleEvent 'Joiner' -IdentityKeys @{ EmployeeId = 'jdoe' }
$plan = New-IdlePlan -WorkflowPath './workflows/joiner.psd1' -Request $request

Testing

  • Manual testing

How to test & review

Verify the example now matches:

  • New-IdlePlan cmdlet reference at docs/reference/cmdlets/New-IdlePlan.md
  • Patterns in examples/Invoke-IdleDemo.ps1 (line 268-269)

Checklist

  • Code follows STYLEGUIDE.md
  • Tests added or updated (N/A - documentation only)
  • Documentation updated
  • No UI/auth logic added to IdLE.Core
  • No breaking changes without discussion

Related Issues

Addresses feedback from #121 (review comment 2738687275)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
Copilot AI changed the title [WIP] Update pull request based on review feedback for DocuSaurus Fix plan-export.md example to use correct New-IdlePlan syntax Jan 28, 2026
Copilot AI requested a review from blindzero January 28, 2026 21:32
@blindzero blindzero marked this pull request as ready for review January 28, 2026 21:36
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@blindzero blindzero merged commit ddba648 into website Jan 28, 2026
7 checks passed
@blindzero blindzero deleted the copilot/sub-pr-121-again branch January 31, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants