Update to workflow outdated documentation#1476
Open
sergioa wants to merge 3 commits intoadorsys:mainfrom
Open
Conversation
Updated CHANGELOG with fix to outdated Keycloak workflow API documentation.
|
Nkwenti-Severian-Ndongtsop
approved these changes
Mar 23, 2026
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.



What this PR does / why we need it:
Keycloak workflow documentation is outdated from actual implementation.
WorkflowRepresentation.withhas been removed and it is ignoredhttps://github.com/keycloak/keycloak/blob/main/core/src/main/java/org/keycloak/representations/workflows/WorkflowRepresentation.java#L33
WorkflowStepRepresentation.confighas been renamed towithhttps://github.com/keycloak/keycloak/blob/main/core/src/main/java/org/keycloak/representations/workflows/AbstractWorkflowComponentRepresentation.java#L23-L24
Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close that issue when PR gets merged): fixes #1477How this PR was tested:
Screenshots / logs (if relevant):
Special notes for your reviewer:
PR Readiness Checklist:
Complete these before marking the PR as
ready to review:mvn testor relevant subset)CHANGELOG.mdrelease notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR