Skip to content

Commit df61013

Browse files
committed
Remove outdated report-schemas documentation and clean up references
1 parent 4a9fb32 commit df61013

File tree

12 files changed

+12
-188
lines changed

12 files changed

+12
-188
lines changed

public/samples/DataLink/ClientReportsVerifier.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ contract ClientReportsVerifier {
8282
error InvalidReportVersion(uint16 version);
8383

8484
// ----------------- Report schemas -----------------
85-
// More info: https://docs.chain.link/datalink/pull-delivery/reference/report-schemas/v3
85+
// Extract schema version from feed ID (first 2 bytes of the feed ID)
8686
/**
8787
* @dev DataLink report schema v3.
8888
* Prices, bids and asks use 8 or 18 decimals depending on the feed.

src/config/sidebar.ts

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2441,24 +2441,6 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
24412441
title: "API, SDKs, Onchain Verification",
24422442
url: "datalink/pull-delivery/reference/api-sdk-onchain-verification",
24432443
},
2444-
{
2445-
title: "Report Schemas",
2446-
url: "datalink/pull-delivery/reference/report-schemas",
2447-
children: [
2448-
{
2449-
title: "V2",
2450-
url: "datalink/pull-delivery/reference/report-schemas/v2",
2451-
},
2452-
{
2453-
title: "V3",
2454-
url: "datalink/pull-delivery/reference/report-schemas/v3",
2455-
},
2456-
{
2457-
title: "V4",
2458-
url: "datalink/pull-delivery/reference/report-schemas/v4",
2459-
},
2460-
],
2461-
},
24622444
],
24632445
},
24642446
],

src/content/datalink/pull-delivery/reference/index.mdx

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,6 @@ isIndex: true
1010

1111
This section provides technical reference documentation for integrating with DataLink pull-delivery feeds. Use these resources to understand data structures, API specifications, and implementation details.
1212

13-
## API and SDK Reference
13+
## API, SDKs, and Onchain Verification
1414

15-
### API, SDKs, Onchain Verification Reference
16-
17-
[Complete reference](/datalink/pull-delivery/reference/api-sdk-onchain-verification) for DataLink APIs, SDKs, and onchain verification infrastructure. DataLink uses the same APIs, SDKs, and verification infrastructure as Chainlink Data Streams, enabling you to leverage existing integration patterns and tooling.
18-
19-
**Key topics covered:**
20-
21-
- REST API endpoints and authentication
22-
- Go and Rust SDK documentation
23-
- WebSocket streaming protocols
24-
- Onchain verification contracts and methods
25-
- Integration patterns and best practices
26-
27-
## Report Schemas
28-
29-
Learn about the different [report schema versions](/datalink/pull-delivery/reference/report-schemas) used by DataLink feeds and how to decode their structured data.
15+
Learn how to integrate DataLink into your applications using APIs, SDKs, and onchain verification methods.

src/content/datalink/pull-delivery/reference/report-schemas/index.mdx

Lines changed: 0 additions & 25 deletions
This file was deleted.

src/content/datalink/pull-delivery/reference/report-schemas/v2.mdx

Lines changed: 0 additions & 38 deletions
This file was deleted.

src/content/datalink/pull-delivery/reference/report-schemas/v3.mdx

Lines changed: 0 additions & 40 deletions
This file was deleted.

src/content/datalink/pull-delivery/reference/report-schemas/v4.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

src/content/datalink/pull-delivery/tutorials/fetch-decode/api-go.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Data Providers may use different report schema versions. The schema version dete
6767
1. Import the appropriate schema version in your code (e.g., `v4`).
6868
1. Use that version when decoding the report with `report.Decode[v4.Data]()`.
6969

70-
Different schema versions have different fields and structures. For detailed information about each schema version and its fields, refer to the [Report Schemas](/datalink/pull-delivery/reference/report-schemas) documentation.
70+
Different schema versions have different fields and structures.
7171

7272
In this example, we're using report schema `v4` for the EUR/USD feed, but your implementation should match the schema version specified by your Data Provider.
7373

@@ -286,7 +286,7 @@ When working with different DataLink providers, you'll need to adapt your code t
286286
decodedReport, err := report.Decode[v3.Data](reportResponse.FullReport)
287287
```
288288

289-
1. Access fields according to the schema version structure. Refer to the [Report Schemas](/datalink/pull-delivery/reference/report-schemas) documentation for complete field references for each version.
289+
1. Access fields according to the schema version structure.
290290

291291
## Explanation
292292

src/content/datalink/pull-delivery/tutorials/fetch-decode/api-rust.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Data Providers may use different report schema versions. The schema version dete
6969
1. Import the appropriate schema version in your code (e.g., `v4`).
7070
1. Use that version when decoding the report with `report.Decode[v4.Data]()`.
7171

72-
Different schema versions have different fields and structures. For detailed information about each schema version and its fields, refer to the [Report Schemas](/datalink/pull-delivery/reference/report-schemas) documentation.
72+
Different schema versions have different fields and structures.
7373

7474
In this example, we're using report schema `v4` for the EUR/USD feed, but your implementation should match the schema version specified by your Data Provider.
7575

@@ -224,7 +224,7 @@ When working with different DataLink providers, you'll need to adapt your code t
224224
let report_data = ReportDataV3::decode(&report_blob)?;
225225
```
226226

227-
1. Access fields according to the schema version structure. Refer to the [Report Schemas](/datalink/pull-delivery/reference/report-schemas) documentation for complete field references for each version.
227+
1. Access fields according to the schema version structure.
228228

229229
## Explanation
230230

src/content/datalink/pull-delivery/tutorials/onchain-verification-evm.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,7 @@ The `verifyReport` function is the core function that handles onchain report ver
138138

139139
- **Report data extraction**:
140140
- The function decodes the `unverifiedReport` to extract the report data.
141-
- It then extracts the report version by reading the first two bytes of the report data, which correspond to the schema version encoded in the feed ID:
142-
- Schema version `0x0003` corresponds to the [report schema v3](/datalink/pull-delivery/reference/report-schemas/v3).
143-
- Schema version `0x0004` corresponds to the [report schema v4](/datalink/pull-delivery/reference/report-schemas/v4).
141+
- It then extracts the report version by reading the first two bytes of the report data, which correspond to the schema version encoded in the feed ID.
144142
- If the report version is unsupported, the function reverts with an InvalidReportVersion error.
145143

146144
- **Fee calculation and handling**:

0 commit comments

Comments
 (0)