Skip to content

Commit fd55b8f

Browse files
stevedylandevstevedylandev
committed
feat: added openapi components
1 parent b5a3fad commit fd55b8f

42 files changed

Lines changed: 1392 additions & 7 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/openzeppelin-relayer/api/callPlugin.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Calls a plugin method.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/plugins/{plugin_id}/call
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/cancelTransaction.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Cancels a specific transaction by its ID.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/relayers/{relayer_id}/transactions/{transaction_id}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/{transaction_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/createNotification.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Creates a new notification.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/notifications
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/notifications","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/createRelayer.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Creates a new relayer.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/relayers
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/relayers","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/createSigner.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Creates a new signer.
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /api/v1/signers
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/signers","method":"post"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/deleteNotification.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Deletes a notification by ID.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/notifications/{notification_id}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/deletePendingTransactions.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Deletes all pending transactions for a specific relayer.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/relayers/{relayer_id}/transactions/pending
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/pending","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/deleteRelayer.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Deletes a relayer by ID.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/relayers/{relayer_id}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/deleteSigner.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Deletes a signer by ID.
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /api/v1/signers/{signer_id}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/signers/{signer_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

‎content/openzeppelin-relayer/api/getNotification.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Retrieves details of a specific notification by ID.
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /api/v1/notifications/{notification_id}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
14+
15+
<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/main/docs/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"get"}]} webhooks={[]} hasHead={false} />

0 commit comments

Comments
 (0)