Skip to content

Commit

Permalink
fix(docs): Fix build and deployment errors (#15563)
Browse files Browse the repository at this point in the history
* add dependency

* update yarn.lock

* add new api docs
  • Loading branch information
0xTxbi authored Feb 26, 2025
1 parent e6a6015 commit 1d302bd
Show file tree
Hide file tree
Showing 4 changed files with 157 additions and 0 deletions.
71 changes: 71 additions & 0 deletions docs/docs/api/locksmith/save-merkle-tree.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: save-merkle-tree
title: "saveMerkleTree"
description: "Saves a merkle tree from either a list of addresses or a list of [address, amount] tuples."
sidebar_label: "saveMerkleTree"
hide_title: true
hide_table_of_contents: true
api: eJy1Vk2P2zYQ/SsETxvAH8mivei2LdJi2wYJYi9ycHygpZHFmB8qSXnXMPzfO0PSstbeTbpJa8C2SA7JeW/ezGjPbQtOBGnNbcUL7sUW3oHbKJg7AD7iFfjSyZYMcHmGy54JpqMJC2jDamc1AxkacLiipA/M1kxUlQPv0doOpxd5fsSEtp0JSxa6VoGf4FUO/u7Ah19stePFPg6lA/QquA5GvLQmgAm0JNpWyTJ6Pf3iybM992UDWtBT2LWAvgrnxA6P1dLcBtCeF2/O4dyQCdMd+kanC2l6IEoxH5w0a8+ueiyvIhhceg7GiBnLtHzAfWRn79H9EZfp+t4zu/oCZcAFa+B9zYtFv5KuvKD9I5SylQj+SCu7upfoxgqY8F6uDVTZEfaZv/nMX/HD6IKHM+j5IGH6rRHCI8KucSAeToMeyHc7PnSsp6F1JMIgIZ6dvHnJLTfJf+FzyIaXmE6vwH1lSzY4LA8H+tLf4UBi9K01Prl0/fo1/Z3lQleWiKjulNoxypuKoXRYyh6W0+elou05Oal/wZ21gS/PeYqzxbe4maNLw2ylXawRvuGHjPSnp8Ddmq1QsmI5J9kV6DbsWNTSiBROaPFiVDymhMzWp0T5r6CDc9ZdYk/T39grvUffLzfn+ctK8WyePt5f2gouiUcmNWIX66fXWhGaf3HlccPgM+I/PxWhOyNWFFTLSIG1VH2sqi5OS6TfGYF1DNwWS1rkbPIjgTF4EV3Ki1ooD+e8PAufNFmLToWkRwfsXlDlSS6ho0cIVDYphzKSyeWdREeQgcb8dzDgZDmL8N5GRWTCNITGUjtrrY/xi+Tz6fZ6mnJhHFJ6Jmp8rDGdU2jThND6YjpVttx4jc1g0hl6HiPWYEurJqXVF1n2wdmqK2nAkjuxBD0+0QexRoDjl508S7v6Y5fkdNk5GXYzClSi/g6BDHinKwldNMDxCoSLRTA9/GadFhSMPz7NSZs3JxUMJdrKP4E0aoTO4/EmTkhyDCPkdpzYJuF8PPXutw9CUyPBDDzG//R0Ku+91JdLOrG28eoc2rvIDPvrSBVeSnFKlFxfkNTbMeRyK3GRrUS5AextdWdiXLA+Yf2qUW5AiROVJtEk4BMWNAiiEkFgA7EONTyKfdHYIOtMDGus3cTXFKQKsDGQu5mZd7fzSASpTQszWKG2cNYRHnm+PyXj//tulWMa4CFMW4UvOhT3qM99zo4F3xKxw/zAwDSUQLi236+EhzunDgeaTsEvFvi4FU6mBF0s8cwGREVaxIQisRT81wRwPCcPyFx1SU1nlYcSJu24wb7ahq/aLgc5/uH9bE7Szq+NOlZn7sQ9tQP8LTi9aUXCU9+kuT1Xwqy7WK54OpM+/wCd4N5u
sidebar_class_name: "post api-method"
info_path: api/locksmith/unlock-locksmith
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"saveMerkleTree"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/v2/merkle-tree"}
context={"endpoint"}
>

</MethodEndpoint>



Saves a merkle tree from either a list of addresses or a list of [address, amount] tuples.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"description":"Array must contain either all strings (addresses) or all [address, amount] tuples, no mixing allowed","items":{"type":"object","oneOf":[{"type":"string","description":"Recipient address (will be assigned amount \"1\")"},{"type":"array","description":"Address and amount tuple","minItems":2,"maxItems":2,"items":{"oneOf":[{"type":"string","description":"Recipient address"},{"type":"object","properties":{"amount":{"oneOf":[{"type":"string","description":"Amount as string"},{"type":"number","description":"Amount as number"}]}}}]}}]}}}}}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successfully saved the Merkle Tree","content":{"application/json":{"schema":{"type":"object","required":["root"],"properties":{"root":{"type":"string","description":"The merkle tree root hash"}}}}}},"400":{"description":"Invalid request (empty array, mixed types, or invalid addresses)","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["issues"],"properties":{"issues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}}}}}}}}},"500":{"description":"Unable to fullfil request due to internal server error.","content":{"application/json":{"schema":{"type":"object","nullable":false,"properties":{"message":{"type":"string","default":"There was an error in fullfiling the request.","nullable":false}},"title":"GenericServerError"}}}}}}
>

</StatusCodes>



71 changes: 71 additions & 0 deletions docs/docs/api/locksmith/update-event-data.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: update-event-data
title: "updateEventData"
description: "Update event data"
sidebar_label: "updateEventData"
hide_title: true
hide_table_of_contents: true
api: eJytVtuOGzcM/RVBTw3g2xobpPXbZrtp01uC2IsCXfhBHtEexTPSVBdnDWP+vaQ0tsf2OMgW2QevNCJF8vCQ1I6bCqzwyuj3kk94qKTw8LAB7X8WXvAed5AFq/yWT552/NGBxcW8nve4BJdZVZEqKj5GRQakyWRSrYQVJXiwLipr3KCkK8IKDxVpVcLnuLbwb1AW0AFvA6DNLIdS8MmO+20VdbxVesVrskvC4PxbI7ckkRnt0SYtRVUVKovBDD87cmt3eZVZfIbMk3eWQvcKXJTzwgd3abLHQYcS/ecVaJm+SKgKs0V353WPeyu0ExkZ/VW4vMPpHkcfsrUJ/t7opVp1OXNE4IkiIqleAmx+7qmSnTYSuh0Hi223T1d9EVIqCkcUH1uGU2bafhYmW7tL/9LnF91b1+SQBWSQvPNdSVgaWwo84cSyvlcYK6oktr5AhfKlfEFy96c5qeMfBegqo10KZTwa0b9Tpk9DloFzy1AUW9Z4cMr770VJKpSu1F3j6jexsYnzdnRzGRqVN1OOaeOZCD7HIMh5kIOrUX09II0giQXhvRSFg/MIS8RRrDpoSzW2FKGg9M1ysMC+CMeEZmCtQRc1I/iXqkBhhn6ypikMLm22c/4LaLAqm4LdgH2gq/gejdtLNNAwUx5KtjWBCfShFGuy19hiSDAmDSS44Fkl8/87+d8DK2SvCTaD6NLSBC2/CZC/jH8XhRtyYNPODY2DyrjIS2rTEz7cjIeR6G6YeD/cEUfrOCUI0tTngy1QOPe+cpPhMLaDUvl8EDSt+xiWN5kpBpkp+fkYwc4gQ6QvS1lCUp/fiPRfYeD9l908TVqHa+fH0TalnCSU04A7QEwmeTOPaL8A5IHFL2nxbt9ifvt7RtV3d1oXzSWiUr/Ddt/P476/jh/iDEQy2W1sTcSRT8fp9vAsyqqA9nRqDaGLSj/y4XLc0Mw4nu8H8X5PE6KlfdDad/Kz7oxtcXzbH73pj3+a3byevL6ZjH8cjN7c/MNPOvJ1MbpP6aWJGDVMfIwpZH/sc4p3EaFS7sYX2TzIMUz6RuEhW4hsjehgZ9BZGjOY2likoJH+sVMoFPG46jGkuKB2zZw3Fuuqh91FUtmoZZNBlhuzdlTSmFPAkUDuNtD9+X4Wo6D6KIVunSQAWHxBseYJdeJ668XS+WhqSOPh2Q+rQiBFaNBRAeyaOnziGwIkVeIBc1xM4sRAYudUtii32y2Eg0db1DV9TkzD5xtiK6xKPQELVipHa3noPFcd/uFTM/9fsWuu7kmvieAbUQTa4ZIY3zz+ano35SBkfEzumqP7ZKU/owuOqhdNlBpC0rjDQVz5r8rOW83s44fpjNjePBxLI0nHii/0/sLf6KaJUcdeEL9hFQi9CrHz8nQnJZ6mY6vEz/pCjKoTCMxIlJgZ5GpdH3DxtCdg6vo/EB7+Dg==
sidebar_class_name: "post api-method"
info_path: api/locksmith/unlock-locksmith
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"updateEventData"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/v2/events/update/{slug}"}
context={"endpoint"}
>

</MethodEndpoint>



Update event data

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","deployed"]},"transactionHash":{"type":"string"},"checkoutConfig":{"type":"object","required":["config","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"by":{"type":"string"},"config":{"type":"object","additionalProperties":true,"required":["locks"],"properties":{"locks":{"type":"object","additionalProperties":true}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"CheckoutConfig"}}}}}}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successfully updated event data","content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string"},"status":{"type":"string"},"transactionHash":{"type":"string"}}}}}},"401":{"description":"User is not authenticated.","content":{"application":{"schema":{"type":"object","nullable":false,"properties":{"message":{"type":"string","default":"There was an error in fullfiling the request.","nullable":false}},"title":"GenericServerError"}}}},"404":{"description":"The item you are making request for does not exist.","content":{"application/json":{"schema":{"type":"object","nullable":false,"properties":{"message":{"type":"string","default":"resource not found","nullable":false}},"title":"GenericNotFound"}}}}}}
>

