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

Add KeycloakRealmResource and AddRealm method #7120

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

paulomorgado
Copy link

@paulomorgado paulomorgado commented Jan 15, 2025

Description

This PR introduces a new AddRealm method in the KeycloakResourceBuilderExtensions class, enabling the addition of Keycloak Realm resources to the application model. The method constructs a KeycloakRealmResource using an IResourceBuilder<KeycloakResource>, a realm name, and an optional realm name parameter.

Additionally, a new KeycloakRealmResource class is defined, which includes properties for various Keycloak endpoints and their expressions, along with a constructor and detailed XML documentation.

Changes to PublicAPI.Unshipped.txt reflect the inclusion of the new method and class in the public API.

Fixes #5092

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

This commit introduces a new `AddRealm` method in the
`KeycloakResourceBuilderExtensions` class, enabling the
addition of Keycloak Realm resources to the application model.
The method constructs a `KeycloakRealmResource` using an
`IResourceBuilder<KeycloakResource>`, a realm name, and an
optional realm name parameter.

Additionally, a new `KeycloakRealmResource` class is defined,
which includes properties for various Keycloak endpoints and
their expressions, along with a constructor and detailed XML
documentation.

Changes to `PublicAPI.Unshipped.txt` reflect the inclusion
of the new method and class in the public API.
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Jan 15, 2025
@davidfowl
Copy link
Member

No sample or tests?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create KeycloakRealmResource to represent the address of a realm
2 participants