From dbd8c3e18d511c8d400bf0e4ada9d186beb0dc13 Mon Sep 17 00:00:00 2001 From: 0age <37939117+0age@users.noreply.github.com> Date: Tue, 10 Dec 2024 16:24:22 -0800 Subject: [PATCH] more compact API reference --- frontend/src/components/APISection.tsx | 46 ++++++++++++-------------- 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/frontend/src/components/APISection.tsx b/frontend/src/components/APISection.tsx index ed87679..c919bc9 100644 --- a/frontend/src/components/APISection.tsx +++ b/frontend/src/components/APISection.tsx @@ -55,6 +55,11 @@ const APISection: React.FC = () => { request: '{chainId, compact: Compact}', response: '{hash, signature, nonce}', }, + { + method: 'GET', + path: '/compact/:chainId/:claimHash', + response: '{chainId, hash, compact: Compact, signature, createdAt}', + }, { method: 'GET', path: '/compacts', @@ -62,8 +67,8 @@ const APISection: React.FC = () => { }, { method: 'GET', - path: '/compact/:chainId/:claimHash', - response: '{chainId, hash, compact: Compact, signature, createdAt}', + path: '/suggested-nonce/:chainId', + response: '{nonce}', }, { method: 'GET', @@ -77,32 +82,25 @@ const APISection: React.FC = () => { response: '{balances: [{chainId, lockId, allocatableBalance, allocatedBalance, balanceAvailableToAllocate, withdrawalStatus: number}]}', }, - { - method: 'GET', - path: '/suggested-nonce/:chainId', - response: '{nonce}', - }, ], }; return ( -
-

- API Reference -

-
+
+

API Reference

+
All fields are of type `string` unless indicated otherwise. Arguments ending in ? are optional.
{/* Type Definitions */} -
-

+
+

Type Definitions

{Object.entries(typeDefinitions).map(([name, definition]) => ( -
-
+
+
{name} = {definition} @@ -112,13 +110,13 @@ const APISection: React.FC = () => {
{/* Endpoints */} -
+
{Object.entries(endpoints).map(([category, endpoints]) => (
-

+

{category} Endpoints {category === 'Authenticated' && ( - + (requires{' '} x-session-id: session @@ -127,19 +125,19 @@ const APISection: React.FC = () => { )}

-
+
{endpoints.map((endpoint, index) => (
-
+
{endpoint.method} @@ -157,7 +155,7 @@ const APISection: React.FC = () => { {endpoint.response}
{endpoint.args && ( -
+
{endpoint.args.map((arg, i) => (
{arg}