diff --git a/distribution/docs-dist/assembly.xml b/distribution/docs-dist/assembly.xml index 879e92c6d1..c1a1bd97dd 100755 --- a/distribution/docs-dist/assembly.xml +++ b/distribution/docs-dist/assembly.xml @@ -13,7 +13,7 @@ javadocs - ../../services/target/apidocs + ../../services/target/apidocs-rest/output rest-api diff --git a/services/pom.xml b/services/pom.xml index 41d80e752f..25e1756547 100755 --- a/services/pom.xml +++ b/services/pom.xml @@ -13,6 +13,10 @@ Keycloak REST Services + + 1.0.5 + + org.bouncycastle @@ -188,27 +192,114 @@ org.apache.maven.plugins maven-javadoc-plugin - - org.keycloak.services.resources.admin:org.keycloak.protocol.oidc - com.lunatech.doclets.jax.jaxrs.JAXRSDoclet - - - com.lunatech.jax-doclets - doclets - 0.10.2 - - - false - - - ../javadocs - ${project.basedir}/../target/site/apidocs - - - -disablejavascriptexample - -pathexcludefilter '/admin/.*index.*' -pathexcludefilter '/admin' -pathexcludefilter '/admin/\\{realm\\}/console.*' - + + + generate-service-docs + generate-resources + + com.carma.swagger.doclet.ServiceDoclet + + com.carma + swagger-doclet + ${version.swagger.doclet} + + + org.keycloak.services.resources.admin:org.keycloak.protocol.oidc + false + + + ../javadocs + ${project.basedir}/../target/site/apidocs + + + + ${project.basedir}/target/apidocs-rest/swagger + false + -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 + + + javadoc + + + + + + + jboss-release + + + + + false + + central + bintray + http://jcenter.bintray.com + + + + + + + com.redowlanalytics + swagger2markup-maven-plugin + 0.7.1 + + + + io.github.robwin + swagger2markup + 0.7.1 + + + + + + gen-asciidoc + process-resources + + process-swagger + + + ${project.basedir}/target/apidocs-rest/swagger/apidocs + ${project.basedir}/target/apidocs-rest/asciidoc + asciidoc + + + + + + + org.asciidoctor + asciidoctor-maven-plugin + 1.5.2 + + + generate-docs + package + + process-asciidoc + + + ${project.basedir}/src/docs/asciidoc + index.adoc + ${project.basedir}/target/apidocs-rest/output + html5 + + + ${project.basedir}/target/apidocs-rest/asciidoc + + + + + + + + + diff --git a/services/src/docs/asciidoc/index.adoc b/services/src/docs/asciidoc/index.adoc new file mode 100644 index 0000000000..226d206aca --- /dev/null +++ b/services/src/docs/asciidoc/index.adoc @@ -0,0 +1,3 @@ +include::{generated}/overview.adoc[] +include::{generated}/paths.adoc[] +include::{generated}/definitions.adoc[] \ No newline at end of file diff --git a/services/src/docs/swagger/apiinfo.json b/services/src/docs/swagger/apiinfo.json new file mode 100644 index 0000000000..575955f57d --- /dev/null +++ b/services/src/docs/swagger/apiinfo.json @@ -0,0 +1,4 @@ +{ + "title": "Keycloak Admin REST API", + "description": "This is a REST API reference for the Keycloak Admin" +} \ No newline at end of file diff --git a/services/src/main/java/org/keycloak/services/resources/admin/AdminRoot.java b/services/src/main/java/org/keycloak/services/resources/admin/AdminRoot.java index d57e96ee32..834d957324 100755 --- a/services/src/main/java/org/keycloak/services/resources/admin/AdminRoot.java +++ b/services/src/main/java/org/keycloak/services/resources/admin/AdminRoot.java @@ -77,6 +77,7 @@ public class AdminRoot { /** * Convenience path to master realm admin console * + * @exclude * @return */ @GET @@ -90,6 +91,7 @@ public class AdminRoot { /** * Convenience path to master realm admin console * + * @exclude * @return */ @Path("index.{html:html}") // expression is actually "index.html" but this is a hack to get around jax-doclet bug @@ -118,6 +120,7 @@ public class AdminRoot { /** * path to realm admin console ui * + * @exclude * @param name Realm name (not id!) * @return */