RESTXQ Module - Revision history

CG at 15:14, 9 March 2023

2023-03-09T15:14:24Z

2023-03-09T13:01:37Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T11:01:21Z

2022-07-20T12:20:41Z

2022-07-18T17:50:12Z

Text replacement - "\[\[#([^]:]+:[^|]+)\|([^]:]+:[^|]+)\]\]" to "{{Function||$1}}"

2020-11-18T16:50:21Z

rest:init

2020-07-02T10:39:26Z

rest:wadl

2020-06-15T15:53:32Z

rest:init

2020-06-15T15:53:15Z

2019-11-29T04:54:16Z

Conventions

@@ Line 49: / Line 49: @@
 | width='120' | '''Signature'''
 |<pre>rest:init(
-   $update  as xs:boolean  := ()
+   $update  as xs:boolean?  := false()
 ) as empty-sequence()</pre>
 |- valign="top"

@@ Line 14: / Line 14: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>rest:base-uri() as xs:anyURI</pre>
 |- valign="top"
@@ Line 25: / Line 25: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>rest:uri() as xs:anyURI</pre>
 |- valign="top"
@@ Line 36: / Line 36: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>rest:wadl() as element(wadl:application)</pre>
 |- valign="top"
@@ Line 47: / Line 47: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>rest:init(
    $update  as xs:boolean  := ()

@@ Line 15: / Line 15: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|rest:base-uri||xs:anyURI}}
+|<pre>rest:base-uri() as xs:anyURI</pre>
 |- valign="top"
 | '''Summary'''
@@ Line 26: / Line 26: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|rest:uri||xs:anyURI}}
+|<pre>rest:uri() as xs:anyURI</pre>
 |- valign="top"
 | '''Summary'''
@@ Line 37: / Line 37: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|rest:wadl||element(wadl:application)}}
+|<pre>rest:wadl() as element(wadl:application)</pre>
 |- valign="top"
 | '''Summary'''
@@ Line 48: / Line 48: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|rest:init||empty-sequence()}}<br/>{{Func|rest:init|$update as xs:boolean|empty-sequence()}}
+|<pre>rest:init(
 |- valign="top"
 | '''Summary'''

@@ Line 13: / Line 13: @@
 {| width='100%'
-|-
+|- valign="top"
 | width='120' | '''Signatures'''
 |{{Func|rest:base-uri||xs:anyURI}}
-|-
+|- valign="top"
 | '''Summary'''
 |Returns the implementation-defined base URI of the resource function.
@@ Line 24: / Line 24: @@
 {| width='100%'
-|-
+|- valign="top"
 | width='120' | '''Signatures'''
 |{{Func|rest:uri||xs:anyURI}}
-|-
+|- valign="top"
 | '''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.
@@ Line 35: / Line 35: @@
 {| width='100%'
-|-
+|- valign="top"
 | width='120' | '''Signatures'''
 |{{Func|rest:wadl||element(wadl:application)}}
-|-
+|- valign="top"
 | '''Summary'''
 |Returns a [https://www.w3.org/Submission/wadl WADL description] of all available REST services.
@@ Line 46: / Line 46: @@
 {| width='100%'
-|-
+|- valign="top"
 | width='120' | '''Signatures'''
 |{{Func|rest:init||empty-sequence()}}<br/>{{Func|rest:init|$update as xs:boolean|empty-sequence()}}
-|-
+|- valign="top"
 | '''Summary'''
 |Initializes the RESTXQ module cache:

@@ Line 29: / Line 29: @@
 |-
 | '''Summary'''
-|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.
+|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 60: / Line 60: @@
 ; Version 9.4
-* Updated: [[#rest:init|rest:init]] argument added
+* Updated: {{Function||rest:init}} argument added
 ;Version 8.6
-* Added: [[#rest:init|rest:init]]
+* Added: {{Function||rest:init}}
 This module was introduced with Version 7.7.

← Older revision		Revision as of 16:50, 18 November 2020
Line 44:		Line 44:

	==rest:init==		==rest:init==
−
−	~~{{Mark\|Updated with Version 9.4:}} Argument added.~~

	{\| width='100%'		{\| width='100%'

@@ Line 4: / Line 4: @@
 * The module will be available if the {{Code|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 <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace, which is statically bound to the {{Code|rest}} prefix. Prior to {{Version|9.2}}, the module needed to be imported in the query prolog:
+* All functions are assigned to the <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace, which is statically bound to the {{Code|rest}} prefix.
 * 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, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised.