{
"basePath": "/",
"swaggerVersion": "1.1",
"apiVersion": "0.1",
"apis": [
{
"operations": [
{
"errorResponses": [
{
"reason": "if success HTTP 200 is returned. ",
"code": "200"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "query",
"name": "namespace",
"description": "Returns all registered AQL user functions from namespace namespace. "
}
],
"notes": "Returns all registered AQL user functions.
The call will return a JSON list with all user functions found. Each user function will at least have the following attributes:
- name: The fully qualified name of the user function
- code: A string representation of the function body
",
"summary": "returns registered AQL user functions",
"httpMethod": "GET",
"examples": "
unix> curl --dump - http://localhost:8529/_api/aqlfunction\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n { \n \"name\" : \"myfunctions:temperature:celsiustofahrenheit\", \n \"code\" : \"function (celsius) { return celsius * 1.8 + 32; }\" \n } \n]\n\n
",
"nickname": "returnsRegisteredAqlUserFunctions"
}
],
"path": "/_api/aqlfunction"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the function already existed and was replaced by the call, the server will respond with HTTP 200. ",
"code": "200"
},
{
"reason": "If the function can be registered by the server, the server will respond with HTTP 201. ",
"code": "201"
},
{
"reason": "If the JSON representation is malformed or mandatory data is missing from the request, the server will respond with HTTP 400. ",
"code": "400"
}
],
"parameters": [
{
"dataType": "Json",
"paramType": "body",
"required": "true",
"name": "body",
"description": "the body with name and code of the aql user function. "
}
],
"notes": "
The following data need to be passed in a JSON representation in the body of the POST request:
- name: the fully qualified name of the user functions.
- code: a string representation of the function body.
- isDeterministic: an optional boolean value to indicate that the function results are fully deterministic (function return value solely depends on the input value and return value is the same for repeated calls with same input). The isDeterministic attribute is currently not used but may be used later for optimisations.
In case of success, the returned JSON object has the following properties:
- error: boolean flag to indicate that an error occurred (false in this case)
- code: the HTTP status code
The body of the response will contain a JSON object with additional error details. The object has the following attributes:
- error: boolean flag to indicate that an error occurred (true in this case)
- code: the HTTP status code
- errorNum: the server error number
- errorMessage: a descriptive error message
",
"summary": "creates or replaces an AQL user function",
"httpMethod": "POST",
"examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/aqlfunction\n{ \"name\" : \"myfunctions:temperature:celsiustofahrenheit\", \"code\" : \"function (celsius) { return celsius * 1.8 + 32; }\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsOrReplacesAnAqlUserFunction"
}
],
"path": "/_api/aqlfunction"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the function can be removed by the server, the server will respond with HTTP 200. ",
"code": "200"
},
{
"reason": "If the user function name is malformed, the server will respond with HTTP 400. ",
"code": "400"
},
{
"reason": "If the specified user user function does not exist, the server will respond with HTTP 404. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "name",
"description": "the name of the AQL user function. "
},
{
"dataType": "String",
"paramType": "query",
"name": "group",
"description": "If set to true, then the function name provided in name is treated as a namespace prefix, and all functions in the specified namespace will be deleted. If set to false, the function name provided in name must be fully qualified, including any namespaces. "
}
],
"notes": "
Removes an existing AQL user function, identified by name.
In case of success, the returned JSON object has the following properties:
- error: boolean flag to indicate that an error occurred (false in this case)
- code: the HTTP status code
The body of the response will contain a JSON object with additional error details. The object has the following attributes:
- error: boolean flag to indicate that an error occurred (true in this case)
- code: the HTTP status code
- errorNum: the server error number
- errorMessage: a descriptive error message
",
"summary": "remove an existing AQL user function",
"httpMethod": "DELETE",
"examples": "deletes a function:
unix> curl -X DELETE --dump - http://localhost:8529/_api/aqlfunction/square:x:y\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : false, \n \"code\" : 200 \n}\n\n
function not found:
unix> curl -X DELETE --dump - http://localhost:8529/_api/aqlfunction/myfunction:x:y\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 404, \n \"errorNum\" : 1582, \n \"errorMessage\" : \"user function '%s()' not found\" \n}\n\n
",
"nickname": "removeAnExistingAqlUserFunction"
}
],
"path": "/_api/aqlfunction/{name}"
}
]
}