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

35 lines
3.1 KiB
JSON

{
"basePath": "/",
"swaggerVersion": "1.1",
"apiVersion": "0.1",
"apis": [
{
"operations": [
{
"errorResponses": [
{
"reason": "is returned in all cases. <br><br>",
"code": "200"
}
],
"parameters": [
{
"dataType": "Boolean",
"paramType": "query",
"required": "false",
"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. <br><br>"
}
],
"notes": "Returns the server name and version number. The response is a JSON object with the following attributes: <br><br> <ul class=\"swagger-list\"><li><em>server</em>: will always contain <em>arango</em> <li><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. <li><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.",
"summary": " Return server version",
"httpMethod": "GET",
"examples": "<br><br> Returns the version information. <br><br><br><br><pre><code class=\"json\">shell> curl --data-binary @- --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\" : \"2.2.2-rc1\" \n}\n</code></pre><br><br><br> Returns the version information with details. <br><br><br><br><pre><code class=\"json\">shell> curl --data-binary @- --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\" : \"2.2.2-rc1\", \n \"details\" : { \n \"build-date\" : \"Aug 6 2014 16:32:54\", \n \"configure\" : \"'./configure' '--enable-all-in-one-icu' '--enable-relative' '--enable-maintainer-mode'\", \n \"icu-version\" : \"52.1\", \n \"libev-version\" : \"4.11\", \n \"openssl-version\" : \"OpenSSL 0.9.8y 5 Feb 2013\", \n \"repository-version\" : \"tags/v2.2.2-rc1-0-gb8df91e175fba53212b464304531234b7559636b\", \n \"server-version\" : \"2.2.2-rc1\", \n \"sizeof int\" : \"4\", \n \"sizeof void*\" : \"8\", \n \"v8-version\" : \"3.16.14\" \n } \n}\n</code></pre><br>@endDocuBlock",
"nickname": "ReturnServerVersion"
}
],
"path": "/_api/version"
}
]
}