Skip to content

fix: fix broken docs links to new docs #2369

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

Open
pradel wants to merge 1 commit into
base: develop
Choose a base branch
from
+77 −23
Open

fix: fix broken docs links to new docs #2369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Get started at https://docs.hiro.so/clarinet/getting-started

The docker image `hirosystems/stacks-blockchain-api` is recommended when running the API in a mainnet or testnet environment.

Note that this image cannot be ran standalone. Other services need to be configured correctly and running. For more information check out [this guide on how to run a node](https://docs.stacks.co/guides-and-tutorials/nodes-and-miners).
Note that this image cannot be ran standalone. Other services need to be configured correctly and running. For more information check out [this guide on how to run a node](https://docs.stacks.co/operate).


## Development quick start
Expand Down
70 changes: 62 additions & 8 deletions client/src/generated/schema.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions src/api/routes/address.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export const AddressRoutes: FastifyPluginAsync<
operationId: 'get_account_stx_balance',
summary: 'Get account STX balance',
description: `**NOTE:** This endpoint is deprecated in favor of [Get address STX balance](/api/get-principal-stx-balance).

Retrieves STX token balance for a given Address or Contract Identifier.`,
tags: ['Accounts'],
params: Type.Object({
Expand Down Expand Up @@ -167,7 +167,7 @@ export const AddressRoutes: FastifyPluginAsync<
operationId: 'get_account_balance',
summary: 'Get account balances',
description: `**NOTE:** This endpoint is deprecated in favor of [Get address FT balances](/api/get-principal-ft-balances).

Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.`,
tags: ['Accounts'],
params: Type.Object({
Expand Down Expand Up @@ -276,7 +276,7 @@ export const AddressRoutes: FastifyPluginAsync<
summary: 'Get account transactions',
description: `**NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).

Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).

If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.`,
tags: ['Accounts'],
Expand Down
2 changes: 1 addition & 1 deletion src/api/routes/stx-supply.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export const StxSupplyRoutes: FastifyPluginAsync<
schema: {
operationId: 'get_stx_supply',
summary: 'Get total and unlocked STX supply',
description: `Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).`,
description: `Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking).`,
tags: ['Info'],
querystring: Type.Object({
height: Type.Optional(
Expand Down
6 changes: 3 additions & 3 deletions src/api/routes/tokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const TokenRoutes: FastifyPluginAsync<
description: `Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID).
Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.

More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).`,
More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).`,
tags: ['Non-Fungible Tokens'],
querystring: Type.Object({
principal: PrincipalSchema,
Expand Down Expand Up @@ -141,7 +141,7 @@ export const TokenRoutes: FastifyPluginAsync<
summary: 'Non-Fungible Token history',
description: `Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.

More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).`,
More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).`,
tags: ['Non-Fungible Tokens'],
querystring: Type.Object({
asset_identifier: Type.String({
Expand Down Expand Up @@ -256,7 +256,7 @@ export const TokenRoutes: FastifyPluginAsync<
summary: 'Non-Fungible Token mints',
description: `Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.

More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).`,
More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).`,
tags: ['Non-Fungible Tokens'],
querystring: Type.Object({
asset_identifier: Type.String({
Expand Down
4 changes: 2 additions & 2 deletions src/api/routes/v2/addresses.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export const AddressRoutesV2: FastifyPluginAsync<
operationId: 'get_address_transactions',
summary: 'Get address transactions',
description: `Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.
More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).`,

More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).`,
tags: ['Transactions'],
params: AddressParamsSchema,
querystring: Type.Object({
Expand Down
10 changes: 5 additions & 5 deletions src/api/schemas/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const OpenApiSchemaOptions: SwaggerOptions = {
description: 'Read-only endpoints to obtain Stacks account details',
externalDocs: {
description: 'Stacks Documentation - Accounts',
url: 'https://docs.stacks.co/understand-stacks/accounts',
url: 'https://docs.stacks.co/network-fundamentals/accounts',
},
},
{ name: 'Blocks', description: 'Read-only endpoints to obtain Stacks block details' },
Expand Down Expand Up @@ -54,15 +54,15 @@ export const OpenApiSchemaOptions: SwaggerOptions = {
description: 'Read-only endpoints realted to the Blockchain Naming System on Stacks',
externalDocs: {
description: 'Stacks Documentation - Blockchain Naming System',
url: 'https://docs.stacks.co/build-apps/references/bns',
url: 'https://docs.stacks.co/network-fundamentals/bitcoin-name-system',
},
},
{
name: 'Non-Fungible Tokens',
description: 'Read-only endpoints to obtain non-fungible token details',
externalDocs: {
description: 'Stacks Documentation - Tokens',
url: 'https://docs.stacks.co/write-smart-contracts/tokens',
url: 'https://docs.stacks.co/build/create-tokens',
},
},
{
Expand All @@ -83,15 +83,15 @@ export const OpenApiSchemaOptions: SwaggerOptions = {
description: 'Read-only endpoints to obtain Clarity smart contract details',
externalDocs: {
description: 'Stacks Documentation - Clarity Smart Contracts',
url: 'https://docs.stacks.co/write-smart-contracts/overview',
url: 'https://docs.stacks.co/clarity/overview',
},
},
{
name: 'Stacking Rewards',
description: 'Read-only endpoints to obtain Stacking reward details',
externalDocs: {
description: 'Stacks Documentation - Stacking',
url: 'https://docs.stacks.co/understand-stacks/stacking',
url: 'https://docs.stacks.co/block-production/stacking',
},
},
{
Expand Down
Loading