feat: add relayer version 1.5.0 docs

content/relayer/1.5.x/api/buildSponsoredTransaction.mdx

@@ -0,0 +1,59 @@
+---
+title: Prepares a sponsored (gasless) transaction with fee payments.
+full: true
+_openapi:
+  method: POST
+  route: /api/v1/relayers/{relayer_id}/transactions/sponsored/build
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: >-
+          This endpoint builds a transaction where the relayer will pay the
+          network fees on behalf of the user.
+
+          The user pays fees in a token of their choice (e.g., USDC) instead of
+          the native network currency.
+
+
+          The endpoint accepts either a pre-built transaction XDR or a set of
+          operations to build a transaction from.
+
+          It returns a prepared transaction that includes:
+
+          - The transaction XDR (base64 encoded) ready for signing
+
+          - The fee amount in both the fee token and native currency (stroops
+          for Stellar)
+
+          - The fee token identifier
+
+          - The transaction validity timestamp
+
+
+          After receiving the prepared transaction, the user must sign it and
+          submit it through the standard
+
+          transaction submission endpoint. For Stellar, the transaction will be
+          wrapped in a fee-bump transaction
+
+          where the relayer pays the network fees.
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+This endpoint builds a transaction where the relayer will pay the network fees on behalf of the user.
+The user pays fees in a token of their choice (e.g., USDC) instead of the native network currency.
+
+The endpoint accepts either a pre-built transaction XDR or a set of operations to build a transaction from.
+It returns a prepared transaction that includes:
+- The transaction XDR (base64 encoded) ready for signing
+- The fee amount in both the fee token and native currency (stroops for Stellar)
+- The fee token identifier
+- The transaction validity timestamp
+
+After receiving the prepared transaction, the user must sign it and submit it through the standard
+transaction submission endpoint. For Stellar, the transaction will be wrapped in a fee-bump transaction
+where the relayer pays the network fees.
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/sponsored/build","method":"post"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/callPlugin.mdx

