Ian Maxon has uploaded a new change for review.
https://asterix-gerrit.ics.uci.edu/331
Change subject: Doc updates to HTTP API
......................................................................
Doc updates to HTTP API
-Rename "REST" API to HTTP API
-Minor documentation for /aql endpoint
Change-Id: I5c6520495752da312f4db7641fcfd14f7d63c829
---
M asterix-doc/src/site/markdown/api.md
M asterix-doc/src/site/site.xml
2 files changed, 32 insertions(+), 2 deletions(-)
git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb
refs/changes/31/331/1
diff --git a/asterix-doc/src/site/markdown/api.md
b/asterix-doc/src/site/markdown/api.md
index 4d6edd2..4f7aca2 100644
--- a/asterix-doc/src/site/markdown/api.md
+++ b/asterix-doc/src/site/markdown/api.md
@@ -1,10 +1,11 @@
-# REST API to AsterixDB #
+# HTTP API to AsterixDB #
## <a id="toc">Table of Contents</a>
* [DDL API](#DdlApi)
* [Update API](#UpdateApi)
* [Query API](#QueryApi)
+* [Mixed API](#AnyApi)
* [Asynchronous Result API](#AsynchronousResultApi)
* [Query Status API](#QueryStatusApi)
* [Error Codes](#ErrorCodes)
@@ -179,6 +180,35 @@
}
+## <a id="AnyApi">Mixed API</a> <font size="4"><a href="#toc">[Back to
TOC]</a></font> ##
+
+*End point for any/mixed statement*
+
+Endpoint: _/aql_
+
+Parameters:
+
+<table>
+<tr>
+ <td>Parameter</td>
+ <td>Description</td>
+ <td>Required?</td>
+</tr>
+<tr>
+ <td>query</td>
+ <td>Query string to pass to ASTERIX for execution</td>
+ <td>Yes</td>
+</tr>
+<tr>
+ <td>mode</td>
+ <td>Indicate if call should be synchronous or asynchronous. mode =
synchronous blocks the call until results are available; mode = asynchronous
returns immediately with a handle that can be used later to check the query’s
status and to fetch results when available</td>
+ <td>No. default mode = synchronous</td>
+</tr>
+</table>
+
+Similar to *_/update_* but allows any arbitrary AQL statement rather than only
modifications.
+
+
## <a id="AsynchronousResultApi">Asynchronous Result API</a> <font size="4"><a
href="#toc">[Back to TOC]</a></font> ##
*End point to fetch the results of an asynchronous query*
diff --git a/asterix-doc/src/site/site.xml b/asterix-doc/src/site/site.xml
index 3e81a25..aaa73fc 100644
--- a/asterix-doc/src/site/site.xml
+++ b/asterix-doc/src/site/site.xml
@@ -81,7 +81,7 @@
<item name="AQL Support of Similarity Queries"
href="aql/similarity.html"/>
<item name="Accessing External Data" href="aql/externaldata.html"/>
<item name="Filter-Based LSM Index Acceleration"
href="aql/filters.html"/>
- <item name="REST API to AsterixDB" href="api.html"/>
+ <item name="HTTP API to AsterixDB" href="api.html"/>
</menu>
<menu ref="reports"/>
--
To view, visit https://asterix-gerrit.ics.uci.edu/331
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I5c6520495752da312f4db7641fcfd14f7d63c829
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Ian Maxon <[email protected]>
