From 60f41e5590c32f9966e45811388e2e9abe6d6192 Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Wed, 13 Dec 2023 17:47:17 +0100 Subject: [PATCH] Rework displayed text and added a warning Signed-off-by: Alexander Schwartz --- services/pom.xml | 37 +++++++++++++++++++ .../keycloak-admin-api/index.mustache | 18 ++++++--- 2 files changed, 50 insertions(+), 5 deletions(-) diff --git a/services/pom.xml b/services/pom.xml index d5d185f8a056..3e56fca2a823 100755 --- a/services/pom.xml +++ b/services/pom.xml @@ -330,6 +330,9 @@ left ${project.basedir}/target/apidocs-rest/asciidoc + + true + false @@ -363,5 +366,39 @@ + + + + product + + + product + + + + + + org.asciidoctor + asciidoctor-maven-plugin + + + generate-docs + package + + process-asciidoc + + + + false + true + + + + + + + + + diff --git a/services/src/docs/openapi-generator-templates/keycloak-admin-api/index.mustache b/services/src/docs/openapi-generator-templates/keycloak-admin-api/index.mustache index 9b3660c0a8c3..1ad5d8a25e34 100644 --- a/services/src/docs/openapi-generator-templates/keycloak-admin-api/index.mustache +++ b/services/src/docs/openapi-generator-templates/keycloak-admin-api/index.mustache @@ -1,6 +1,7 @@ = {{{appName}}} {{#headerAttributes}} :toc: left +:icons: font :toclevels: 2 :keywords: openapi, rest, {{appName}} :specDir: {{specDir}} @@ -30,11 +31,18 @@ Version: {{version}} For example `http://localhost:8080/admin/realms` -=== OpenApi Definitions -++++ -json -yaml -++++ +ifdef::project_community[] + +=== OpenAPI Definitions + +WARNING: The OpenAPI definitions are a feature that is currently in preview. +Please provide your feedback by link:https://github.com/keycloak/keycloak/discussions/8898[joining this discussion] while we’re continuing to work on this. +If you find something is outdated or wrong, create a GitHub issue and provide a pull request. + +* link:openapi.json[OpenAPI definition in JSON format] +* link:openapi.yaml[OpenAPI definition in YAML format] + +endif::[] {{#specinclude}}intro.adoc{{/specinclude}}