From 73b90fcd250fc19568ad29e16a5f86f024756c6f Mon Sep 17 00:00:00 2001
From: hunicus <93150691+hunicus@users.noreply.github.com>
Date: Fri, 24 Feb 2023 09:44:15 -0500
Subject: [PATCH] Add skeleton for blocks-bulk endpoint
---
.../src/app/docs/api-docs/api-docs-data.ts | 48 +++++++++++++++++++
1 file changed, 48 insertions(+)
diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index a6e8e418f..2c3bbc06b 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -2907,6 +2907,54 @@ export const restApiDocsData = [
}
},
...
+]`
+ },
+ codeSampleLiquid: emptyCodeSample,
+ codeSampleLiquidTestnet: emptyCodeSample,
+ codeSampleBisq: emptyCodeSample,
+ }
+ }
+ },
+ {
+ type: "endpoint",
+ category: "blocks",
+ httpRequestMethod: "GET",
+ fragment: "get-blocks-bulk",
+ title: "GET Blocks (Bulk)",
+ description: {
+ default: "Returns details on the range of blocks between :minHeight
and :maxHeight
, inclusive, up to 100 blocks. If :maxHeight
is not specified, :maxHeight
defaults to the current tip."
+ },
+ urlString: "/v1/blocks-bulk/:minHeight[/:maxHeight]",
+ showConditions: bitcoinNetworks,
+ showJsExamples: showJsExamplesDefaultFalse,
+ codeExample: {
+ default: {
+ codeTemplate: {
+ curl: `/api/v1/blocks-bulk/%{1}/%{2}`,
+ commonJS: ``,
+ },
+ codeSampleMainnet: {
+ esModule: [],
+ commonJS: [],
+ curl: [730000, 730100],
+ response: `[
+
+]`,
+ },
+ codeSampleTestnet: {
+ esModule: ['2091187'],
+ commonJS: ['2091187'],
+ curl: ['2091187'],
+ response: `[
+
+]`
+ },
+ codeSampleSignet: {
+ esModule: ['53783'],
+ commonJS: ['53783'],
+ curl: ['53783'],
+ response: `[
+
]`
},
codeSampleLiquid: emptyCodeSample,