Docs Improvement: Identity Governance API #5828
Open
Conversation
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
WalkthroughUpdated the identity-governance OpenAPI document: corrected path parameter name from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/asgardeo/docs/apis/restapis/identity-governance.yaml (1)
73-73: Complete the path placeholder typo fixes mentioned in the commit message.The commit message indicates "incorrect path placeholders" were fixed, but the typo
{catergory-id}(should be{category-id}) still appears in multiple curl example URLs on lines 73, 104, 130, 182, and 209. This inconsistency could confuse API users who copy these examples.📝 Suggested fixes for remaining path placeholder typos
Line 73:
-'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{catergory-id}' \ +'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{category-id}' \Line 104:
-'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{catergory-id}/connectors' \ +'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{category-id}/connectors' \Line 130:
-'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{catergory-id}/connectors' \ +'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{category-id}/connectors' \Line 182:
-'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{catergory-id}/connectors/{connector-id}' \ +'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{category-id}/connectors/{connector-id}' \Line 209:
-'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{catergory-id}/connectors/{connector-id}' \ +'https://api.asgardeo.io/t/{organization-name}/api/server/v1/identity-governance/{category-id}/connectors/{connector-id}' \Also applies to: 104-104, 130-130, 182-182, 209-209
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/asgardeo/docs/apis/restapis/identity-governance.yaml
🔇 Additional comments (2)
en/asgardeo/docs/apis/restapis/identity-governance.yaml (2)
488-488: LGTM! Spelling correction improves documentation quality.The typo fix "recieved" → "received" is correct and enhances the professionalism of the API documentation.
496-496: LGTM! Spelling correction improves documentation quality.The typo fix "occured" → "occurred" is correct and enhances the professionalism of the API documentation.
Author
|
Thanks for the review!
All remaining {catergory-id} typos in the curl examples have been fixed in the latest commit. Please let me know if there are any further issues.
…________________________________
From: coderabbitai[bot] ***@***.***>
Sent: Sunday, January 11, 2026 5:24 AM
To: wso2/docs-is ***@***.***>
Cc: WEK Imasha ***@***.***>; Author ***@***.***>
Subject: Re: [wso2/docs-is] Docs Improvement: Identity Governance API (PR #5828)
You don't often get email from ***@***.*** Learn why this is important<https://aka.ms/LearnAboutSenderIdentification>
@coderabbitai[bot] commented on this pull request.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
________________________________
496-496: LGTM! Spelling correction improves documentation quality.
The typo fix "occured" → "occurred" is correct and enhances the professionalism of the API documentation.
—
Reply to this email directly, view it on GitHub<#5828 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/BJ5SZVJMWYKE5CWJLWDSJN34GIQFBAVCNFSM6AAAAACRKMNJ4WVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTMNBXGU4DCNBSHE>.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
Author
|
Thank you for the review! All occurrences of {catergory-id} have been replaced with {category-id} in the example URLs. Please let me know if any are still missed. |
Author
|
Hi @team, Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
…docs
Purpose
Fix minor documentation issues in the Asgardeo Identity Governance API specification.
This includes:
recieved→received,occured→occurred) in the Error schema.{catergory-id}→{category-id}).These changes improve clarity, accuracy, and developer experience when using the API docs.
Related PRs
None (first PR for this branch).
Test environment
Docs-only change; verified visually in the YAML file.
Security checks
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.