use APIInfo component

hirosystems · Jul 2, 2024 · d796b8e · d796b8e
1 parent ac6e303
commit d796b8e
Show file tree

Hide file tree

Showing 87 changed files with 266 additions and 934 deletions.
diff --git a/content/docs/ordinals/api/brc20/get-brc20-activity.mdx b/content/docs/ordinals/api/brc20/get-brc20-activity.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/brc-20/activity`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/brc-20/activity"}>
 
 Retrieves BRC-20 activity filtered by ticker, address, operation, or at a specific block height.
 
@@ -70,7 +63,7 @@ Results per page
 | :---------- | :--------------- |
 | `200`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/brc20/get-brc20-balances.mdx b/content/docs/ordinals/api/brc20/get-brc20-balances.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/brc-20/balances/{address}`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/brc-20/balances/{address}"}>
 
 Retrieves BRC-20 token balances for a Bitcoin address.
 
@@ -68,7 +61,7 @@ Bitcoin address
 | :---------- | :--------------- |
 | `200`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/brc20/get-brc20-token-details.mdx b/content/docs/ordinals/api/brc20/get-brc20-token-details.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/brc-20/tokens/{ticker}`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/brc-20/tokens/{ticker}"}>
 
 Retrieves information for a BRC-20 token, including supply and holders.
 
@@ -35,7 +28,7 @@ Retrieves information for a BRC-20 token, including supply and holders.
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx b/content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/brc-20/tokens/{ticker}/holders`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/brc-20/tokens/{ticker}/holders"}>
 
 Retrieves a list of holders and their balances for a specified BRC-20 token.
 
@@ -55,7 +48,7 @@ Results per page
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/brc20/get-brc20-tokens.mdx b/content/docs/ordinals/api/brc20/get-brc20-tokens.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/brc-20/tokens`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/brc-20/tokens"}>
 
 Retrieves information for BRC-20 tokens.
 
@@ -58,7 +51,7 @@ Results per page
 | :---------- | :--------------- |
 | `200`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/info/status.mdx b/content/docs/ordinals/api/info/status.mdx
@@ -13,22 +13,15 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/"}>
 
 Displays the status of the Ordinals API.
 
 | Status code | Description      |
 | :---------- | :--------------- |
 | `200`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/inscriptions/get-inscription-content.mdx b/content/docs/ordinals/api/inscriptions/get-inscription-content.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/inscriptions/{id}/content`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/inscriptions/{id}/content"}>
 
 Retrieves the content of a single inscription.
 
@@ -37,7 +30,7 @@ Inscription unique identifier (number or ID)
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx b/content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/inscriptions/{id}/transfers`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/inscriptions/{id}/transfers"}>
 
 Retrieves all transfers for a single inscription.
 
@@ -57,7 +50,7 @@ Inscription unique identifier (number or ID)
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/inscriptions/get-inscription.mdx b/content/docs/ordinals/api/inscriptions/get-inscription.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/inscriptions/{id}`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/inscriptions/{id}"}>
 
 Retrieves a single inscription.
 
@@ -37,7 +30,7 @@ Inscription unique identifier (number or ID)
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/inscriptions/get-inscriptions.mdx b/content/docs/ordinals/api/inscriptions/get-inscriptions.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/inscriptions`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/inscriptions"}>
 
 Retrieves a list of inscriptions with options to filter and sort results.
 
@@ -195,7 +188,7 @@ Results order
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx b/content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/inscriptions/transfers`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/inscriptions/transfers"}>
 
 Retrieves a list of inscription transfers that ocurred at a specific Bitcoin block.
 
@@ -55,7 +48,7 @@ Results per page
 | `200`       | Default response |
 | `404`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>
 

diff --git a/content/docs/ordinals/api/satoshis/get-satoshi-inscriptions.mdx b/content/docs/ordinals/api/satoshis/get-satoshi-inscriptions.mdx
@@ -5,22 +5,15 @@ toc: false
 ---
 
 import { Root, API, APIExample } from "@/components/layout"
-import { Property } from "fumadocs-ui/components/api"
+import { APIInfo, Property } from "fumadocs-ui/components/api"
 import { Tabs, Tab } from "fumadocs-ui/components/tabs"
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion"
 
 <Root>
 
 <API>
 
-<div className="flex-1">
-
-<h2 className="not-prose mb-2 inline-flex items-center gap-3 font-mono">
-  <div className="rounded-lg border px-1 py-0.5 text-xs font-medium border-green-400/50 bg-green-400/20 text-green-600 dark:text-green-400">
-    GET
-  </div>
-  <p className="text-xs break-words overflow-hidden w-[95%]">{`/ordinals/v1/sats/{ordinal}/inscriptions`}</p>
-</h2>
+<APIInfo method={"GET"} route={"/ordinals/v1/sats/{ordinal}/inscriptions"}>
 
 Retrieves all inscriptions associated with a single satoshi.
 
@@ -59,7 +52,7 @@ Ordinal number that uniquely identifies a satoshi
 | `200`       | Default response |
 | `400`       | Default response |
 
-</div>
+</APIInfo>
 
 <APIExample>