Changes

Jump to navigation Jump to search
466 bytes added ,  18:50, 18 November 2020
=Conventions=
* The module will be available if the {{Code|basex-api}} package must be included library is found in the classpath. This is always the case if you use one of the complete distributions of BaseX (zip, exe, war) of BaseX.* All functions are assigned to the <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace. The module must be imported in the query prolog:<pre class="brush:xquery">import module namespace rest = "http://exquery.org/ns/restxq";...</pre>* In this documentation, the namespace which is statically bound to the {{Code|rest}} prefix, and the {{Code|.* The <code><nowiki>http://wadl.dev.java.net/2009/02}} </nowiki></code> namespace is bound to the {{Code|wadl}} prefix.* If any of the functions is called outside the servlet context, the error {{Error|BXSE0003|<code>[[XQuery Errors#BaseX Errors}} |basex:http]]</code> is raised.
=General Functions=
==rest:base-uri==
 
{| width='100%'
|-
|-
| '''Summary'''
|This function returns Returns the implementation-defined base URI of the resource function.
|}
==rest:uri==
 
{| width='100%'
|-
|-
| '''Summary'''
|This function returns Returns the complete URI that addresses the Resource Function. This is the result of [[#rest:base-uri|rest:base-uri]] appended with the path from the path annotation of the resource function.
|}
==rest:wadl==
 
{| width='100%'
|-
|-
| '''Summary'''
|This (unofficial) function returns Returns a [httphttps://www.w3.org/Submission/wadl WADL description] of all available REST services.|} ==rest:init== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|rest:init||empty-sequence()}}<br/>{{Func|rest:init|$update as xs:boolean|empty-sequence()}}|-| '''Summary'''|Initializes the RESTXQ module cache:* By default, the cache will be discarded, and all modules will be parsed and cached again.* If {{Code|$update}} is enabled, the background caching behavior is simulated (see {{Option|PARSERESTXQ}}): Only updated modules will be parsed.* This function should be called if new RESTXQ code is deployed at runtime.
|}
=Changelog=
 
; Version 9.4
* Updated: [[#rest:init|rest:init]] argument added
 
;Version 8.6
* Added: [[#rest:init|rest:init]]
This module was introduced with Version 7.7.
 
[[Category:XQuery]]
Bureaucrats, editor, reviewer, Administrators
12,234

edits

Navigation menu