Add front matter to commands .md files + missing examples

oshadmi · oshadmi · commit 9430e4943fab · 2022-03-06T21:42:20.000+02:00
diff --git a/docs/commands/json.arrappend.md b/docs/commands/json.arrappend.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.ARRAPPEND command"
+linkTitle: "JSON.ARRAPPEND"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Append the `json` values into the array at `path` after the last element in it.
 
 @return
diff --git a/docs/commands/json.arrindex.md b/docs/commands/json.arrindex.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.ARRINDEX command"
+linkTitle: "JSON.ARRINDEX"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Searches for the first occurrence of a scalar JSON value in an array.
 
 The optional inclusive `start` (default 0) and exclusive `stop` (default 0, meaning that the last element is included) specify a slice of the array to search.
diff --git a/docs/commands/json.arrinsert.md b/docs/commands/json.arrinsert.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.ARRINSERT command"
+linkTitle: "JSON.ARRINSERT"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Inserts the `json` values into the array at `path` before the `index` (shifts to the right).
 
 The index must be in the array's range. Inserting at `index` 0 prepends to the array. Negative index values start from the end of the array.
diff --git a/docs/commands/json.arrlen.md b/docs/commands/json.arrlen.md
@@ -1,3 +1,13 @@
+
+---
+title: "JSON.ARRLEN command"
+linkTitle: "JSON.ARRLEN"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Reports the length of the JSON Array at `path` in `key`.
 
 `path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.
diff --git a/docs/commands/json.arrpop.md b/docs/commands/json.arrpop.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.ARRPOP command"
+linkTitle: "JSON.ARRPOP"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Removes and returns an element from the index in the array.
 
 `path` defaults to root if not provided. `index` is the position in the array to start popping from (defaults to -1, meaning the last element). Out-of-range indexes round to their respective array ends. Popping an empty array returns null.
diff --git a/docs/commands/json.arrtrim.md b/docs/commands/json.arrtrim.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.ARRTRIM command"
+linkTitle: "JSON.ARRTRIM"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Trims an array so that it contains only the specified inclusive range of elements.
 
 This command is extremely forgiving and using it with out-of-range indexes will not produce an error. There are a few differences between how RedisJSON v2.0 and legacy versions handle out-of-range indexes.
diff --git a/docs/commands/json.clear.md b/docs/commands/json.clear.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.CLEAR command"
+linkTitle: "JSON.CLEAR"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Clears container values (Arrays/Objects), sets numeric values to `0`, sets string value to emptys, and sets boolean values to `false`.
 
 Already cleared values are ignored: empty containers, zero numbers, empty strings, `false`, and `null`.
@@ -7,3 +16,14 @@ Already cleared values are ignored: empty containers, zero numbers, empty string
 @return
 
 @integer-reply: specifically the number of values cleared.
+
+@examples
+
+```
+redis> JSON.SET doc $ '{"obj":{"a":1, "b":2}, "arr":[1,2,3], "str": "foo", "bool": true, "int": 42, "float": 3.14}'
+OK
+redis> JSON.CLEAR doc $.*
+(integer) 6
+redis> JSON.GET doc $
+"[{\"obj\":{},\"arr\":[],\"str\":\"\",\"bool\":false,\"int\":0,\"float\":0}]"
+```
diff --git a/docs/commands/json.debug-help.md b/docs/commands/json.debug-help.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.DEBUG HELP subcommand"
+linkTitle: "JSON.DEBUG HELP"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Returns helpful information about the `JSON.DEBUG` command.
 
 @return
diff --git a/docs/commands/json.debug-memory.md b/docs/commands/json.debug-memory.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.DEBUG MEMORY subcommand"
+linkTitle: "JSON.DEBUG MEMORY"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Report a value's memory usage in bytes. `path` defaults to root if not provided.
 
 @return
diff --git a/docs/commands/json.del.md b/docs/commands/json.del.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.DEL command"
+linkTitle: "JSON.DEL"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Deletes a value.
 
 `path` defaults to root if not provided. Ignores nonexistent keys and paths. Deleting an object's root is equivalent to deleting the key from Redis.
diff --git a/docs/commands/json.get.md b/docs/commands/json.get.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.GET command"
+linkTitle: "JSON.GET"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Returns the value at `path` in JSON serialized form.
 
 This command accepts multiple `path` arguments. If no path is given, it defaults to the value's root.
diff --git a/docs/commands/json.mget.md b/docs/commands/json.mget.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.MGET command"
+linkTitle: "JSON.MGET"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Returns the values at `path` from multiple `key` arguments. Returns null for nonexistent keys and nonexistent paths.
 
 @return
diff --git a/docs/commands/json.numincrby.md b/docs/commands/json.numincrby.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.NUMINCRBY command"
+linkTitle: "JSON.NUMINCRBY"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Increments the number value stored at `path` by `number`.
 
 @return
diff --git a/docs/commands/json.nummultby.md b/docs/commands/json.nummultby.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.NUMMULTBY command"
+linkTitle: "JSON.NUMMULTBY"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Multiplies the number value stored at `path` by `number`.
 
 @return
diff --git a/docs/commands/json.objkeys.md b/docs/commands/json.objkeys.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.OBJKEYS command"
+linkTitle: "JSON.OBJKEYS"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Returns the keys in the object that's referenced by `path`.
 
 `path` defaults to root if not provided. Returns null if the object is empty or either `key` or `path` do not exist.
diff --git a/docs/commands/json.objlen.md b/docs/commands/json.objlen.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.OBJLEN command"
+linkTitle: "JSON.OBJLEN"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Reports the number of keys in the JSON Object at `path` in `key`.
 
 `path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.
