0c3b8b7e90
This is an attempt to normalize/formalize command summaries. Main actions performed: * Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands. * Starts with "An internal command...", "A container command...", etc... when applicable. * Always uses periods. * Refrains from referring to other commands. If this is needed, backquotes should be used for command names. * Tries to be very clear about the data type when applicable. * Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed." * Prefers being terse over verbose. * Tries to be consistent.
69 lines
1.8 KiB
JSON
69 lines
1.8 KiB
JSON
{
|
|
"FCALL_RO": {
|
|
"summary": "Invokes a read-only function.",
|
|
"complexity": "Depends on the function that is executed.",
|
|
"group": "scripting",
|
|
"since": "7.0.0",
|
|
"arity": -3,
|
|
"function": "fcallroCommand",
|
|
"get_keys_function": "functionGetKeys",
|
|
"command_flags": [
|
|
"NOSCRIPT",
|
|
"SKIP_MONITOR",
|
|
"NO_MANDATORY_KEYS",
|
|
"STALE",
|
|
"READONLY"
|
|
],
|
|
"acl_categories": [
|
|
"SCRIPTING"
|
|
],
|
|
"key_specs": [
|
|
{
|
|
"notes": "We cannot tell how the keys will be used so we assume the worst, RO and ACCESS",
|
|
"flags": [
|
|
"RO",
|
|
"ACCESS"
|
|
],
|
|
"begin_search": {
|
|
"index": {
|
|
"pos": 2
|
|
}
|
|
},
|
|
"find_keys": {
|
|
"keynum": {
|
|
"keynumidx": 0,
|
|
"firstkey": 1,
|
|
"step": 1
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"arguments": [
|
|
{
|
|
"name": "function",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "numkeys",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "key",
|
|
"type": "key",
|
|
"key_spec_index": 0,
|
|
"optional": true,
|
|
"multiple": true
|
|
},
|
|
{
|
|
"name": "arg",
|
|
"type": "string",
|
|
"optional": true,
|
|
"multiple": true
|
|
}
|
|
],
|
|
"reply_schema": {
|
|
"description": "Return value depends on the function that is executed"
|
|
}
|
|
}
|
|
}
|