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

REST API design guideline

    XMLWordPrintable

Details

    • Story
    • Status: Closed
    • Major
    • Resolution: Done
    • None
    • None
    • None

    Description

      As a Keycloak developer I would like a REST API guideline so that I can develop consistent and user friendly REST APIs.

      The guideline should cover:

      • Basic functions like versioning, search, pagination
      • API style guidelines
      • How to generate documentation, including OpenAPI descriptions
      • How to properly handle actions
      • Consider if we can provide an API playground for APIs on Keycloak

      The guideline will initially be used by Account Management REST API, followed by Admin API in the future.

      Attachments

        Issue Links

          incorporates

          Task - A task that needs to be done. KEYCLOAK-9655 Generate OpenAPI descriptors for the Account REST API

          • 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

          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

          Task - A task that needs to be done. KEYCLOAK-10788 Provide recommendation about how to properly handle concurrency

          • 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

          Task - A task that needs to be done. KEYCLOAK-10801 Provide recommendation about how to properly handle filtering

          • 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

            People

              boliveir_managed_kafka_security (inactive user) Bruno Oliveira Silva (Inactive)
              sthorger@redhat.com Stian Thorgersen
              Pedro Igor Craveiro
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: