futriix/src/commands/function-restore.json
Itamar Haber 0c3b8b7e90
Overhauls command summaries and man pages. (#11942)
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.
2023-03-29 20:48:59 +03:00

55 lines
1.5 KiB
JSON

{
"RESTORE": {
"summary": "Restores all libraries from a payload.",
"complexity": "O(N) where N is the number of functions on the payload",
"group": "scripting",
"since": "7.0.0",
"arity": -3,
"container": "FUNCTION",
"function": "functionRestoreCommand",
"command_flags": [
"NOSCRIPT",
"WRITE",
"DENYOOM"
],
"acl_categories": [
"SCRIPTING"
],
"command_tips": [
"REQUEST_POLICY:ALL_SHARDS",
"RESPONSE_POLICY:ALL_SUCCEEDED"
],
"arguments": [
{
"name": "serialized-value",
"type": "string"
},
{
"name": "policy",
"type": "oneof",
"optional": true,
"arguments": [
{
"name": "flush",
"type": "pure-token",
"token": "FLUSH"
},
{
"name": "append",
"type": "pure-token",
"token": "APPEND"
},
{
"name": "replace",
"type": "pure-token",
"token": "REPLACE"
}
]
}
],
"reply_schema": {
"const": "OK"
}
}
}