Clean up representations

p2-inc / keycloak-orgs

Single realm, multi-tenancy for SaaS apps

Other

362 stars 65 forks source link

Closed xgp closed 4 months ago

xgp commented 4 months ago

Use the lombok @Data and @Builder annotations to clean up the representations.
Make sure we are using snake_case in naming.
- Add methods for backwards compatibility if changed
- Update docs/openapi.yaml if changed

MGLL commented 4 months ago

Does snake_case reference is for @JsonProperty("") annotations?

For example:

  @JsonProperty("domain_name")
  @NotNull
  public String getDomainName() {
    return domainName;
  }

xgp commented 4 months ago

Yes. This ticket is a cleanup issue.

We shouldn't be hand coding these.
We should make sure we update all objects received / returned by the API use snake_case (but also doesn't break backwards compatibility. This has been inconsistent, and it is frustrating to those hand-coding clients and not using the API libs or openapi.yaml

Not really a rush, but we'll probably get to it this quarter.