summaryrefslogtreecommitdiffstats
path: root/src/commands/function-list.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/function-list.json')
-rw-r--r--src/commands/function-list.json87
1 files changed, 87 insertions, 0 deletions
diff --git a/src/commands/function-list.json b/src/commands/function-list.json
new file mode 100644
index 0000000..2ab1cf5
--- /dev/null
+++ b/src/commands/function-list.json
@@ -0,0 +1,87 @@
+{
+ "LIST": {
+ "summary": "Returns information about all libraries.",
+ "complexity": "O(N) where N is the number of functions",
+ "group": "scripting",
+ "since": "7.0.0",
+ "arity": -2,
+ "container": "FUNCTION",
+ "function": "functionListCommand",
+ "command_flags": [
+ "NOSCRIPT"
+ ],
+ "command_tips": [
+ "NONDETERMINISTIC_OUTPUT_ORDER"
+ ],
+ "acl_categories": [
+ "SCRIPTING"
+ ],
+ "reply_schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "library_name": {
+ "description": " the name of the library",
+ "type": "string"
+ },
+ "engine": {
+ "description": "the engine of the library",
+ "type": "string"
+ },
+ "functions": {
+ "description": "the list of functions in the library",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "the name of the function",
+ "type": "string"
+ },
+ "description": {
+ "description": "the function's description",
+ "oneOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "flags": {
+ "description": "an array of function flags",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "library_code": {
+ "description": "the library's source code (when given the WITHCODE modifier)",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "arguments": [
+ {
+ "name": "library-name-pattern",
+ "type": "string",
+ "token": "LIBRARYNAME",
+ "optional": true
+ },
+ {
+ "name": "withcode",
+ "type": "pure-token",
+ "token": "WITHCODE",
+ "optional": true
+ }
+ ]
+ }
+}