Add flow extensions documentation#6199
Open
KD23243 wants to merge 1 commit into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughAdds two new shared documentation guide files for "flow extensions": one describing the overview, use case, and configuration steps, and another specifying the full HTTP request/response contract for an externally hosted service. Both guides are wired into Asgardeo and Identity Server Next via include-directive page stubs and new navigation entries in each product's ChangesFlow Extensions Documentation
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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
requested review from
ashanthamara,
himeshsiriwardana and
hwupathum
![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: 2
🤖 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/includes/guides/flows/flow-extension-external-service.md`:
- Line 72: The `portalUrl` field in the documentation table contains incomplete
placeholder text `(fix this)` in its description. Replace the entire placeholder
text with a complete and accurate description of what the `portalUrl` field
represents, ensuring the documentation provides clear and release-ready
information about this field's purpose and usage.
- Line 50: The actionType field has inconsistent spelling across the
documentation: the contract specification uses singular "FLOW_EXTENSION" while
the example request uses plural "FLOW_EXTENSIONS". Update the example request at
line 233 to use the singular form "FLOW_EXTENSION" to match the contract
specification defined earlier in the document, ensuring consistency in the
actionType value throughout.
🪄 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: 38ff7378-cdb2-4d3e-b422-490fad34d124
⛔ Files ignored due to path filters (6)
en/asgardeo/docs/assets/img/guides/flows/flow-extension-add-to-flow.gifis excluded by!**/*.gifen/asgardeo/docs/assets/img/guides/flows/flow-extension-configure.gifis excluded by!**/*.gifen/asgardeo/docs/assets/img/guides/flows/flow-extension-create.gifis excluded by!**/*.gifen/identity-server/next/docs/assets/img/guides/flows/flow-extension-add-to-flow.gifis excluded by!**/*.gifen/identity-server/next/docs/assets/img/guides/flows/flow-extension-configure.gifis excluded by!**/*.gifen/identity-server/next/docs/assets/img/guides/flows/flow-extension-create.gifis excluded by!**/*.gif
📒 Files selected for processing (8)
en/asgardeo/docs/guides/flows/flow-extension-external-service.mden/asgardeo/docs/guides/flows/flow-extensions.mden/asgardeo/mkdocs.ymlen/identity-server/next/docs/guides/flows/flow-extension-external-service.mden/identity-server/next/docs/guides/flows/flow-extensions.mden/identity-server/next/mkdocs.ymlen/includes/guides/flows/flow-extension-external-service.mden/includes/guides/flows/flow-extensions.md
|
|
||
| ```json | ||
| { | ||
| "actionType": "FLOW_EXTENSION", |
Contributor
There was a problem hiding this comment.
Resolve inconsistency: actionType singular vs plural.
Line 50 (top-level envelope reference) defines actionType as "FLOW_EXTENSION" (singular), but line 233 (example request) uses "FLOW_EXTENSIONS" (plural). Verify the correct spelling and update the example to match the contract specification.
Also applies to: 233-233
🤖 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/guides/flows/flow-extension-external-service.md` at line 50, The
actionType field has inconsistent spelling across the documentation: the
contract specification uses singular "FLOW_EXTENSION" while the example request
uses plural "FLOW_EXTENSIONS". Update the example request at line 233 to use the
singular form "FLOW_EXTENSION" to match the contract specification defined
earlier in the document, ensuring consistency in the actionType value
throughout.
| | ----- | ---- | ----------- | | ||
| | `flowType` | string | The flow being executed: `REGISTRATION`, `PASSWORD_RECOVERY`, or `INVITED_USER_REGISTRATION`. Branch your logic on this value. | | ||
| | `flowId` | string | The identifier for this single flow execution. | | ||
| | `portalUrl` | string | The portal (fix this). | |
Contributor
There was a problem hiding this comment.
Fix incomplete field description.
Line 72 contains placeholder text (fix this) in the portalUrl field description. Complete this description so the documentation is accurate and release-ready.
🤖 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/guides/flows/flow-extension-external-service.md` at line 72, The
`portalUrl` field in the documentation table contains incomplete placeholder
text `(fix this)` in its description. Replace the entire placeholder text with a
complete and accurate description of what the `portalUrl` field represents,
ensuring the documentation provides clear and release-ready information about
this field's purpose and usage.
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
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.
Purpose
Add documentation for flow extensions, which let an external service be called from within a flow to inject custom logic such as validation, enrichment, or risk evaluation. Covers both configuring the extension in the Console and implementing the external service it calls.
Related Issue
Implementation
Added two guide pages under Guides > Flows > Flow Extensions for both Asgardeo and Identity Server (next), sharing a common include:
flow-extensions.md): explains flow extensions, walks through a loyalty-enrichment sample use case, and provides step-by-step instructions to create the extension, create the returned attributes, configure claim access, and add the extension to the Self Registration flow.flow-extension-external-service.md): documents the HTTP contract the external service must implement, including the request envelope, event/flow/user/application objects,allowedOperations, and theSUCCESS/FAILED/ERRORresponse shapes with examples.Changes:
en/includes/guides/flows/.mkdocs.ymlnavigation for both products to nest the two pages under a Flow Extensions section.