Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 8 additions & 17 deletions app/[locale]/[...slug]/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ import { getMDXComponents } from '@/components/mdx';
import { Mermaid } from '@/components/mdx/mermaid';
import { APIPage } from '@/components/openapi/api-page';
import { API } from '@/components/reference/api-page';
import { Badge } from '@/components/ui/badge';
import * as customIcons from '@/components/ui/icon';
import { TagFilterSystem } from '@/components/ui/tag-filter-system';
import { getAPIConfig } from '@/lib/api-config';
import { checkIfDeprecated } from '@/lib/check-deprecated';
import { i18n } from '@/lib/i18n';
import { getAllFilterablePages, source } from '@/lib/source';
import type { HeadingProps } from '@/types';
Expand Down Expand Up @@ -57,6 +57,9 @@ export default async function Page(props: {
.join('\n')
.trim();

// Check if this page contains deprecated API operations
const isDeprecated = await checkIfDeprecated(rawMarkdownContent);

const MDX = page.data.body;

if (!MDX) {
Expand Down Expand Up @@ -213,28 +216,16 @@ export default async function Page(props: {
BETA
</span>
)}
{page.data.isRpc && (
<Badge
variant="outline"
className="cursor-pointer font-normal text-[10px] px-1 py-0.5 uppercase bg-orange-500 text-neutral-950 dark:bg-brand-orange border-none"
>
RPC node
</Badge>
{isDeprecated && (
<span className="mt-1 font-semibold text-[10px] px-2 py-0.5 rounded uppercase tracking-wider bg-brand-gold/10 text-brand-gold dark:bg-brand-gold/20">
Deprecated
</span>
)}
</div>
{page.data.llm !== false && <LLMShare content={LLMContent} />}
</div>
<DocsPageDescription />

{/* RPC endpoint callout */}
{page.data.isRpc && (
<Callout type="info" title="About RPC endpoints">
These are served by Stacks nodes, not directly operated by Hiro. Availability and
performance may vary depending on upstream node health. For guaranteed
performance, run your own node or talk to us about dedicated options.
</Callout>
)}

{/* Render TagFilterSystem if tags are present in frontmatter */}
{page.data.tags && page.data.tags.length > 0 && (
<TagFilterSystem
Expand Down
1 change: 1 addition & 0 deletions components/openapi/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface OpenAPIOperation {
responses?: Record<string, OpenAPIResponse>;
security?: Array<Record<string, string[]>>;
tags?: string[];
deprecated?: boolean;
}

export interface OpenAPIParameter {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get account info
sidebarTitle: Info
description: Retrieves the account data for a given account or contract identifier.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Block by height (v3)
sidebarTitle: Block by height (v3)
description: Retrieves a block by its height using the v3 endpoint.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Validate proposed block
sidebarTitle: Block proposal
description: Validate a proposed Stacks block.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Upload block
sidebarTitle: Upload block
description: Upload a block to the node.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get approximate fees for the given transaction
sidebarTitle: Estimate
description: Get an estimated fee for the supplied transaction.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get transfer fee estimate
sidebarTitle: Transfer estimate
description: Retrieves an estimated fee rate for STX transfer transactions.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get core API info
sidebarTitle: Core API info
description: Retrieves information about the Core API, including the server version.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Health check
sidebarTitle: Health
description: Get health information about the node's synchronization status.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get Nakamoto block
sidebarTitle: Nakamoto block
description: Fetch a Nakamoto block by its index block hash.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get Nakamoto tenure blocks
sidebarTitle: Nakamoto tenure blocks
description: Fetch a sequence of Nakamoto blocks in a tenure.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Tenure fork info
sidebarTitle: Tenure fork info
description: Get information about tenure forks between two block IDs.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get Nakamoto tenure metadata
sidebarTitle: Nakamoto tenure metadata
description: Fetch metadata about the ongoing Nakamoto tenure.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Tenure tip
sidebarTitle: Tenure tip
description: Get the tip block ID of the tenure associated with a given consensus hash.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get PoX details
sidebarTitle: PoX details
description: Retrieves Proof-of-Transfer (PoX) information.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Signer details
sidebarTitle: Signer details
description: Get signer information for a specific signer and cycle.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get stacker and signer set information
sidebarTitle: Stacker and signer set information
description: Retrieves stacker and signer set information for a given cycle.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get constant value
sidebarTitle: Constant value
description: Get the value of a constant inside a contract.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Fast call read-only function
sidebarTitle: Fast call read-only
description: Call a read-only function on a smart contract without cost and memory tracking for faster execution.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get contract interface
sidebarTitle: Contract interface
description: Retrieves a list of functions, variables, maps, fungible tokens and non-fungible tokens for a given smart contract.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get contract map entry
sidebarTitle: Contract map entry
description: Retrieves a specific entry from a contract data map.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Call read-only function
sidebarTitle: Call read-only function
description: Calls a read-only public function on a given smart contract.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get contract source
sidebarTitle: Contract source
description: Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get trait implementation details
sidebarTitle: Trait implementation details
description: Determine whether or not a specified trait is implemented (either explicitly or implicitly) within a given contract.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get data variable
sidebarTitle: Data variable value
description: Get contract data variable
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Get sortitions
sidebarTitle: Get sortitions
description: Retrieves information about sortitions from the burnchain.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Latest and last sortitions
sidebarTitle: Latest and last sortitions
description: Retrieves information about the latest and last sortitions.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Sortition by burn hash
sidebarTitle: Sortition by burn hash
description: Retrieves information about a sortition by its burn block hash.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Sortition by burn height
sidebarTitle: Sortition by burn height
description: Retrieves information about a sortition by its burn block height.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Sortition by consensus hash
sidebarTitle: Sortition by consensus hash
description: Retrieves information about a sortition by its consensus hash.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Broadcast transaction
sidebarTitle: Transaction
description: Broadcasts raw transactions on the network.
full: true
isRpc: true
---

<APIPage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Transaction details (v3)
sidebarTitle: Transaction details (v3)
description: Get transaction details by transaction ID using the v3 endpoint.
full: true
isRpc: true
---

<APIPage
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading