Skip to content

Commit c3b38ce

Browse files
mmurrsclaude
andcommitted
docs(eigenda): flatten API directory structure, remove v2 naming
Since V1 has been removed, the disperser-v2-API subfolder is no longer needed. This flattens the structure: api/disperser-v2-API/overview.md -> api/overview.md api/disperser-v2-API/data-structures.md -> api/data-structures.md Also removes "v2" qualifier from text since there's now only one API version, and updates proto links to point to master branch. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 455aaab commit c3b38ce

File tree

3 files changed

+6
-10
lines changed

3 files changed

+6
-10
lines changed
File renamed without changes.

docs/eigenda/api/disperser-v2-API/_category_.json

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

docs/eigenda/api/disperser-v2-API/overview.md renamed to docs/eigenda/api/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Overview
55

66
## Dispersing Blobs
77

8-
The EigenDA v2 Disperser provides an API for:
8+
The EigenDA Disperser provides an API for:
99
* Dispersing blobs to the EigenDA network.
1010
* [Flexible payment modalities: on-demand and reserved bandwidth](https://docs.eigencloud.xyz/products/eigenda/core-concepts/payments).
1111

@@ -14,15 +14,15 @@ As part of its essential data availability guarantee, the EigenDA network suppor
1414
the EigenDA validators for blob retrieval.
1515
:::
1616

17-
The low level specification for the Disperser v2 API spec is [disperser.proto](https://github.com/Layr-Labs/eigenda/blob/v0.9.0/api/proto/disperser/v2/disperser_v2.proto), adjusted to the current release.
17+
The low level specification for the Disperser API is [disperser.proto](https://github.com/Layr-Labs/eigenda/blob/master/api/proto/disperser/v2/disperser_v2.proto).
1818
The goal of this document is to explain this spec at a higher level.
1919

20-
Eigen Labs hosts one v2 disperser endpoint for each EigenDA network. These endpoints are documented in respective network pages
20+
Eigen Labs hosts a disperser endpoint for each EigenDA network. These endpoints are documented in respective network pages
2121
for [Mainnet](../../networks/mainnet.md) and [Sepolia](../../networks/sepolia.md).
2222

2323
### Disperser Endpoints
2424

25-
The EigenDA v2 Disperser exposes the endpoints:
25+
The EigenDA Disperser exposes the endpoints:
2626

2727
* `DisperseBlob()`
2828
* `GetBlobStatus()`
@@ -58,7 +58,7 @@ The `GetBlobStatus()` response includes the relay keys. Fetch the relay URL from
5858
:::
5959

6060
:::tip
61-
Here we provide a narrative-level description of the major API endpoints. Please see [the repo](https://github.com/Layr-Labs/eigenda/blob/v0.9.0/api/proto/disperser/v2/disperser_v2.proto) adjusted to the current release, for detailed, field-level API documentation.
61+
Here we provide a narrative-level description of the major API endpoints. Please see [the repo](https://github.com/Layr-Labs/eigenda/blob/master/api/proto/disperser/v2/disperser_v2.proto) for detailed, field-level API documentation.
6262
:::
6363

6464
## Retrieving Blobs
@@ -90,5 +90,5 @@ The EigenDA Node exposes the retrieval endpoints:
9090
* `NodeInfo()`
9191

9292
:::tip
93-
Here we provide a narrative-level description of the major API endpoints. Please see [the repo](https://github.com/Layr-Labs/eigenda/blob/v0.9.1/api/proto/node/node.proto) adjusted to the current release, for detailed, field-level API documentation.
93+
Here we provide a narrative-level description of the major API endpoints. Please see [the repo](https://github.com/Layr-Labs/eigenda/blob/master/api/proto/node/node.proto) for detailed, field-level API documentation.
9494
:::

0 commit comments

Comments
 (0)