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

Generate OpenAPI descriptors for the Account REST API

    XMLWordPrintable

Details

    • 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

          blocks

          Task - A task that needs to be done. KEYCLOAK-14744 Generate REST API documentation based on OpenAPI descriptors

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          causes

          Task - A task that needs to be done. KEYCLOAK-10787 Provide recommendation about how to properly document REST APIs

          • Critical - To be worked on immediately following BLOCKER issues.
          • Closed
          is blocked by

          Task - A task that needs to be done. WFLY-13766 MicroProfile OpenAPI subsystem cannot be used in legacy feature packs

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          is incorporated by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. KEYCLOAK-9344 REST API design guideline

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Activity

            Public project attachment banner

              context keys: [headless, issue, helper, isAsynchronousRequest, project, action, user]
              current Project key: KEYCLOAK

              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: