mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
Small improvement to Web Scripts media wiki documentation page.
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5986 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
@@ -8,15 +8,30 @@ Back to [[HTTP API]].
|
|||||||
|
|
||||||
= Introduction =
|
= Introduction =
|
||||||
|
|
||||||
This page provides reference documentation for the Alfresco [[HTTP API]].
|
Welcome to the reference documentation for the Alfresco [[HTTP API]].
|
||||||
|
|
||||||
Generated on ${date?datetime} from
|
This document was generated from the URL
|
||||||
|
|
||||||
GET <nowiki>http://</nowiki><host>:<port>/alfresco/service/indexall.mediawiki
|
GET <nowiki>http://</nowiki><host>:<port>${url.service}
|
||||||
|
|
||||||
= API Reference =
|
on ${date?datetime} using Alfresco v${server.version}.
|
||||||
|
|
||||||
|
|
||||||
|
= Web Script Reference =
|
||||||
|
|
||||||
|
This section provides technical information for all ${webscripts?size} [[Web Scripts]], organised by Web Script Package.
|
||||||
|
|
||||||
|
Documentation for each Web Script includes:
|
||||||
|
|
||||||
|
* Short Name
|
||||||
|
* Description
|
||||||
|
* Available URL templates
|
||||||
|
* Default [[Web Scripts Framework#HTTP Response Formats|response format]]
|
||||||
|
* How to specify an alternative response
|
||||||
|
* Authentication requirements
|
||||||
|
* Transaction requirements
|
||||||
|
* Location of Web Script description document
|
||||||
|
|
||||||
The following reference provides a list of all available Web Scripts organised by Web Script package.
|
|
||||||
<#macro recursepackage package>
|
<#macro recursepackage package>
|
||||||
<#if package.scripts?size > 0>
|
<#if package.scripts?size > 0>
|
||||||
== Package: ${package.path} ==
|
== Package: ${package.path} ==
|
||||||
@@ -25,17 +40,17 @@ The following reference provides a list of all available Web Scripts organised b
|
|||||||
|
|
||||||
=== ${desc.shortName} ===
|
=== ${desc.shortName} ===
|
||||||
|
|
||||||
<#if desc.description??><#if desc.description?ends_with(".")>${desc.description}<#else>${desc.description}.</#if><#else></#if>
|
<#if desc.description??><#if desc.description?ends_with(".")>${desc.description}<#else>${desc.description}.</#if><#else><i>[No description supplied]</i></#if>
|
||||||
|
|
||||||
<#list desc.URIs as uri>
|
<#list desc.URIs as uri>
|
||||||
[http://localhost:8080/${url.serviceContext}${uri} ${desc.method} ${url.serviceContext}${uri}]
|
[http://localhost:8080/${url.serviceContext}${uri} ${desc.method} ${url.serviceContext}${uri}]
|
||||||
</#list>
|
</#list>
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
|
* Default Format: ${desc.defaultFormat!"<i>Determined at run-time</i>"}
|
||||||
* Authentication: ${desc.requiredAuthentication}
|
* Authentication: ${desc.requiredAuthentication}
|
||||||
* Transaction: ${desc.requiredTransaction}
|
* Transaction: ${desc.requiredTransaction}
|
||||||
* Format Style: ${desc.formatStyle}
|
* Format Style: ${desc.formatStyle}
|
||||||
* Default Format: ${desc.defaultFormat!"<i>Determined at run-time</i>"}
|
|
||||||
|
|
||||||
Definition:
|
Definition:
|
||||||
* Id: ${desc.id}
|
* Id: ${desc.id}
|
||||||
@@ -43,6 +58,7 @@ Definition:
|
|||||||
</#list>
|
</#list>
|
||||||
</#if>
|
</#if>
|
||||||
<#list package.children as childpath>
|
<#list package.children as childpath>
|
||||||
|
|
||||||
<@recursepackage package=childpath/>
|
<@recursepackage package=childpath/>
|
||||||
</#list>
|
</#list>
|
||||||
</#macro>
|
</#macro>
|
||||||
|
@@ -335,8 +335,6 @@ public class DeclarativeWebScriptRegistry extends AbstractLifecycleBean
|
|||||||
{
|
{
|
||||||
subpath = path.createChildPath(part);
|
subpath = path.createChildPath(part);
|
||||||
packageByPath.put(subpath.getPath(), subpath);
|
packageByPath.put(subpath.getPath(), subpath);
|
||||||
if (logger.isDebugEnabled())
|
|
||||||
logger.debug("Registered Web Script package " + subpath.getPath());
|
|
||||||
}
|
}
|
||||||
path = subpath;
|
path = subpath;
|
||||||
}
|
}
|
||||||
@@ -366,8 +364,6 @@ public class DeclarativeWebScriptRegistry extends AbstractLifecycleBean
|
|||||||
{
|
{
|
||||||
subpath = path.createChildPath(part);
|
subpath = path.createChildPath(part);
|
||||||
uriByPath.put(subpath.getPath(), subpath);
|
uriByPath.put(subpath.getPath(), subpath);
|
||||||
if (logger.isDebugEnabled())
|
|
||||||
logger.debug("Registered Web Script URI Path " + subpath.getPath());
|
|
||||||
}
|
}
|
||||||
path = subpath;
|
path = subpath;
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user