src/commands/function-list.json


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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
            }
        ]
    }
}