mirror of https://gitee.com/bigwinds/arangodb
58 lines
3.0 KiB
Plaintext
58 lines
3.0 KiB
Plaintext
{
|
|
"basePath": "/",
|
|
"swaggerVersion": "1.1",
|
|
"apiVersion": "0.1",
|
|
"apis": [
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [],
|
|
"parameters": [],
|
|
"notes": "",
|
|
"summary": "returns registered AQL user functions",
|
|
"httpMethod": "GET",
|
|
"examples": "",
|
|
"nickname": "returnsRegisteredAqlUserFunctions"
|
|
}
|
|
],
|
|
"path": "/_api/aqlfunction"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [],
|
|
"parameters": [],
|
|
"notes": "",
|
|
"summary": "creates or replaces an AQL user function",
|
|
"httpMethod": "POST",
|
|
"examples": "",
|
|
"nickname": "createsOrReplacesAnAqlUserFunction"
|
|
}
|
|
],
|
|
"path": "/_api/aqlfunction"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": "false",
|
|
"name": "group",
|
|
"description": "If set to <em>true</em>, then the function name provided in <em>name</em> is treated as a namespace prefix, and all functions in the specified namespace will be deleted. "
|
|
}
|
|
],
|
|
"notes": "<br><br>Removes an existing AQL user function, identified by <em>name</em>. <br><br>If the function can be removed by the server, the server will respond with <em>HTTP 200</em>. <br><br>In case of success, the returned JSON object has the following properties: <br><br>- <em>error</em>: boolean flag to indicate that an error occurred (<em>false</em><br> in this case) <br><br>- <em>code</em>: the HTTP status code<br><br>If the JSON representation is malformed or mandatory data is missing from the request, the server will respond with <em>HTTP 400</em>. If the specified user does not exist, the server will respond with <em>HTTP 404</em>. <br><br>The body of the response will contain a JSON object with additional error details. The object has the following attributes: <br><br>- <em>error</em>: boolean flag to indicate that an error occurred (<em>true</em> in this case)<br><br>- <em>code</em>: the HTTP status code<br><br>- <em>errorNum</em>: the server error number<br><br>- <em>errorMessage</em>: a descriptive error message<br>//////////////////////////////////////////////////////////////////////////// ",
|
|
"summary": "remove an existing AQL user function",
|
|
"httpMethod": "DELETE",
|
|
"examples": "",
|
|
"nickname": "removeAnExistingAqlUserFunction"
|
|
}
|
|
],
|
|
"path": "/_api/aqlfunction"
|
|
}
|
|
]
|
|
}
|