Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
m (Text replacement - "'''Signatures'''" to "'''Signature'''") |
|||
Line 49: | Line 49: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>rest:init( | |<pre>rest:init( | ||
− | $update as xs:boolean := () | + | $update as xs:boolean? := false() |
) as empty-sequence()</pre> | ) as empty-sequence()</pre> | ||
|- valign="top" | |- valign="top" |
Latest revision as of 17:14, 9 March 2023
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions[edit]
- 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[edit]
rest:base-uri[edit]
Signature | rest:base-uri() as xs:anyURI |
Summary | Returns the implementation-defined base URI of the resource function. |
rest:uri[edit]
Signature | 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[edit]
Signature | rest:wadl() as element(wadl:application) |
Summary | Returns a WADL description of all available REST services. |
rest:init[edit]
Signature | rest:init( $update as xs:boolean? := false() ) as empty-sequence() |
Summary | Initializes the RESTXQ module cache:
|
Changelog[edit]
- Version 9.4
- Updated:
rest:init
argument added
- Version 8.6
- Added:
rest:init
This module was introduced with Version 7.7.