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

Generate OpenAPI descriptors for the Account REST API

    XMLWordPrintable

Details

    • Task
    • Status: Closed
    • Major
    • Resolution: Obsolete
    • None
    • None
    • None
    • Keycloak Sprint 55, Keycloak Sprint 56, Keycloak Sprint 57, Keycloak Sprint 58
    • 8
    • NEW
    • NEW

    Description

      OpenAPI allows us to generate documentation, API clients, and server stubs for several languages based on its descriptor.

      Why?

      As part of the efforts to switch to the new Account console documentation must be provided, to improve the developer's experience.

      How

      There are several ways of doing this, but the best approach is to use MicroProfile OpenAPI which is available in the latest releases of WildFly

      Acceptance criteria

      • Have the OpenAPI descriptor generated with all the definitions for the new Account REST API in YAML/JSON format for ${basedir}/target/

      Additional Information

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              boliveir_managed_kafka_security (inactive user) Bruno Oliveira Silva (Inactive)
              Votes:
              9 Vote for this issue
              Watchers:
              14 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: