Skip to content

Commit 5112c64

Browse files
committed
fix: tighten retired-docs regex to avoid false positives on API subdomain /docs paths; remove em-dashes from dashboard API reference
1 parent 50f10a8 commit 5112c64

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/references/ic-dashboard-api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The Internet Computer exposes five public REST APIs for querying live network st
1717

1818
## IC API
1919

20-
**`https://ic-api.internetcomputer.org/api/v3/`** general network data across 40 endpoint groups.
20+
**`https://ic-api.internetcomputer.org/api/v3/`**: general network data across 40 endpoint groups.
2121

2222
| Group | What it returns |
2323
|-------|----------------|
@@ -40,7 +40,7 @@ Full endpoint reference: [ic-api.internetcomputer.org/api/v3/swagger](https://ic
4040

4141
## Metrics API
4242

43-
**`https://metrics-api.internetcomputer.org/api/v1/`** time-series metrics, organized by topic.
43+
**`https://metrics-api.internetcomputer.org/api/v1/`**: time-series metrics, organized by topic.
4444

4545
| Group | What it returns |
4646
|-------|----------------|
@@ -61,7 +61,7 @@ Full endpoint reference: [metrics-api.internetcomputer.org/api/v1/docs](https://
6161

6262
## ICRC API
6363

64-
**`https://icrc-api.internetcomputer.org/api/v1/`** data for any ICRC-standard token. Requires the token's ledger canister ID as a path parameter.
64+
**`https://icrc-api.internetcomputer.org/api/v1/`**: data for any ICRC-standard token. Requires the token's ledger canister ID as a path parameter.
6565

6666
| Group | What it returns |
6767
|-------|----------------|
@@ -82,7 +82,7 @@ Full endpoint reference: [icrc-api.internetcomputer.org/docs](https://icrc-api.i
8282

8383
## Ledger API
8484

85-
**`https://ledger-api.internetcomputer.org/api/v1/`** data for the ICP ledger specifically. For other ICRC tokens, use the [ICRC API](#icrc-api) instead.
85+
**`https://ledger-api.internetcomputer.org/api/v1/`**: data for the ICP ledger specifically. For other ICRC tokens, use the [ICRC API](#icrc-api) instead.
8686

8787
| Group | What it returns |
8888
|-------|----------------|
@@ -96,7 +96,7 @@ Full endpoint reference: [ledger-api.internetcomputer.org/swagger-ui/](https://l
9696

9797
## SNS API
9898

99-
**`https://sns-api.internetcomputer.org/api/v1/`** data for all SNS instances deployed on ICP.
99+
**`https://sns-api.internetcomputer.org/api/v1/`**: data for all SNS instances deployed on ICP.
100100

101101
| Group | What it returns |
102102
|-------|----------------|

scripts/validate.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ function checkFrontmatter(file, content) {
4444

4545
const FORBIDDEN = [
4646
{ re: /mo:base/, msg: '"mo:base" is banned — use "mo:core" instead' },
47-
{ re: /internetcomputer\.org\/docs/, msg: 'internetcomputer.org/docs is retired — link internally or inline' },
47+
{ re: /https?:\/\/(?:www\.)?internetcomputer\.org\/docs/, msg: 'internetcomputer.org/docs is retired — link internally or inline' },
4848
{ re: /docs\.internetcomputer\.org/, msg: 'docs.internetcomputer.org is this site — use relative paths for internal links' },
4949
];
5050

0 commit comments

Comments
 (0)