@@ -0,0 +1,55 @@
+---
+title: Execute a plugin with optional wildcard route routing
+full: true
+_openapi:
+  method: POST
+  route: /api/v1/plugins/{plugin_id}/call
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: >-
+          Logs and traces are only returned when the plugin is configured with
+          `emit_logs` / `emit_traces`.
+
+          Plugin-provided errors are normalized into a consistent payload
+          (`code`, `details`) and a derived
+
+          message so downstream clients receive a stable shape regardless of how
+          the handler threw.
+
+
+          The endpoint supports wildcard route routing, allowing plugins to
+          implement custom routing logic:
+
+          - `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = "")
+
+          - `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via
+          query parameter
+
+          - `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL
+          path (route = "/verify")
+
+
+          The route is passed to the plugin handler via the `context.route`
+          field.
+
+          You can specify a custom route either by appending it to the URL path
+          or by using the `route` query parameter.
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Logs and traces are only returned when the plugin is configured with `emit_logs` / `emit_traces`.
+Plugin-provided errors are normalized into a consistent payload (`code`, `details`) and a derived
+message so downstream clients receive a stable shape regardless of how the handler threw.
+
+The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic:
+- `/api/v1/plugins/{plugin_id}/call` - Default endpoint (route = "")
+- `/api/v1/plugins/{plugin_id}/call?route=/verify` - Custom route via query parameter
+- `/api/v1/plugins/{plugin_id}/call/verify` - Custom route via URL path (route = "/verify")
+
+The route is passed to the plugin handler via the `context.route` field.
+You can specify a custom route either by appending it to the URL path or by using the `route` query parameter.
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"post"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/callPluginGet.mdx

@@ -0,0 +1,42 @@
+---
+title: Execute a plugin via GET (must be enabled per plugin)
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/plugins/{plugin_id}/call
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: >-
+          This endpoint is disabled by default. To enable it for a given plugin,
+          set
+
+          `allow_get_invocation: true` in the plugin configuration.
+
+
+          When invoked via GET:
+
+          - `params` is an empty object (`{}`)
+
+          - query parameters are passed to the plugin handler via
+          `context.query`
+
+          - wildcard route routing is supported the same way as POST (see
+          `doc_call_plugin`)
+
+          - Use the `route` query parameter or append the route to the URL path
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+This endpoint is disabled by default. To enable it for a given plugin, set
+`allow_get_invocation: true` in the plugin configuration.
+
+When invoked via GET:
+- `params` is an empty object (`{}`)
+- query parameters are passed to the plugin handler via `context.query`
+- wildcard route routing is supported the same way as POST (see `doc_call_plugin`)
+- Use the `route` query parameter or append the route to the URL path
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}/call","method":"get"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/cancelTransaction.mdx

@@ -0,0 +1,15 @@
+---
+title: Cancels a specific transaction by its ID.
+full: true
+_openapi:
+  method: DELETE
+  route: /api/v1/relayers/{relayer_id}/transactions/{transaction_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/{transaction_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/createNotification.mdx

@@ -0,0 +1,15 @@
+---
+title: Creates a new notification.
+full: true
+_openapi:
+  method: POST
+  route: /api/v1/notifications
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/notifications","method":"post"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/createRelayer.mdx

@@ -0,0 +1,15 @@
+---
+title: Creates a new relayer.
+full: true
+_openapi:
+  method: POST
+  route: /api/v1/relayers
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers","method":"post"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/createSigner.mdx

@@ -0,0 +1,15 @@
+---
+title: Creates a new signer.
+full: true
+_openapi:
+  method: POST
+  route: /api/v1/signers
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/signers","method":"post"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/deleteNotification.mdx

@@ -0,0 +1,15 @@
+---
+title: Deletes a notification by ID.
+full: true
+_openapi:
+  method: DELETE
+  route: /api/v1/notifications/{notification_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/deletePendingTransactions.mdx

@@ -0,0 +1,15 @@
+---
+title: Deletes all pending transactions for a specific relayer.
+full: true
+_openapi:
+  method: DELETE
+  route: /api/v1/relayers/{relayer_id}/transactions/pending
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/transactions/pending","method":"delete"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/deleteRelayer.mdx

@@ -0,0 +1,15 @@
+---
+title: Deletes a relayer by ID.
+full: true
+_openapi:
+  method: DELETE
+  route: /api/v1/relayers/{relayer_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/deleteSigner.mdx

@@ -0,0 +1,15 @@
+---
+title: Deletes a signer by ID.
+full: true
+_openapi:
+  method: DELETE
+  route: /api/v1/signers/{signer_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/signers/{signer_id}","method":"delete"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/getNetwork.mdx

@@ -0,0 +1,15 @@
+---
+title: Retrieves details of a specific network by ID.
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/networks/{network_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/networks/{network_id}","method":"get"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/getNotification.mdx

@@ -0,0 +1,15 @@
+---
+title: Retrieves details of a specific notification by ID.
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/notifications/{notification_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/notifications/{notification_id}","method":"get"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/getPlugin.mdx

@@ -0,0 +1,15 @@
+---
+title: Get plugin by ID
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/plugins/{plugin_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/plugins/{plugin_id}","method":"get"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/getRelayer.mdx

@@ -0,0 +1,15 @@
+---
+title: Retrieves details of a specific relayer by ID.
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/relayers/{relayer_id}
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}","method":"get"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/getRelayerBalance.mdx

@@ -0,0 +1,15 @@
+---
+title: Retrieves the balance of a specific relayer.
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/relayers/{relayer_id}/balance
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/balance","method":"get"}]} webhooks={[]} hasHead={false} />

content/relayer/1.5.x/api/getRelayerStatus.mdx

@@ -0,0 +1,15 @@
+---
+title: Fetches the current status of a specific relayer.
+full: true
+_openapi:
+  method: GET
+  route: /api/v1/relayers/{relayer_id}/status
+  toc: []
+  structuredData:
+    headings: []
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+<APIPage document={"https://raw.githubusercontent.com/OpenZeppelin/openzeppelin-relayer/refs/heads/release-v1.5.0/openapi.json"} operations={[{"path":"/api/v1/relayers/{relayer_id}/status","method":"get"}]} webhooks={[]} hasHead={false} />