Skip to content

fix(docs): missing info on id when creating realms #11259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
GuillaumeDorschner wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): missing info on id when creating realms #11259

GuillaumeDorschner wants to merge 2 commits into from
+3 −1

Conversation

@GuillaumeDorschner
Copy link
Contributor

@GuillaumeDorschner GuillaumeDorschner commented Dec 4, 2025

SUMMARY

This PR updates the Keycloak realm module documentation to clarify that the id field is required when creating a new realm.

@ansibullbot
Copy link
Collaborator

ansibullbot commented Dec 4, 2025

cc @eikef @kris2kris @mattock @ndclt @thomasbach-dev
click here for bot help

@ansibullbot ansibullbot added docs_only module module new_contributor Help guide this first time contributor plugins plugin (any type) small_patch Hopefully easy to review labels Dec 4, 2025
@ansibullbot

This comment was marked as outdated.

Sign in to view
@ansibullbot ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Dec 4, 2025
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-11 Automatically create a backport for the stable-10 branch backport-12 Automatically create a backport for the stable-12 branch labels Dec 4, 2025
felixfontein
felixfontein reviewed Dec 4, 2025
View reviewed changes
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! If id is required for creation, the code should also enforce this. Would you mind adding a check to it in the creation code-path?

@GuillaumeDorschner @felixfontein
remove required field
a5d65bd 
Co-authored-by: Felix Fontein <felix@fontein.de>
@ansibullbot ansibullbot removed ci_verified Push fixes to PR branch to re-run CI small_patch Hopefully easy to review needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR new_contributor Help guide this first time contributor labels Dec 5, 2025
@GuillaumeDorschner
Copy link
Contributor Author

GuillaumeDorschner commented Dec 8, 2025

@felixfontein I removed the option required

russoz
russoz approved these changes Dec 8, 2025
View reviewed changes
Copy link
Collaborator

@russoz russoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@felixfontein
Copy link
Collaborator

felixfontein commented Dec 8, 2025

@GuillaumeDorschner what about:

If id is required for creation, the code should also enforce this. Would you mind adding a check to it in the creation code-path?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@felixfontein felixfontein felixfontein left review comments

@russoz russoz russoz approved these changes

Assignees

No one assigned

Labels

backport-11 Automatically create a backport for the stable-10 branch backport-12 Automatically create a backport for the stable-12 branch check-before-release PR will be looked at again shortly before release and merged if possible. docs_only module module plugins plugin (any type)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@GuillaumeDorschner @ansibullbot @felixfontein @russoz