WIP content/editorial changes (.json and .md)

oshadmi · oshadmi · commit 3080ba13d492 · 2022-03-06T13:49:59.000+02:00
diff --git a/commands.json b/commands.json
@@ -104,10 +104,16 @@
       },
       {
         "name": "condition",
-        "type": "enum",
-        "enum": [
-          "NX",
-          "XX"
+        "type": "oneof",
+        "arguments": [
+          {
+            "name": "NX",
+            "type": "pure-token"
+          },
+          {
+            "name": "XX",
+            "type": "pure-token"
+          }
         ],
         "optional": true
       }
@@ -152,6 +158,26 @@
     "since": "1.0.0",
     "group": "json"
   },
+  "JSON.NUMMULTBY": {
+    "summary": "Multiplies the numeric value at path by a value",
+    "complexity": "O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key",
+    "arguments": [
+      {
+        "name": "key",
+        "type": "key"
+      },
+      {
+        "name": "path",
+        "type": "string"
+      },
+      {
+        "name": "value",
+        "type": "double"
+      }
+    ],
+    "since": "1.0.0",
+    "group": "json"
+  },
   "JSON.STRAPPEND": {
     "summary": "Appends a string to a JSON string value at path",
     "complexity": "O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key",
@@ -191,7 +217,7 @@
     "group": "json"
   },
   "JSON.ARRAPPEND": {
-    "summary": "Appends JSON value(s) to the JSON array at path",
+    "summary": "Append one or more json values into the array at path after the last element in it.",
     "complexity": "O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key",
     "arguments": [
       {
@@ -231,7 +257,7 @@
       {
         "type": "block",
         "optional": true,
-        "block": [
+        "arguments": [
           {
             "name": "start",
             "type": "integer"
@@ -283,7 +309,7 @@
       {
         "name": "path",
         "type": "string",
-        "multiple": true
+        "optioanl": true
       }
     ],
     "since": "1.0.0",
@@ -300,7 +326,7 @@
       {
         "type": "block",
         "optional": true,
-        "block": [
+        "arguments": [
           {
             "name": "path",
             "type": "string"
@@ -407,5 +433,36 @@
     ],
     "since": "1.0.0",
     "group": "json"
+  },
+  "JSON.DEBUG": {
+    "summary": "Reports information",
+    "complexity": "O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key",
+    "arguments": [
+      {
+        "name": "subcommand",
+        "type": "oneof",
+        "arguments": [
+              "MEMORY",
+              "HELP"
+          ]        
+      },
+      {
+        "type": "block",
+        "optional": true,
+        "arguments": [
+          {
+            "name": "key",
+            "type": "key"
+          },
+          {
+            "name": "path",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      }
+    ],
+    "since": "1.0.0",
+    "group": "json"
   }
 }
diff --git a/docs/commands/json.arrappend.md b/docs/commands/json.arrappend.md
@@ -4,7 +4,7 @@ Append the `json` values into the array at `path` after the last element in it.
 
 @array-reply of @integer-reply - for each path, the array's new size, or @null-reply if the matching JSON value is not an array.
 
-#### Example
+@examples
 
 ```
 redis> JSON.SET doc $ '{"a":[1], "nested": {"a": [1,2]}, "nested2": {"a": 42}}'
diff --git a/docs/commands/json.debug-help.md b/docs/commands/json.debug-help.md
@@ -2,4 +2,4 @@ Returns helpful information about the `JSON.DEBUG` command.
 
 @return
 
-@array-reply
+@array-reply with helpful messages
diff --git a/docs/commands/json.numincrby.md b/docs/commands/json.numincrby.md
@@ -2,7 +2,7 @@ Increments the number value stored at `path` by `number`.
 
 @return
 
-@bulk-string-reply: the stringified new value for each path, or [null][6] if the matching JSON value is not a number.
+@bulk-string-reply: the stringified new value for each path, or @null-reply if the matching JSON value is not a number.
 
 @examples
 
diff --git a/docs/commands/json.nummultby.md b/docs/commands/json.nummultby.md
@@ -4,7 +4,7 @@ Multiplies the number value stored at `path` by `number`.
 
 @bulk-string-reply - the stringified new values for each path, or @null-reply element if the matching JSON value is not a number.
 
-#### Example
+@examples
 
 ```
 redis> JSON.SET doc . '{"a":"b","b":[{"a":2}, {"a":5}, {"a":"c"}]}'
diff --git a/docs/commands/json.objlen.md b/docs/commands/json.objlen.md
@@ -4,4 +4,15 @@ Reports the number of keys in the JSON Object at `path` in `key`.
 
 @return
 
-@integer-reply - the number of keys in the object.
+@array-reply of @integer-reply - for each path, the number of keys in the object, or @null-reply if the matching JSON value is not an object.
+
+@examples
+
+```
+redis> JSON.SET doc $ '{"a":[3], "nested": {"a": {"b":2, "c": 1}}}'
+OK
+redis> JSON.OBJLEN doc $..a
+1) (nil)
+2) (integer) 2
+```
+
diff --git a/docs/commands/json.resp.md b/docs/commands/json.resp.md
@@ -2,13 +2,13 @@ Returns the JSON in `key` in [Redis Serialization Protocol (RESP)][5] form.
 
 `path` defaults to root if not provided. This command uses the following mapping from JSON to RESP:
 
-*   JSON Null maps to the [RESP Null Bulk String][5]
-*   JSON `false` and `true` values map to [RESP Simple Strings][1]
-*   JSON Numbers map to [RESP Integers][2] or [RESP Bulk Strings][3], depending on type
-*   JSON Strings map to [RESP Bulk Strings][3]
-*   JSON Arrays are represented as [RESP Arrays][4] in which the first element is the [simple string][1] `[` followed by the array's elements
-*   JSON Objects are represented as [RESP Arrays][4] in which the first element is the [simple string][1] `{`. Each successive entry represents a key-value pair as a two-entry [array][4] of [bulk strings][3].
+*   JSON Null maps to the @bulk-string-reply
+*   JSON `false` and `true` values map to @simple-string-reply
+*   JSON Numbers map to @integer-reply or @bulk-string-reply, depending on type
+*   JSON Strings map to @bulk-string-reply
+*   JSON Arrays are represented as @array-reply in which the first element is the @simple-string-reply `[` followed by the array's elements
+*   JSON Objects are represented as @array-reply in which the first element is the @simple-string-reply `{`. Each successive entry represents a key-value pair as a two-entry @array-reply of @bulk-string-reply.
 
 @return
 
-[Array][4] - the JSON's RESP form as detailed.
+@array-reply - the JSON's RESP form as detailed.
diff --git a/docs/commands/json.type.md b/docs/commands/json.type.md
@@ -6,7 +6,7 @@ Reports the type of JSON value at `path`.
 
 @array-reply of @string-reply - for each path, the value's type.
 
-#### Examples
+@examples
 
 ```
 redis> JSON.SET doc $ '{"a":2, "nested": {"a": true}, "foo": "bar"}'

Original file line number	Diff line number	Diff line change
@@ -2,4 +2,4 @@ Returns helpful information about the `JSON.DEBUG` command.
`2`	`2`
`3`	`3`	`@return`
`4`	`4`
`5`		`-@array-reply`
	`5`	`+@array-reply with helpful messages`