Add more docs to api return types

dcSpark · Dec 1, 2023 · 147597b · 147597b
1 parent 012ce13
commit 147597b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/webserver/shared/models/BlockLatest.ts b/webserver/shared/models/BlockLatest.ts
@@ -15,7 +15,7 @@ export type BlockSubset = {
    */
   era: number;
   /**
-   * [0-9a-fA-F]{64}
+   * @pattern [0-9a-fA-F]{64}
    * @example "cf8c63a909d91776e27f7d05457e823a9dba606a7ab499ac435e7904ee70d7c8"
    */
   hash: string;

diff --git a/webserver/shared/models/ProjectedNftRange.ts b/webserver/shared/models/ProjectedNftRange.ts
@@ -1,5 +1,21 @@
 export type ProjectedNftRangeRequest = {
-    range: { minSlot: number, maxSlot: number }
+    /**
+     * Projected NFT events in this slot range will be returned
+     */
+    range: {
+        /**
+         * Minimal slot from which the events should be returned (not inclusive)
+         *
+         * @example 46154769
+         */
+        minSlot: number,
+        /**
+         * Maximal slot from which the events should be returned (inclusive)
+         *
+         * @example 46154860
+         */
+        maxSlot: number
+    }
 };
 
 export type ProjectedNftRangeResponse = {