Add docs for child recursive endpoint (#2743)

ordinals · Nov 24, 2023 · 03bcba8 · 03bcba8
1 parent c3c090b
commit 03bcba8
Showing 1 changed file with 22 additions and 7 deletions.
diff --git a/docs/src/inscriptions/recursion.md b/docs/src/inscriptions/recursion.md
@@ -22,17 +22,16 @@ This has a number of interesting use-cases:
 
 The recursive endpoints are:
 
-- `/r/blockheight`: latest block height.
-- `/r/blockhash`: latest block hash.
 - `/r/blockhash/<HEIGHT>`: block hash at given block height.
+- `/r/blockhash`: latest block hash.
+- `/r/blockheight`: latest block height.
 - `/r/blocktime`: UNIX time stamp of latest block.
-- `/r/metadata/<INSCRIPTION_ID>`: JSON string containing the
-  hex-encoded CBOR metadata.
+- `/r/children/<INSCRIPTION_ID>`: the first 100 child inscription ids.
+- `/r/children/<INSCRIPTION_ID>/<PAGE>`: the set of 100 child inscription ids on `<PAGE>`.
+- `/r/metadata/<INSCRIPTION_ID>`: JSON string containing the hex-encoded CBOR metadata.
 - `/r/sat/<SAT_NUMBER>`: the first 100 inscription ids on a sat.
 - `/r/sat/<SAT_NUMBER>/<PAGE>`: the set of 100 inscription ids on `<PAGE>`.
-- `/r/sat/<SAT_NUMBER>/at/<INDEX>`: the inscription id at `<INDEX>` of all
-  inscriptions on a sat. `<INDEX>` may be a negative number to index from the
-  back. `0` being the first and `-1` being the most recent for example.
+- `/r/sat/<SAT_NUMBER>/at/<INDEX>`: the inscription id at `<INDEX>` of all inscriptions on a sat. `<INDEX>` may be a negative number to index from the back. `0` being the first and `-1` being the most recent for example.
 
 Note: `<SAT_NUMBER>` only allows the actual number of a sat no other sat
 notations like degree, percentile or decimal. We may expand to allow those in
@@ -93,3 +92,19 @@ Examples
    "id":"17541f6adf6eb160d52bc6eb0a3546c7c1d2adfe607b1a3cddc72cc0619526adi0"
 }
 ```
+
+- `/r/children/60bcf821240064a9c55225c4f01711b0ebbcab39aa3fafeefe4299ab158536fai0/49`:
+
+```json
+{
+   "ids":[
+      "7cd66b8e3a63dcd2fada917119830286bca0637267709d6df1ca78d98a1b4487i4900",
+      "7cd66b8e3a63dcd2fada917119830286bca0637267709d6df1ca78d98a1b4487i4901",
+      ...
+      "7cd66b8e3a63dcd2fada917119830286bca0637267709d6df1ca78d98a1b4487i4935",
+      "7cd66b8e3a63dcd2fada917119830286bca0637267709d6df1ca78d98a1b4487i4936"
+   ],
+   "more":false,
+   "page":49
+}
+```