diff --git a/docs/commands/json.resp.md b/docs/commands/json.resp.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.RESP command"
+linkTitle: "JSON.RESP"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 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:
diff --git a/docs/commands/json.set.md b/docs/commands/json.set.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.SET command"
+linkTitle: "JSON.SET"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Sets the JSON value at `path` in `key`.
 
 For new Redis keys the `path` must be the root. For existing keys, when the entire `path` exists, the value that it contains is replaced with the `json` value. For existing keys, when the `path` exists, except for the last element, a new child is added with the `json` value. 
diff --git a/docs/commands/json.strappend.md b/docs/commands/json.strappend.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.STRAPPEND command"
+linkTitle: "JSON.STRAPPEND"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Appends the `json-string` values to the string at `path`.
 
 `path` defaults to root if not provided.
diff --git a/docs/commands/json.strlen.md b/docs/commands/json.strlen.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.STRLEN command"
+linkTitle: "JSON.STRLEN"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Reports the length of the JSON String at `path` in `key`.
 
 `path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.
diff --git a/docs/commands/json.toggle.md b/docs/commands/json.toggle.md
@@ -1,5 +1,29 @@
+---
+title: "JSON.TOGGLE command"
+linkTitle: "JSON.TOGGLE"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Toggle a boolean value stored at `path`.
 
 return
 
 @integer-reply: specifically the new value (0-false or 1-true), or @null-reply element for JSON values matching the path which are not boolean.
+
+@examples
+
+```
+redis> JSON.SET doc $ '{"bool": true}'
+OK
+redis> JSON.TOGGLE doc $.bool
+1) (integer) 0
+redis> JSON.GET doc $
+"[{\"bool\":false}]"
+redis> JSON.TOGGLE doc $.bool
+1) (integer) 1
+redis> JSON.GET doc $
+"[{\"bool\":true}]"
+```
diff --git a/docs/commands/json.type.md b/docs/commands/json.type.md
@@ -1,3 +1,12 @@
+---
+title: "JSON.TYPE command"
+linkTitle: "JSON.TYPE"
+type: docs
+weight: 1
+description: >
+    "detailed description"
+---
+
 Reports the type of JSON value at `path`.
 
 `path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.
