Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/openapi components #681

Merged
merged 2 commits into from
Jul 2, 2024
Merged

Chore/openapi components #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac6e303
updates
ryanwaits Jul 2, 2024
d796b8e
use APIInfo component
ryanwaits Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ node_modules
.next
bun.lockb
openapi
public/.DS_Store
.DS_Store
**/.DS_Store
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/brc20/get-brc20-activity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -70,7 +63,7 @@ Results per page
| :---------- | :--------------- |
| `200` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/brc20/get-brc20-balances.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -68,7 +61,7 @@ Bitcoin address
| :---------- | :--------------- |
| `200` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/brc20/get-brc20-token-details.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -35,7 +28,7 @@ Retrieves information for a BRC-20 token, including supply and holders.
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -55,7 +48,7 @@ Results per page
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/brc20/get-brc20-tokens.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -58,7 +51,7 @@ Results per page
| :---------- | :--------------- |
| `200` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
11 changes: 2 additions & 9 deletions content/docs/ordinals/api/info/status.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/inscriptions/get-inscription-content.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -37,7 +30,7 @@ Inscription unique identifier (number or ID)
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -57,7 +50,7 @@ Inscription unique identifier (number or ID)
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/inscriptions/get-inscription.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -37,7 +30,7 @@ Inscription unique identifier (number or ID)
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/inscriptions/get-inscriptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -195,7 +188,7 @@ Results order
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
13 changes: 3 additions & 10 deletions content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -55,7 +48,7 @@ Results per page
| `200` | Default response |
| `404` | Default response |

</div>
</APIInfo>

<APIExample>

Expand Down
Loading
Loading