Skip to content

Commit 8c801e9

Browse files
ferencsaraiFerenc Sárai
andauthored
fix: wrong JSDoc links (#978)
Co-authored-by: Ferenc Sárai <ferenc.sarai@solarpunk.buzz>
1 parent 9dd071d commit 8c801e9

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

src/bee.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1295,7 +1295,7 @@ export class Bee {
12951295
* @throws TypeError if tagUid is in not correct format
12961296
*
12971297
* @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
1298-
* @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/debug-api/#tag/Tag)
1298+
* @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/get)
12991299
*
13001300
*/
13011301
async retrieveExtendedTag(tagUid: number | Tag, options?: BeeRequestOptions): Promise<ExtendedTag> {
@@ -1688,7 +1688,7 @@ export class Bee {
16881688
* @throws TypeError if non-integer value is passed to amount or depth
16891689
*
16901690
* @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
1691-
* @see [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post)
1691+
* @see [Bee API reference - `POST /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post)
16921692
*/
16931693
async createPostageBatch(
16941694
amount: NumberString,
@@ -1735,7 +1735,7 @@ export class Bee {
17351735
* @param options Request options
17361736
*
17371737
* @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
1738-
* @see [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{id}~1{amount}/patch)
1738+
* @see [Bee API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{batch_id}~1{amount}/patch)
17391739
*/
17401740
async topUpBatch(postageBatchId: BatchId | string, amount: NumberString, options?: BeeRequestOptions): Promise<void> {
17411741
assertRequestOptions(options)
@@ -1759,7 +1759,7 @@ export class Bee {
17591759
* @param options Request options
17601760
*
17611761
* @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
1762-
* @see [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{id}~1{amount}/patch)
1762+
* @see [Bee API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{batch_id}~1{amount}/patch)
17631763
*/
17641764
async diluteBatch(postageBatchId: BatchId | string, depth: number, options?: BeeRequestOptions): Promise<void> {
17651765
assertRequestOptions(options)
@@ -1775,7 +1775,7 @@ export class Bee {
17751775
* @param postageBatchId Batch ID
17761776
*
17771777
* @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
1778-
* @see [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}/get)
1778+
* @see [Bee API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{batch_id}/get)
17791779
*/
17801780
async getPostageBatch(postageBatchId: BatchId | string, options?: BeeRequestOptions): Promise<PostageBatch> {
17811781
assertRequestOptions(options)
@@ -1790,7 +1790,7 @@ export class Bee {
17901790
* @param postageBatchId Batch ID
17911791
*
17921792
* @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
1793-
* @see [Bee Debug API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}~1buckets/get)
1793+
* @see [Bee API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{batch_id}~1buckets/get)
17941794
*/
17951795
async getPostageBatchBuckets(
17961796
postageBatchId: BatchId | string,
@@ -1806,7 +1806,7 @@ export class Bee {
18061806
* Return all postage batches that has the node available.
18071807
*
18081808
* @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
1809-
* @see [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps/get)
1809+
* @see [Bee API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get)
18101810
*/
18111811
async getAllPostageBatch(options?: BeeRequestOptions): Promise<PostageBatch[]> {
18121812
assertRequestOptions(options)

src/types/debug.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,14 +211,14 @@ export interface NodeInfo {
211211
/**
212212
* Indicates whether the Bee node has its own deployed chequebook.
213213
*
214-
* @see [Bee docs - Chequebook](https://docs.ethswarm.org/docs/learn/glossary#cheques--chequebook)
214+
* @see [Bee docs - Chequebook](https://docs.ethswarm.org/docs/references/glossary/#cheques--chequebook)
215215
*/
216216
chequebookEnabled: boolean
217217

218218
/**
219219
* Indicates whether SWAP is enabled for the Bee node.
220220
*
221-
* @see [Bee docs - SWAP](https://docs.ethswarm.org/docs/learn/glossary#swap)
221+
* @see [Bee docs - SWAP](https://docs.ethswarm.org/docs/references/glossary/#swap)
222222
*/
223223
swapEnabled: boolean
224224
}

0 commit comments

Comments
 (0)