libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

KEYCLOAK-4657 Sort out REST API for prod profile

Browse source
This commit is contained in:
Stian Thorgersen 2017-03-27 20:46:38 +02:00
parent 9303a9c7d0
commit 6b21b4d87b
3 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
services/pom.xml
View file

@ -218,6 +218,27 @@
<build>
<plugins>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-resources</id>
<phase>validate</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>target/docs</outputDirectory>
<resources>
<resource>
<directory>src/docs</directory>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
@ -244,7 +265,7 @@
<reportOutputDirectory>${project.basedir}/target/apidocs-rest/swagger</reportOutputDirectory>
<useStandardDocletOptions>false</useStandardDocletOptions>
<additionalparam> -skipUiFiles -apiVersion 1 -includeResourcePrefixes org.keycloak.services.resources.admin,org.keycloak.protocol.oidc -docBasePath /apidocs -apiBasePath http://localhost:8080/auth -apiInfoFile ${project.basedir}/src/docs/swagger/apiinfo.json</additionalparam>
<additionalparam> -skipUiFiles -apiVersion 1 -includeResourcePrefixes org.keycloak.services.resources.admin,org.keycloak.protocol.oidc -docBasePath /apidocs -apiBasePath http://localhost:8080/auth -apiInfoFile ${project.basedir}/target/docs/swagger/apiinfo.json</additionalparam>
</configuration>
<goals>
<goal>javadoc</goal>
@ -289,7 +310,7 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>${project.basedir}/src/docs/asciidoc</sourceDirectory>
<sourceDirectory>${project.basedir}/target/docs/asciidoc</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<outputDirectory>${project.basedir}/target/apidocs-rest/output</outputDirectory>
<backend>html5</backend>

5
services/src/docs/asciidoc/overview.adoc
View file

@ -1,7 +1,7 @@
= Keycloak Admin REST API
= ${product.name.full} Admin REST API
== Overview
This is a REST API reference for the Keycloak Admin
This is a REST API reference for the ${product.name.full} Admin
=== Version information
Version: 1
@ -10,4 +10,3 @@ Version: 1
Host: localhost:8080
BasePath: /auth
Schemes: HTTP

4
services/src/docs/swagger/apiinfo.json
View file

@ -1,4 +1,4 @@
{
"title": "Keycloak Admin REST API",
"description": "This is a REST API reference for the Keycloak Admin"
"title": "${product.name.full} Admin REST API",
"description": "This is a REST API reference for the ${product.name.full} Admin"
}