Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
m (Text replacement - "\[\[#([^]:]+:[^|]+)\|([^]:]+:[^|]+)\]\]" to "{{Function||$1}}") |
|||
Line 13: | Line 13: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|rest:base-uri||xs:anyURI}} | |{{Func|rest:base-uri||xs:anyURI}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the implementation-defined base URI of the resource function. | |Returns the implementation-defined base URI of the resource function. | ||
Line 24: | Line 24: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|rest:uri||xs:anyURI}} | |{{Func|rest:uri||xs:anyURI}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the complete URI that addresses the Resource Function. This is the result of {{Function||rest:base-uri}} appended with the path from the path annotation of the resource function. | |Returns the complete URI that addresses the Resource Function. This is the result of {{Function||rest:base-uri}} appended with the path from the path annotation of the resource function. | ||
Line 35: | Line 35: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|rest:wadl||element(wadl:application)}} | |{{Func|rest:wadl||element(wadl:application)}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services. | |Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services. | ||
Line 46: | Line 46: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|rest:init||empty-sequence()}}<br/>{{Func|rest:init|$update as xs:boolean|empty-sequence()}} | |{{Func|rest:init||empty-sequence()}}<br/>{{Func|rest:init|$update as xs:boolean|empty-sequence()}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Initializes the RESTXQ module cache: | |Initializes the RESTXQ module cache: |
Revision as of 14:20, 20 July 2022
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions
- The module will be available if the
basex-api
library is found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war). - All functions are assigned to the
http://exquery.org/ns/restxq
namespace, which is statically bound to therest
prefix. - The
http://wadl.dev.java.net/2009/02
namespace is bound to thewadl
prefix. - If any of the functions is called outside the servlet context,
basex:http
is raised.
General Functions
rest:base-uri
Signatures | rest:base-uri() as xs:anyURI
|
Summary | Returns the implementation-defined base URI of the resource function. |
rest:uri
Signatures | rest:uri() as xs:anyURI
|
Summary | Returns the complete URI that addresses the Resource Function. This is the result of rest:base-uri appended with the path from the path annotation of the resource function.
|
rest:wadl
Signatures | rest:wadl() as element(wadl:application)
|
Summary | Returns a WADL description of all available REST services. |
rest:init
Signatures | rest:init() as empty-sequence() rest:init($update as xs:boolean) as empty-sequence()
|
Summary | Initializes the RESTXQ module cache:
|
Changelog
- Version 9.4
- Updated:
rest:init
argument added
- Version 8.6
- Added:
rest:init
This module was introduced with Version 7.7.