4337 API Reference (#477)

* Get endpoint categories from swagger tags; regenerate references; add metadata to new paths * Display transaction endpoints * Design fixes * Design fixes * Design fixes
safe-global · May 17, 2024 · b19ed6d · b19ed6d
1 parent 91a5659
commit b19ed6d
Show file tree

Hide file tree

Showing 19 changed files with 2,708 additions and 987 deletions.
diff --git a/.github/scripts/generateApiReference.js b/.github/scripts/generateApiReference.js
@@ -330,42 +330,33 @@ const generateCategoryContent = category => `<Grid my={8} />
 
 <Grid my={6} />
 
-${category.paths
-  .filter(
-    path =>
-      path !== '/v1/safes/{address}/balances/' &&
-      path !== '/v1/safes/{address}/balances/usd/' &&
-      path !== '/v1/safes/{address}/transactions/' &&
-      path !== '/v1/transactions/{safe_tx_hash}/'
-  )
-  .map(path => generatePathContent(path))
-  .join('\n')}`
-
-const getCategories = version =>
-  Object.keys(mainnetApiJson.paths)
-    .filter(path => path.includes(version))
-    .map(path => {
-      const pathname = path.replace('/' + version + '/', '').slice(0, -1)
-      return {
-        title: pathname.split('/')[0],
-        paths: Object.entries(mainnetApiJson.paths)
-          .filter(([key]) => key.includes(path))
-          .flat()
-          .filter((value, index) => index % 2 === 0)
-      }
-    })
-    .filter(
-      (category, index, self) =>
-        index === self.findIndex(t => t.title === category.title) &&
-        category.title !== ''
+${category.paths.map(path => generatePathContent(path)).join('\n')}`
+
+const getCategories = version => {
+  const allMethods = Object.entries(mainnetApiJson.paths)
+    .map(([k, v]) => Object.values(v))
+    .flat()
+  const allCategories = Array.from(
+    new Set(
+      allMethods
+        .map(method => method.tags)
+        .flat()
+        .filter(Boolean)
     )
+  )
+  return allCategories.map(title => ({
+    title,
+    paths: allMethods
+      .filter(method => method.tags?.includes(title) && !method.deprecated)
+      .map(m => m.path)
+  }))
+}
 
 const generateMainContent = () => {
   const categories = [...getCategories('v1')].filter(
     c =>
       c.title !== 'about' &&
-      c.title !== 'notifications' &&
-      c.title !== 'transactions'
+      c.title !== 'notifications'
   )
 
   return `import Path from './Path'

diff --git a/components/ApiReference/Parameter.tsx b/components/ApiReference/Parameter.tsx
@@ -1,5 +1,4 @@
 import Property from './Property'
-import Hr from '../Hr'
 import { MdxHeading } from '../../lib/mdx'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -10,10 +9,7 @@ const Parameters: React.FC<{ parameters: any[] }> = ({ parameters }) => {
   return (
     <>
       {query.length > 0 && (
-        <>
-          <MdxHeading headingLevel={4}>Query Parameters</MdxHeading>
-          <Hr />
-        </>
+        <MdxHeading headingLevel={4}>Query Parameters</MdxHeading>
       )}
       {query.map(parameter => (
         <Property
@@ -26,10 +22,7 @@ const Parameters: React.FC<{ parameters: any[] }> = ({ parameters }) => {
         />
       ))}
       {body.length > 0 && (
-        <>
-          <MdxHeading headingLevel={4}>Request Body</MdxHeading>
-          <Hr />
-        </>
+        <MdxHeading headingLevel={4}>Request Body</MdxHeading>
       )}
       {body.map(parameter =>
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument

diff --git a/components/ApiReference/Response.tsx b/components/ApiReference/Response.tsx
@@ -140,7 +140,6 @@ const Responses: React.FC<{ responses: any[] }> = ({ responses }) => {
   return (
     <Grid sx={{ mt: 2 }}>
       <MdxHeading headingLevel={4}>Responses</MdxHeading>
-      <Hr />
       {responses?.map?.((response, index) => (
         <Response key={index} index={index} response={response} />
       ))}

diff --git a/components/ApiReference/SampleRequestHeader.tsx b/components/ApiReference/SampleRequestHeader.tsx
@@ -11,7 +11,7 @@ const SampleRequestHeader: React.FC<{
   const [network] = useContext(NetworkContext)
 
   return (
-    <Grid container justifyContent='space-between'>
+    <Grid container justifyContent='space-between' alignItems='center'>
       <MdxHeading headingLevel={4}>Sample Request</MdxHeading>
       <Button
         variant='text'
@@ -20,6 +20,8 @@ const SampleRequestHeader: React.FC<{
         target='_blank'
         rel='noopener noreferrer'
         sx={{
+          mt: 1,
+          height: '36px',
           color: 'rgba(249,250,251,.7)',
           backgroundColor: ({ palette }) => palette.grey[900]
         }}

diff --git a/components/ApiReference/examples/-v1-contracts--get.json b/components/ApiReference/examples/-v1-contracts--get.json
@@ -1,5 +1,5 @@
 {
-  "count": 138998,
+  "count": 143350,
   "next": "https://safe-transaction-mainnet.safe.global/api/v1/contracts/?limit=2&offset=2",
   "previous": null,
   "results": [

diff --git a/components/ApiReference/examples/-v1-safes-{address}-balances--get.json b/components/ApiReference/examples/-v1-safes-{address}-balances--get.json
@@ -0,0 +1,17 @@
+[
+  {
+    "tokenAddress": null,
+    "token": null,
+    "balance": "100000000000000"
+  },
+  {
+    "tokenAddress": "0x111111111117dC0aa78b770fA6A738034120C302",
+    "token": {
+      "name": "1INCH Token",
+      "symbol": "1INCH",
+      "decimals": 18,
+      "logoUri": "https://safe-transaction-assets.safe.global/tokens/logos/0x111111111117dC0aa78b770fA6A738034120C302.png"
+    },
+    "balance": "1000000000000000000"
+  }
+]
diff --git a/components/ApiReference/examples/-v1-safes-{address}-creation--get.json b/components/ApiReference/examples/-v1-safes-{address}-creation--get.json
@@ -46,5 +46,6 @@
         "value": "0x0000000000000000000000000000000000000000"
       }
     ]
-  }
+  },
+  "userOperation": null
 }
diff --git a/components/ApiReference/examples/-v1-safes-{address}-safe-operations--get.json b/components/ApiReference/examples/-v1-safes-{address}-safe-operations--get.json
@@ -0,0 +1,6 @@
+{
+  "count": 0,
+  "next": null,
+  "previous": null,
+  "results": []
+}
diff --git a/components/ApiReference/examples/-v1-safes-{address}-user-operations--get.json b/components/ApiReference/examples/-v1-safes-{address}-user-operations--get.json
@@ -0,0 +1,6 @@
+{
+  "count": 0,
+  "next": null,
+  "previous": null,
+  "results": []
+}
diff --git a/components/ApiReference/examples/-v1-tokens--get.json b/components/ApiReference/examples/-v1-tokens--get.json
@@ -1,24 +1,24 @@
 {
-  "count": 39652,
+  "count": 40276,
   "next": "https://safe-transaction-mainnet.safe.global/api/v1/tokens/?limit=2&offset=2",
   "previous": null,
   "results": [
     {
       "type": "ERC20",
-      "address": "0x85A7a676D610A95865E842d2754b1fd335E55767",
+      "address": "0x56EBDaE96d179549f279ea0cFEa3b3432B8Cd2bC",
       "name": "",
       "symbol": "",
-      "decimals": 7,
-      "logoUri": "https://safe-transaction-assets.safe.global/tokens/logos/0x85A7a676D610A95865E842d2754b1fd335E55767.png",
+      "decimals": 18,
+      "logoUri": "https://safe-transaction-assets.safe.global/tokens/logos/0x56EBDaE96d179549f279ea0cFEa3b3432B8Cd2bC.png",
       "trusted": false
     },
     {
       "type": "ERC20",
-      "address": "0x56EBDaE96d179549f279ea0cFEa3b3432B8Cd2bC",
+      "address": "0x85A7a676D610A95865E842d2754b1fd335E55767",
       "name": "",
       "symbol": "",
-      "decimals": 18,
-      "logoUri": "https://safe-transaction-assets.safe.global/tokens/logos/0x56EBDaE96d179549f279ea0cFEa3b3432B8Cd2bC.png",
+      "decimals": 7,
+      "logoUri": "https://safe-transaction-assets.safe.global/tokens/logos/0x85A7a676D610A95865E842d2754b1fd335E55767.png",
       "trusted": false
     }
   ]

diff --git a/components/ApiReference/examples/-v2-delegates--get.json b/components/ApiReference/examples/-v2-delegates--get.json
@@ -0,0 +1,6 @@
+{
+  "count": 0,
+  "next": null,
+  "previous": null,
+  "results": []
+}
diff --git a/components/ApiReference/examples/-v2-delegates-{delegate_address}--delete.json b/components/ApiReference/examples/-v2-delegates-{delegate_address}--delete.json
@@ -0,0 +1 @@
+"Deleted"
diff --git a/components/ApiReference/examples/-v2-safes-{address}-collectibles--get.json b/components/ApiReference/examples/-v2-safes-{address}-collectibles--get.json
@@ -0,0 +1,19 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "address": "0x18F36D3222324DdAC1eFD0a524aabFb9D77D8041",
+      "tokenName": "Glarbs",
+      "tokenSymbol": "GLARB",
+      "logoUri": "https://safe-transaction-assets.safe.global/tokens/logos/0x18F36D3222324DdAC1eFD0a524aabFb9D77D8041.png",
+      "id": "2098",
+      "uri": "https://tokenofinfection.com/metadata/human/2098",
+      "name": null,
+      "description": null,
+      "imageUri": null,
+      "metadata": {}
+    }
+  ]
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -46,5 +46,6 @@ @@
             "value": "0x0000000000000000000000000000000000000000"
           }
         ]
-      }
+      },
+      "userOperation": null
     }