+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+[/#macro]
+[#--Macro that wraps its text in a deprecated
+
+
+
+
+
+
+ [#nested/]
+
+
+
+
+
+ ${apiDoc}
+
+ [/#if]
+ [#if resourceApis?size > 0]
+
+ Resources
+ [#list resourceApis as resourceApi] + [#if downloads?size > 0] + ++ The resources use a data model that is supported by a set of client-side libraries that are made available on the + files and libraries page. +
+ [/#if] + [#if resourceApi.wadlFile??] + ++ There is a WADL document available that describes the resources API. +
+ [/#if] + [#if swaggerUI??] + ++ You may also enjoy the interactive interface provided for this API by Swagger. +
++ Try it out! +
+ [/#if] + +| name | + [/#if] +path | +methods | +description | +
|---|---|---|---|
| [@deprecation element=resourceGroup]${resourceGroup.label}[/@deprecation] | + [/#if] +
|
+
|
+ [@deprecation element=resourceGroup]${resourceGroup.description!" "}[/@deprecation] | +
Services
+ [#list serviceApis as serviceApi] + [#list serviceApi.serviceGroups as serviceGroup] + +| name | +description | +
|---|---|
| [@deprecation element=service]${service.label}[/@deprecation] | +[@deprecation element=service]${service.description!" "}[/@deprecation] | +
The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.
+ [/#if] + [/#if] + [#if data?size > 0 && includeDataTypesHomeIndex] + +Data Types
+ [#list data as syntax] + [@processDataSyntax syntax=syntax/] + +${syntax.label}
+ [#list syntax.namespaces as ns] + [#if ns.types?size > 0] + +| type | +description | +
|---|---|
| [@deprecation element=type]${type.label}[/@deprecation] | +[@deprecation element=type]${type.description}[/@deprecation] | +
Data Types
+ [#list data as syntax] + +${syntax.label}
+ [#list syntax.namespaces as ns] + [#if ns.types?size > 0] + +| type | +description | +
|---|---|
| [@deprecation element=type]${type.label}[/@deprecation] | +[@deprecation element=type]${type.description}[/@deprecation] | +
Files and Libraries
+ + [#list downloads as download] +${download.name}
+ [#if download.created??] +Created ${download.created?date?string.long}
+ [/#if] + [#if download.artifactId??] +-
+ [#if download.groupId??]
+
- groupId +
- ${download.groupId} + [/#if] + [#if download.artifactId??] +
- artifactId +
- ${download.artifactId} + [/#if] + [#if download.version??] +
- version +
- ${download.version} +
${download.description}
+ [/#if] +| name | +size | +description | +
|---|---|---|
| ${file.name} | +${file.size} | +${file.description!download.description!" "} | +
Resources
+ + [#list resourceApis as resourceApi] + [#if downloads?size > 0] ++ The resources use a data model that is supported by a set of client-side libraries that are made available on the + files and libraries page. +
+ [/#if] + [#if resourceApi.wadlFile??] ++ There is a WADL document available that describes the resources API. +
+ [/#if] + [#if swaggerUI??] ++ You may also enjoy the interactive interface provided for this API by Swagger. +
++ Try it out! +
+ [/#if] +| name | + [/#if] +path | +methods | +description | +
|---|---|---|---|
| [@deprecation element=resourceGroup]${resourceGroup.label}[/@deprecation] | + [/#if] +
|
+
|
+ [@deprecation element=resourceGroup]${resourceGroup.description!" "}[/@deprecation] | +
Services
+ [#list serviceApis as serviceApi] + [#list serviceApi.serviceGroups as serviceGroup] + +| name | +description | +
|---|---|
| [@deprecation element=service]${service.label}[/@deprecation] | +[@deprecation element=service]${service.description!" "}[/@deprecation] | +
The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.
+ [/#if] + [/@boilerplate] + [/@file] +[/#if] +[#macro processResourceGroup resourceGroup] + [#assign pagenav=[]/] + [#list resourceGroup.resources as resource] + [#list resource.methods as method] + [#assign path=resource.path/] + [#if ((includeApplicationPath!false) && (resourceGroup.relativeContextPath?has_content))] + [#assign path="/" + resourceGroup.relativeContextPath + resource.path/] + [/#if] + [#assign pagenav=pagenav + [{ "href" : "#" + method.slug, "title" : method.label + " " + path }]/] + [/#list] + [/#list] + [#-- @ftlvariable name="resourceGroup" type="com.webcohesion.enunciate.api.resources.ResourceGroup" --] + [@file name=resourceGroup.slug + ".html"] + [@boilerplate title=title + ": " + resourceGroup.label breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : "Resources" , "href" : "resources.html"}, {"title" : resourceGroup.label , "href" : resourceGroup.slug + ".html"}] pagenav=pagenav] +${resourceGroup.label} Resource
+ [#if resourceGroup.description??] + +${resourceGroup.description}
+ [/#if] + [#list resourceGroup.resources as resource] + [#if resource.since?? || resource.version?? || resource.seeAlso??] + +-
+ [#if resource.since??]
+
- Available Since +
- ${resource.since} + [/#if] + [#if resource.version??] +
- Version +
- ${resource.version} + [/#if] + [#if resource.seeAlso??] + [#list resource.seeAlso as seeAlso] +
- See Also +
- ${seeAlso} + [/#list] + [/#if] +
+
+
+ [/#if]
+ [#if method.requestEntity??]
+
+
+
+ [/#if]
+ [#if method.responseCodes?size > 0]
+
+
+
+ [/#if]
+ [#if method.responseEntity??]
+
+
+
+ [/#if]
+ [#if method.warnings?size > 0]
+
+
+
+ [/#if]
+ [#if method.responseHeaders?size > 0]
+
+
+
+
+ [/#if]
+ [#if method.example??]
+
+ [/#list]
+ [/#list]
+ [/@boilerplate]
+ [/@file]
+[/#macro]
+[#macro processService service]
+ [#assign pagenav=[]/]
+ [#list service.operations as operation]
+ [#assign pagenav=pagenav + [{ "href" : "#" + operation.slug, "title" : operation.name }]/]
+ [/#list]
+ [#-- @ftlvariable name="service" type="com.webcohesion.enunciate.api.services.Service" --]
+ [@file name=service.slug + ".html"]
+ [@boilerplate title=title + ": " + service.label breadcrumbs=[{"title" : "Home", "href" : indexPageName}, {"title" : service.label , "href" : service.slug + ".html"}] pagenav=pagenav]
+ ${method.label} [#if ((includeApplicationPath!false) && (resourceGroup.relativeContextPath?has_content))]/${resourceGroup.relativeContextPath}[/#if]${resource.path}[#if !disableResourceLinks!false] [/#if]
+ [#if resourceGroup.deprecated?? || method.deprecated??] + +This method has been deprecated. [#if method.deprecated??] ${method.deprecated!""}[#else] ${resource.deprecated!""}[/#if]
+ [/#if]
+ [#if method.description??]
+
+ ${method.description}
+ [/#if] + [#-- would be nice to enable a "Try it out" link to Swagger. See https://github.com/swagger-api/swagger-spec/issues/239 + [#if swaggerUI??] + + + [/#if] + --] + [#assign securityRoles=method.securityRoles![]/] + [#if (method.since?? || method.version?? || method.seeAlso?? || securityRoles?size > 0)] + +-
+ [#if method.since??]
+
- Available Since +
- ${method.since} + [/#if] + [#if method.version??] +
- Version +
- ${method.version} + [/#if] + [#if securityRoles?size > 0] +
- Security Roles Allowed +
- [#list securityRoles as role]${role}[#if role_has_next], [/#if][/#list] + [/#if] + [#if method.seeAlso??] + [#list method.seeAlso as seeAlso] +
- See Also +
- ${seeAlso} + [/#list] + [/#if] +
| name | +type | +description | + [#assign includeDefault=method.includeDefaultParameterValues/] + [#if includeDefault] +default | + [/#if] + [#assign includeConstraints=method.hasParameterConstraints/] + [#if includeConstraints] +constraints | + [/#if] + [#assign includeMultiplicity=method.hasParameterMultiplicity/] + [#if includeMultiplicity] +multivalued | + [/#if] +
|---|---|---|---|---|---|
| ${parameter.name} | +${parameter.typeLabel} | +${parameter.description!" "} | + [#if includeDefault] +${parameter.defaultValue!" "} | + [/#if] + [#if includeConstraints] +${parameter.constraints!" "} | + [/#if] + [#if includeMultiplicity] +${parameter.multivalued?string("yes", "no")} | + [/#if] +
| media type | +data type | + [#if method.requestEntity.description??] +description | + [/#if] +
|---|---|---|
| ${io.mediaType} | +[@referenceDataType referenceType=io.dataType!{"label" : "(custom)"}/][#if io.syntax??] (${io.syntax})[/#if] | + [#if io_index = 0 && method.requestEntity.description??] +
| code | +condition | + [#assign hasExpectedTypes=false/] + [#list method.responseCodes as responseCode] + [#if responseCode.mediaTypes?size > 0] + [#assign hasExpectedTypes=true/] + [/#if] + [/#list] + [#if hasExpectedTypes] +type | + [/#if] +
|---|---|---|
| ${responseCode.code} | +${responseCode.condition!""} | + [#if hasExpectedTypes] +
|
+ [/#if]
+
| media type | +data type | + [#if method.responseEntity.description??] +description | + [/#if] +
|---|---|---|
| ${io.mediaType} | +[@referenceDataType referenceType=io.dataType!{"label" : "(custom)"}/][#if io.syntax??] (${io.syntax})[/#if] | + [#if io_index = 0 && method.responseEntity.description??] +
| code | +condition | +
|---|---|
| ${responseCode.code} | +${responseCode.condition!""} | +
| name | +description | +
|---|---|
| ${header.name} | +${header.description!" "} | +
Example
+ +
+
+ [/#if]
+
+
+
+
+ Request
+
+${method.example.requestHeaders?xhtml}
+ [#if method.example.requestLang??]
+
+${method.example.requestBody?xhtml}
+
+ [/#if]
+
+
+
+ Response
+
+${method.example.responseHeaders?xhtml}
+ [#if method.example.responseLang??]
+
+${method.example.responseBody?xhtml}
+
+ [/#if]
+
+ ${service.label} Service
+ [#if service.deprecated??] + +This service has been deprecated. ${service.deprecated}
+ [/#if]
+ [#if service.description??]
+
+ ${service.description}
+ [/#if] + +-
+ [#if service.namespace?? && service.namespace?length > 0]
+
- Namespace +
- ${service.namespace} + [/#if] + [#if service.group.wsdlFile??] +
- WSDL +
- ${service.group.wsdlFile.href} + [/#if] + [#if service.path??] +
- Path +
- ${service.path} + [/#if] + [#if service.since??] +
- Available Since +
- ${service.since} + [/#if] + [#if service.version??] +
- Version +
- ${service.version} + [/#if] + [#if service.seeAlso??] + [#list service.seeAlso as seeAlso] +
- See Also +
- ${seeAlso} + [/#list] + [/#if] +
${operation.name} Operation
+ [#if operation.deprecated??] + +This method has been deprecated. ${operation.deprecated}
+ [/#if]
+ [#if operation.description??]
+
+ ${operation.description}
+ [/#if] + [#if (operation.since?? || operation.version?? || operation.seeAlso??)] + +-
+ [#if operation.since??]
+
- Available Since +
- ${operation.since} + [/#if] + [#if operation.version??] +
- Version +
- ${operation.version} + [/#if] + [#if operation.seeAlso??] + [#list operation.seeAlso as seeAlso] +
- See Also +
- ${seeAlso} + [/#list] + [/#if] +
| name | +type | +description | +
|---|---|---|
| ${parameter.name} | +[@referenceDataType referenceType=parameter.dataType/] | +${parameter.description!" "} | +
| name | +type | +description | +
|---|---|---|
| ${parameter.name} | +[@referenceDataType referenceType=parameter.dataType/] | +${parameter.description!" "} | +
| name | +type | +description | +
|---|---|---|
| ${parameter.name} | +[@referenceDataType referenceType=parameter.dataType/] | +${parameter.description!" "} | +
| type | +description | +
|---|---|
| [@referenceDataType referenceType=operation.returnType/] | +${operation.returnDescription!" "} | +
| name | +type | +conditions | +
|---|---|---|
| ${fault.name} | +[@referenceDataType referenceType=fault.dataType/] | +${fault.conditions!" "} | +
${syntax.label}
+ [#list syntax.namespaces as ns] + [#if ns.types?size > 0] + +| type | +description | +
|---|---|
| [@deprecation element=type]${type.label}[/@deprecation] | +[@deprecation element=type]${type.description}[/@deprecation] | +
${type.label} Data Type
+ [#if type.deprecated??] + +This data type has been deprecated. ${type.deprecated}
+ [/#if]
+ [#if type.description??]
+
+ ${type.description}
+ [/#if] + +-
+ [#if type.namespace.uri??]
+
- Namespace + [#if type.namespace.uri?length > 0] +
${type.namespace.uri}
+ [#else]
+ - (Default) + [/#if] + [/#if] + [#if type.namespace.schemaFile??] +
- Schema +
- ${type.namespace.schemaFile.href} + [/#if] + [#if type.since??] +
- Available Since +
- ${type.since} + [/#if] + [#if type.version??] +
- Version +
- ${type.version} + [/#if] + [#if type.abstract] +
- Abstract Type + + [/#if] + [#if type.subtypes??] +
- Subtypes +
- [#list type.subtypes as subtype][#if subtype.slug??]${subtype.label}[#else]${subtype.label}[/#if][#if subtype_has_next], [/#if][/#list] + [/#if] + [#if type.interfaces??] +
- Implemented Interfaces +
- [#list type.interfaces as iface]${iface.label}[#if iface_has_next], [/#if][/#list] + [/#if] + [#if type.seeAlso??] + [#list type.seeAlso as seeAlso] +
- See Also +
- ${seeAlso} + [/#list] + [/#if] +
| value | +description | +
|---|---|
| ${value.value} | +[#if value.since??]since ${value.since} [/#if]${value.description!" "} | +
| name | +data type | + [#list type.propertyMetadata?keys as meta] +${type.propertyMetadata[meta]} | + [/#list] +description | +
|---|---|---|---|
| [@deprecation element=property]${property.name}[/@deprecation] | +[@deprecation element=property][@referenceDataType referenceType=property.dataType/][/@deprecation] | + [#list type.propertyMetadata?keys as meta] +[@deprecation element=property][/@deprecation] | + [/#list] +[@deprecation element=property][#if property.since??]since ${property.since} [/#if]${property.description!" "}[/@deprecation] | +
Properties inherited from ${supertype.label} |
+ |||
| ${superProperty.name} | +[@referenceDataType referenceType=superProperty.dataType/] | + [#list type.propertyMetadata?keys as meta] ++ [/#list] + | [#if superProperty.since??]since ${superProperty.since} [/#if]${superProperty.description!" "} | +
Example
+ [#if type.abstract && type.subtypes?? ] + +This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
+ [/#if]
+
+ ${type.example.body?xhtml}
+ [/#if]
+ [/@boilerplate]
+ [/@file]
+[/#macro]
+[#macro referenceDataType referenceType]
+[#-- @ftlvariable name="type" type="com.webcohesion.enunciate.api.datatype.DataTypeReference" --]
+[#if referenceType.containers??][#list referenceType.containers as container]${container?string} of [/#list][/#if][#if referenceType.slug??][/#if]${referenceType.label!"(custom)"}[#if referenceType.slug??][/#if]
+[/#macro]
+[#macro printPropertyMetadata property meta]
+ [#assign metaValue=property[meta]!({ "structure" : true })/]
+ [#if metaValue?is_hash && metaValue.structure!false]
+[#if metaValue.href??][/#if][#if metaValue.title??][/#if]${metaValue.value!" "}[#if metaValue.title??][/#if][#if metaValue.href??][/#if]
+ [#else]
+${metaValue}
+ [/#if]
+[/#macro]
\ No newline at end of file
diff --git a/src/main/resources/META-INF/d4science_enunciate_custom.css b/src/main/resources/META-INF/d4science_enunciate_custom.css
new file mode 100644
index 0000000..9dae183
--- /dev/null
+++ b/src/main/resources/META-INF/d4science_enunciate_custom.css
@@ -0,0 +1,25 @@
+.d4science_intro {
+ top: 0;
+ z-index: 2000;
+ position: fixed;
+ display: block ruby;
+ padding: 10px;
+ background: white;
+ width: 100%;
+}
+
+.navbar-fixed-top {
+ top: 100px !important;
+}
+
+.sidebar {
+ top: 160px !important;
+}
+
+.navbar {
+ margin-bottom: 40px !important;
+}
+
+.main {
+ top: 90px;
+}
\ No newline at end of file