OIDC documentation not explaining format for realm files

bulldog98 commented 2 months ago

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 (b5231da73dbab06e869941aaf2c4e87d79233aac)

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

No response

Additional information

No response

quarkus-bot[bot] commented 2 months ago

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

sberyozkin commented 2 months ago

@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 commented 2 months ago

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

Note the guide to importing and exporting a realm

quarkusio / quarkus