1
0
Fork 0
arangodb/js/apps/system/aardvark/api-docs/version.json

34 lines
3.0 KiB
JSON

{
"basePath": "/",
"swaggerVersion": "1.1",
"apiVersion": "0.1",
"apis": [
{
"operations": [
{
"errorResponses": [
{
"reason": "is returned in all cases. ",
"code": "200"
}
],
"parameters": [
{
"dataType": "Boolean",
"paramType": "query",
"name": "details",
"description": "If set to <em>true</em>, the response will contain a <em>details</em> attribute with additional information about included components and their versions. The attribute names and internals of the <em>details</em> object may vary depending on platform and ArangoDB version. "
}
],
"notes": "Returns the server name and version number. The response is a JSON object with the following attributes: <br><br>- <em>server</em>: will always contain <em>arango</em><br><br>- <em>version</em>: the server version string. The string has the format \"<em>major</em>.`minor<em>.`sub</em>\". <em>major</em> and <em>minor</em> will be numeric, and <em>sub</em> may contain a number or a textual version. <br><br>- <em>details</em>: an optional JSON object with additional details. This is returned only if the <em>details</em> URL parameter is set to <em>true</em> in the request. <br><br>",
"summary": "returns the server version",
"httpMethod": "GET",
"examples": "Returns the version information. <br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"server\" : \"arango\", \n \"version\" : \"1.5.devel\" \n}\n\n</code></pre><br>Returns the version information with details. <br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_api/version?details=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"server\" : \"arango\", \n \"version\" : \"1.5.devel\", \n \"details\" : { \n \"build-date\" : \"Oct 29 2013 22:45:35\", \n \"configure\" : \"'./configure' '--enable-all-in-one-v8' '--enable-all-in-one-libev' '--enable-all...\", \n \"env\" : \"CFLAGS='-g -O2 -Wextra -Wshadow -Wno-unused-parameter' CXXFLAGS='-g -O2 -Wextra ...\", \n \"icu-version\" : \"49.1.2\", \n \"libev-version\" : \"4.11\", \n \"openssl-version\" : \"OpenSSL 1.0.1 14 Mar 2012\", \n \"repository-version\" : \"heads/devel-0-g4c562a70d3e7ab04ad000e7e8932f32d6a88a794\", \n \"server-version\" : \"1.5.devel\", \n \"sizeof int\" : \"4\", \n \"v8-version\" : \"3.16.14.1\" \n } \n}\n\n</code></pre><br>",
"nickname": "returnsTheServerVersion"
}
],
"path": "/_api/version"
}
]
}