Skip to content

Commit 3e2fd22

Browse files
aditya520aditya520
committed
feat(dev-hub) Api Reference V2
1 parent 992aa72 commit 3e2fd22

27 files changed

+739
-44
lines changed

apps/developer-hub/content/docs/openapi/fortuna/chain_ids.mdx renamed to apps/developer-hub/content/docs/api-reference/entropy/fortuna/chain_ids.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Get the list of supported chain ids
2+
title: "/v1/chains"
33
description: Get the list of supported chain ids
44
full: true
55
_openapi:

apps/developer-hub/content/docs/openapi/fortuna/explorer.mdx renamed to apps/developer-hub/content/docs/api-reference/entropy/fortuna/explorer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Returns the logs of all requests captured by the keeper.
2+
title: "/v1/logs"
33
description: >-
44
Returns the logs of all requests captured by the keeper.
55

apps/developer-hub/content/docs/openapi/fortuna/index.mdx renamed to apps/developer-hub/content/docs/api-reference/entropy/fortuna/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ title: Overview
66

77
<Cards>
88
<Card
9-
href="/openapi/fortuna/chain_ids"
9+
href="/api-reference/entropy/fortuna/chain_ids"
1010
title="Get the list of supported chain ids"
1111
description="Get the list of supported chain ids"
1212
/>
1313
<Card
14-
href="/openapi/fortuna/revelation"
14+
href="/api-reference/entropy/fortuna/revelation"
1515
title="Reveal the random value for a given sequence number and blockchain."
1616
description="Reveal the random value for a given sequence number and blockchain.\n\nGiven a sequence number, retrieve the corresponding random value that this provider has committed to.\nThis endpoint will not return the random value unless someone has requested the sequence number on-chain.\n\nEvery blockchain supported by this service has a distinct sequence of random numbers and chain_id.\nCallers must pass the appropriate chain_id to ensure they fetch the correct random number."
1717
/>
1818
<Card
19-
href="/openapi/fortuna/explorer"
19+
href="/api-reference/entropy/fortuna/explorer"
2020
title="Returns the logs of all requests captured by the keeper."
2121
description="Returns the logs of all requests captured by the keeper.\n\nThis endpoint allows you to filter the logs by a specific network ID, a query string (which can be a transaction hash, sender address, or sequence number), and a time range.\nThis is useful for debugging and monitoring the requests made to the Entropy contracts on various chains."
2222
/>

‎apps/developer-hub/content/docs/api-reference/entropy/fortuna/meta.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Fortuna",
3+
"pages": ["index", "chain_ids", "revelation", "explorer"]
4+
}

apps/developer-hub/content/docs/openapi/fortuna/revelation.mdx renamed to apps/developer-hub/content/docs/api-reference/entropy/fortuna/revelation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Reveal the random value for a given sequence number and blockchain.
2+
title: "/v1/chains/{chain_id}/revelations/{sequence}"
33
description: >-
44
Reveal the random value for a given sequence number and blockchain.
55

‎apps/developer-hub/content/docs/api-reference/entropy/meta.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Entropy",
3+
"pages": ["fortuna"]
4+
}

‎apps/developer-hub/content/docs/api-reference/meta.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"root": true,
3+
"title": "API Reference",
4+
"icon": "Code",
5+
"pages": ["entropy", "pyth-core"]
6+
}

‎apps/developer-hub/content/docs/api-reference/pyth-core/hermes/get_price_feed.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "/api/get_price_feed"
3+
description: >-
4+
**Deprecated: use /v2/updates/price/{publish_time} instead**
5+
6+
7+
Get a price update for a price feed with a specific timestamp
8+
9+
10+
Given a price feed id and timestamp, retrieve the Pyth price update closest to
11+
that timestamp.
12+
full: true
13+
_openapi:
14+
method: GET
15+
route: /api/get_price_feed
16+
toc: []
17+
structuredData:
18+
headings: []
19+
contents:
20+
- content: >-
21+
**Deprecated: use /v2/updates/price/{publish_time} instead**
22+
23+
24+
Get a price update for a price feed with a specific timestamp
25+
26+
27+
Given a price feed id and timestamp, retrieve the Pyth price update
28+
closest to that timestamp.
29+
---
30+
31+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
32+
33+
<APIPage
34+
document={"https://hermes.pyth.network/docs/openapi.json"}
35+
operations={[{ path: "/api/get_price_feed", method: "get" }]}
36+
webhooks={[]}
37+
hasHead={false}
38+
/>

‎apps/developer-hub/content/docs/api-reference/pyth-core/hermes/get_vaa.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "/api/get_vaa"
3+
description: >-
4+
**Deprecated: use /v2/updates/price/{publish_time} instead**
5+
6+
7+
Get a VAA for a price feed with a specific timestamp
8+
9+
10+
Given a price feed id and timestamp, retrieve the Pyth price update closest to
11+
that timestamp.
12+
full: true
13+
_openapi:
14+
method: GET
15+
route: /api/get_vaa
16+
toc: []
17+
structuredData:
18+
headings: []
19+
contents:
20+
- content: >-
21+
**Deprecated: use /v2/updates/price/{publish_time} instead**
22+
23+
24+
Get a VAA for a price feed with a specific timestamp
25+
26+
27+
Given a price feed id and timestamp, retrieve the Pyth price update
28+
closest to that timestamp.
29+
---
30+
31+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
32+
33+
<APIPage
34+
document={"https://hermes.pyth.network/docs/openapi.json"}
35+
operations={[{ path: "/api/get_vaa", method: "get" }]}
36+
webhooks={[]}
37+
hasHead={false}
38+
/>

‎apps/developer-hub/content/docs/api-reference/pyth-core/hermes/get_vaa_ccip.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "/api/get_vaa_ccip"
3+
description: >-
4+
**Deprecated: use /v2/updates/price/{publish_time} instead**
5+
6+
7+
Get a VAA for a price feed using CCIP
8+
9+
10+
This endpoint accepts a single argument which is a hex-encoded byte string of
11+
the following form:
12+
13+
`<price feed id (32 bytes> <publish time as unix timestamp (8 bytes, big
14+
endian)>`
15+
full: true
16+
_openapi:
17+
method: GET
18+
route: /api/get_vaa_ccip
19+
toc: []
20+
structuredData:
21+
headings: []
22+
contents:
23+
- content: >-
24+
**Deprecated: use /v2/updates/price/{publish_time} instead**
25+
26+
27+
Get a VAA for a price feed using CCIP
28+
29+
30+
This endpoint accepts a single argument which is a hex-encoded byte
31+
string of the following form:
32+
33+
`<price feed id (32 bytes> <publish time as unix timestamp (8 bytes,
34+
big endian)>`
35+
---
36+
37+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
38+
39+
<APIPage
40+
document={"https://hermes.pyth.network/docs/openapi.json"}
41+
operations={[{ path: "/api/get_vaa_ccip", method: "get" }]}
42+
webhooks={[]}
43+
hasHead={false}
44+
/>

0 commit comments

Comments
 (0)