</StatusCodes>



1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
"devDependencies": {
"autoprefixer": "10.4.20",
"postcss": "8.5.1",
"postcss-import": "16.1.0",
"postcss-nesting": "13.0.1",
"tailwindcss": "3.4.17"
}
Expand Down
14 changes: 14 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -18693,6 +18693,7 @@ __metadata:
docusaurus-theme-openapi-docs: "npm:4.3.3"
ethers: "npm:6.13.5"
postcss: "npm:8.5.1"
postcss-import: "npm:16.1.0"
postcss-nesting: "npm:13.0.1"
prism-react-renderer: "npm:2.4.1"
react: "npm:18.3.1"
Expand Down Expand Up @@ -42553,6 +42554,19 @@ __metadata:
languageName: node
linkType: hard

"postcss-import@npm:16.1.0":
version: 16.1.0
resolution: "postcss-import@npm:16.1.0"
dependencies:
postcss-value-parser: "npm:^4.0.0"
read-cache: "npm:^1.0.0"
resolve: "npm:^1.1.7"
peerDependencies:
postcss: ^8.0.0
checksum: 10/a0877244976b8b8a930adfc8dff9f5f6c251d78649e67aa80e963d11821e6dbc8f8b16fa1d126e8725093d69c77486fc4a6861c823693c068c3192d4879e0b29
languageName: node
linkType: hard

"postcss-import@npm:^15.1.0":
version: 15.1.0
resolution: "postcss-import@npm:15.1.0"
Expand Down

0 comments on commit 1d302bd

Please sign in to comment.