Uploaded image for project: 'Keycloak'
  1. Keycloak
  2. KEYCLOAK-14321

OpenAPI export from the server and import in the Operator

    Details

    • Epic Name:
      OpenAPI support
    • Epic Status:
      To Do
    • Docs QE Status:
      NEW
    • QE Status:
      NEW

      Description

      Motivation

      The Operator Custom Resources should reflect 1:1 Keycloak REST model (at least for Realms/Users and probably Clients). Currently there's no other way to do it, other than manual sync. This process is very error prone, especially for nullable/non-nullable options with default values (e.g. boolean false).

      During the Keycloak Server build process we should export OpenAPI (previously known as Swagger) specification. Such a specification should be uploaded to a well-known public place, such as Maven Repository. Then, the Operator will pull it and validate (or even generate) our CRs based on it.

      Design

      TBD

      Rough Estimate

      At least a week for the server and 2-3 weeks for the Operator.

      Open Questions

      1. Where to store the OpenAPI Schema?
      2. How to export it automatically from Keycloak Server?
      3. Is it possible to generate/validate our CRs based on it? How?

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  sebastian.laskawiec Sebastian Laskawiec
                • Votes:
                  1 Vote for this issue
                  Watchers:
                  3 Start watching this issue

                  Dates

                  • Created:
                    Updated: