From 55349d95423660a5acb0cb9ed6cfc7ba32cb67f4 Mon Sep 17 00:00:00 2001 From: 8bitpal Date: Tue, 9 Jun 2026 09:56:52 +0200 Subject: [PATCH] Fix Scan API 404 and consolidate nav (issue #698) - Add 'common' tag definition to scan.yaml so /readyz, /livez, /status, /version generate pages at /reference/splice-scan-api/common/{path} - Remove explicit 71-entry pages list from docs.json Scan API block; Mintlify now auto-generates nav from spec tags, giving a grouped view instead of a flat list of individual endpoint entries - Update description on the Splice APIs card in api-reference.mdx - Clarify tag structure in splice-scan-openapi.mdx --- docs-main/api-reference.mdx | 2 +- docs-main/docs.json | 75 +------------------ docs-main/openapi/splice/scan/scan.yaml | 3 + .../api-reference/splice-scan-openapi.mdx | 2 +- 4 files changed, 6 insertions(+), 76 deletions(-) diff --git a/docs-main/api-reference.mdx b/docs-main/api-reference.mdx index 7c43c74ef..ac4df8c7c 100644 --- a/docs-main/api-reference.mdx +++ b/docs-main/api-reference.mdx @@ -32,7 +32,7 @@ The API Reference covers every programmatic interface to Canton - review endpoin - Developing with Canton Network's OpenAPI endpoints for: Canton Coin data, name service, token standard, and more. + OpenAPI endpoints for Canton Coin data, name service, token standard, and more — including the Scan, Wallet, ANS, and Token Standard APIs. diff --git a/docs-main/docs.json b/docs-main/docs.json index d0054c45d..a49442112 100644 --- a/docs-main/docs.json +++ b/docs-main/docs.json @@ -1780,80 +1780,7 @@ "openapi": { "source": "openapi/splice/scan/scan.yaml", "directory": "reference/splice-scan-api" - }, - "pages": [ - "GET /readyz", - "GET /livez", - "GET /status", - "GET /version", - "GET /v0/dso", - "GET /v0/validators/validator-faucets", - "GET /v0/scans", - "GET /v0/admin/validator/licenses", - "GET /v0/dso-sequencers", - "GET /v0/sv-bft-sequencers", - "GET /v0/domains/{domain_id}/parties/{party_id}/participant-id", - "GET /v1/domains/{domain_id}/parties/{party_id}/participant-id", - "GET /v0/domains/{domain_id}/members/{member_id}/traffic-status", - "GET /v0/closed-rounds", - "POST /v0/open-and-issuing-mining-rounds", - "POST /v2/updates", - "GET /v2/updates/{update_id}", - "POST /v1/updates", - "GET /v1/updates/{update_id}", - "GET /v0/state/acs/snapshot-timestamp", - "GET /v0/state/acs/snapshot-timestamp-after", - "POST /v0/state/acs", - "POST /v0/state/acs/force", - "POST /v0/holdings/state", - "POST /v0/holdings/summary", - "GET /v0/ans-entries", - "GET /v0/ans-entries/by-party/{party}", - "GET /v0/ans-entries/by-name/{name}", - "GET /v0/dso-party-id", - "POST /v0/amulet-rules", - "POST /v0/external-party-amulet-rules", - "POST /v0/ans-rules", - "GET /v0/featured-apps", - "GET /v0/featured-apps/{provider_party_id}", - "GET /v0/top-validators-by-validator-faucets", - "GET /v0/transfer-preapprovals/by-party/{party}", - "GET /v0/transfer-command-counter/{party}", - "GET /v0/transfer-command/status", - "GET /v0/migrations/schedule", - "GET /v0/synchronizer-identities/{domain_id_prefix}", - "GET /v0/synchronizer-bootstrapping-transactions/{domain_id_prefix}", - "GET /v0/splice-instance-names", - "GET /v0/amulet-price/votes", - "POST /v0/voterequest", - "GET /v0/voterequests/{vote_request_contract_id}", - "GET /v0/admin/sv/voterequests", - "POST /v0/admin/sv/voteresults", - "POST /v0/backfilling/migration-info", - "POST /v0/backfilling/updates-before", - "GET /v0/backfilling/status", - "GET /v0/acs/{party}", - "GET /v0/aggregated-rounds", - "POST /v0/round-totals", - "POST /v0/round-party-totals", - "GET /v0/amulet-config-for-round", - "GET /v0/round-of-latest-data", - "GET /v0/rewards-collected", - "GET /v0/top-providers-by-app-rewards", - "GET /v0/top-validators-by-validator-rewards", - "GET /v0/top-validators-by-purchased-traffic", - "POST /v0/activities", - "POST /v0/transactions", - "POST /v0/updates", - "GET /v0/updates/{update_id}", - "GET /v0/feature-support", - "POST /v0/backfilling/import-updates", - "POST /v0/events", - "GET /v0/events/{update_id}", - "GET /v0/unclaimed-development-fund-coupons", - "GET /v0/history/bulk/acs", - "POST /v0/history/bulk/updates" - ] + } }, { "group": "Scan Streaming API", diff --git a/docs-main/openapi/splice/scan/scan.yaml b/docs-main/openapi/splice/scan/scan.yaml index f687b8d38..8d82d39bf 100644 --- a/docs-main/openapi/splice/scan/scan.yaml +++ b/docs-main/openapi/splice/scan/scan.yaml @@ -5,6 +5,9 @@ info: servers: - url: https://scan.sv-1.global.canton.network.sync.global/api/scan tags: + - name: common + description: | + Health and status endpoints available on all nodes. - name: external description: | These endpoints are intended for public usage and will remain backward-compatible. diff --git a/docs-main/sdks-tools/api-reference/splice-scan-openapi.mdx b/docs-main/sdks-tools/api-reference/splice-scan-openapi.mdx index 06c85a614..61683dd96 100644 --- a/docs-main/sdks-tools/api-reference/splice-scan-openapi.mdx +++ b/docs-main/sdks-tools/api-reference/splice-scan-openapi.mdx @@ -3,7 +3,7 @@ title: "Scan Open API Reference" description: "Full OpenAPI specification for the Scan API" --- -The complete OpenAPI specification for the Scan API is published as a generated reference under [Scan API](/reference/splice-scan-api/common/readyz). It is organized by tag and includes the request and response schemas for every endpoint. +The complete OpenAPI specification for the Scan API is published as a generated reference under [Scan API](/reference/splice-scan-api/common/readyz). It is organized by tag (common, external, internal, deprecated, pre-alpha) and includes the request and response schemas for every endpoint. For an overview of the individual Scan API surfaces (current state, bulk data, aggregates, connectivity, operations, and CC reference data), see [Scan APIs](/sdks-tools/api-reference/splice-scan-api).