Rework displayed text and added a warning

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
DAHAG-ArisNourbakhsh · Dec 13, 2023 · 60f41e5 · 60f41e5
1 parent 52c103f
commit 60f41e5
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 5 deletions.
diff --git a/services/pom.xml b/services/pom.xml
@@ -330,6 +330,9 @@
                                         <toc/>
                                         <toc-position>left</toc-position>
                                         <generated>${project.basedir}/target/apidocs-rest/asciidoc</generated>
+                                        <!-- Boolean attributes are passed as defined/undefined to AsciiDoc, not at their literal value -->
+                                        <project_community>true</project_community>
+                                        <project_product>false</project_product>
                                     </attributes>
                                 </configuration>
                             </execution>
@@ -363,5 +366,39 @@
                 </plugins>
             </build>
         </profile>
+
+
+        <profile>
+            <id>product</id>
+            <activation>
+                <property>
+                    <name>product</name>
+                </property>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.asciidoctor</groupId>
+                        <artifactId>asciidoctor-maven-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <id>generate-docs</id>
+                                <phase>package</phase>
+                                <goals>
+                                    <goal>process-asciidoc</goal>
+                                </goals>
+                                <configuration combine.children="append">
+                                    <attributes combine.children="append">
+                                        <project_community>false</project_community>
+                                        <project_product>true</project_product>
+                                    </attributes>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+
     </profiles>
 </project>
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
@@ -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
-++++
-<a href="openapi.json">json</a>
-<a href="openapi.yaml">yaml</a>
-++++
+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}}