Skip to content
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.

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

OIDC documentation not explaining format for realm files #42330

Closed
bulldog98 opened this issue Aug 6, 2024 · 3 comments · Fixed by #42498
Closed

OIDC documentation not explaining format for realm files #42330

bulldog98 opened this issue Aug 6, 2024 · 3 comments · Fixed by #42498

Comments

@bulldog98
Copy link
Contributor

Describe the bug

For the devservice of oidc the format of the files for property quarkus.keycloak.devservices.realm-path is not explained or linked, also it's not clear where these files have to be in the project to be loaded

Expected behavior

  • The json schema of the realm files should be linked or at least a documentation on how to create these files by hand.
  • It should be explained where these files have to be, something like "files have to be in the resources"

Actual behavior

the javadoc of the property does not help find these information, so in the guide pages it's also not clear how to use this property

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

Quarkus version or git rev

3.8, and main (b5231da)

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

@bulldog98 bulldog98 added the kind/bug Something isn't working label Aug 6, 2024
@quarkus-bot quarkus-bot bot added the area/oidc label Aug 6, 2024
Copy link

quarkus-bot bot commented Aug 6, 2024

/cc @pedroigor (oidc), @sberyozkin (oidc)

@gsmet gsmet added kind/enhancement New feature or request area/documentation and removed kind/bug Something isn't working labels Aug 8, 2024
@sberyozkin
Copy link
Member

@bulldog98 JavaDocs is saying it is a class or file system resource. Realm is not a quarkus concept, and you can't really create it manually.
Would you like to open a doc PR adding some clarifications like mentioning src/main/resources, and adding a link to Keycloak docs related to creating realms ?

@bulldog98
Copy link
Contributor Author

@sberyozkin sure I'm willing to do a PR.

Note the guide to importing and exporting a realm

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

Successfully merging a pull request may close this issue.

3 participants