Update ctl tool documentation#6172
Open
RovinKYK wants to merge 5 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates IAM-CTL promotion documentation to cover additional resource types and clarify operational behavior via new logging and resource-specific guidance.
Changes:
- Expanded supported IAM-CTL resource type list (with version-gated additions).
- Added new documentation sections for unified logging and resource-type-specific caveats.
- Embedded the new sections into multiple “promote configurations” pages across product/version docs.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| en/includes/deploy/ctl-tool/resource-types-7.x.md | Adds additional resource types and version-gated entries for IAM-CTL propagation docs. |
| en/includes/deploy/ctl-tool/resource-specific-notes.md | New include documenting resource-specific import/export behaviors and caveats. |
| en/includes/deploy/ctl-tool/logging.md | New include documenting IAM-CTL logging configuration and safety warning. |
| en/includes/deploy/ctl-tool/getting-started-7.x.md | Extends required M2M application scopes list for newly supported resources, with version gating. |
| en/identity-server/next/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.3.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.2.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.1.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.0.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/5.11.0/docs/setup/promote-configurations.md | Adds a logging section directly (non-include) for 5.11.0 docs. |
| en/asgardeo/docs/guides/your-asgardeo/manage-environments/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
Comments suppressed due to low confidence (1)
en/includes/deploy/ctl-tool/resource-types-7.x.md:1
- The resource type list includes
Email Templatesunconditionally, butgetting-started-7.x.mdgates Email Template API scopes toserver_version == \"7.0\"and usesNotification TemplateAPIs for>= 7.1. To avoid conflicting guidance, align the resource type list with the same version gating (either gateEmail Templatesto the versions where it exists, or clarify how it maps to notification templates in newer versions).
### Supported resource types
Contributor
|
Warning Review limit reached
More reviews will be available in 13 minutes and 57 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds IAM-CTL logging documentation and resource-specific promotion notes as shared includes, expands ctl-tool reference docs (resource types and permissions), embeds logging in 5.11.0, and inserts include directives into multiple promote-configurations guides for consistent distribution. ChangesCTL-Tool Documentation Enhancement
Suggested labelsTeam/Identity Server Core Suggested reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
en/includes/deploy/ctl-tool/logging.md (1)
23-23: 💤 Low valueConsider using active voice in the property description.
The description "are logged" uses passive voice. As per coding guidelines, prefer active voice. Consider rewording to "logs HTTP request bodies" for clarity and directness.
♻️ Suggested revision
-| `LOG_REQUEST_PAYLOADS` | `true`, `false` | `false` | When set to `true`, HTTP request bodies are logged at `DEBUG` level for POST and PUT requests. | +| `LOG_REQUEST_PAYLOADS` | `true`, `false` | `false` | When set to `true`, logs HTTP request bodies at `DEBUG` level for POST and PUT requests. |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/logging.md` at line 23, Update the description for the LOG_REQUEST_PAYLOADS property to use active voice: replace "HTTP request bodies are logged at `DEBUG` level for POST and PUT requests" with an active phrasing such as "logs HTTP request bodies at `DEBUG` level for POST and PUT requests" while preserving the flag name LOG_REQUEST_PAYLOADS and the behavior details (DEBUG level, POST and PUT).en/includes/deploy/ctl-tool/resource-specific-notes.md (1)
3-3: 💤 Low valueSimplify wordy phrase per coding guidelines.
The phrase "to be aware of when using" is verbose. As per coding guidelines, use concise language. Consider "to note when using" or simply "when using".
♻️ Suggested revision
-The following notes describe resource-type-specific behavior to be aware of when using IAM-CTL. +The following notes describe resource-type-specific behavior when using IAM-CTL.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 3, Replace the verbose phrase "to be aware of when using" in the document with a concise alternative such as "to note when using" or simply "when using"; locate the sentence that currently reads "The following notes describe resource-type-specific behavior to be aware of when using IAM-CTL." and update it to "The following notes describe resource-type-specific behavior to note when using IAM-CTL." (or "when using IAM-CTL") to comply with the concise wording guideline.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/identity-server/5.11.0/docs/setup/promote-configurations.md`:
- Line 168: Replace the bold inline heading "**toolConfig.json**" with the
tab-style include label === "toolConfig.json" and ensure the following JSON
sample is written as a code block using the tab syntax: add a blank line after
=== "toolConfig.json" and start the JSON block with ```json while indenting the
JSON content by 4 spaces (so the code block content is tab-syntax compliant);
locate the literal "**toolConfig.json**" in the file to make this change.
---
Nitpick comments:
In `@en/includes/deploy/ctl-tool/logging.md`:
- Line 23: Update the description for the LOG_REQUEST_PAYLOADS property to use
active voice: replace "HTTP request bodies are logged at `DEBUG` level for POST
and PUT requests" with an active phrasing such as "logs HTTP request bodies at
`DEBUG` level for POST and PUT requests" while preserving the flag name
LOG_REQUEST_PAYLOADS and the behavior details (DEBUG level, POST and PUT).
In `@en/includes/deploy/ctl-tool/resource-specific-notes.md`:
- Line 3: Replace the verbose phrase "to be aware of when using" in the document
with a concise alternative such as "to note when using" or simply "when using";
locate the sentence that currently reads "The following notes describe
resource-type-specific behavior to be aware of when using IAM-CTL." and update
it to "The following notes describe resource-type-specific behavior to note when
using IAM-CTL." (or "when using IAM-CTL") to comply with the concise wording
guideline.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 7d1a1490-c6a7-4d6a-99ec-638fe80e4a62
📒 Files selected for processing (11)
en/asgardeo/docs/guides/your-asgardeo/manage-environments/promote-configurations.mden/identity-server/5.11.0/docs/setup/promote-configurations.mden/identity-server/7.0.0/docs/deploy/promote-configurations.mden/identity-server/7.1.0/docs/deploy/promote-configurations.mden/identity-server/7.2.0/docs/deploy/promote-configurations.mden/identity-server/7.3.0/docs/deploy/promote-configurations.mden/identity-server/next/docs/deploy/promote-configurations.mden/includes/deploy/ctl-tool/getting-started-7.x.mden/includes/deploy/ctl-tool/logging.mden/includes/deploy/ctl-tool/resource-specific-notes.mden/includes/deploy/ctl-tool/resource-types-7.x.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This PR updates CTL tool documentation to reflect the support added to new resource types and the logging improvements.
Related to https://github.com/wso2-enterprise/iam-product-management/issues/662
Related PRs
Test environment
Security checks