[Feature Request] api.latticesurgery.com API doc
Opened this issue · 0 comments
gwwatkin commented
Issue Description
Add a page to the API that describes how to use the HTTP rest api (the one at api.latticesurgery.com
or served by webapi/local_compiler_api_server.py
)
Proposed Solution
Markdown files with curl and python examples, plus formal structure of the response.
Additional References
Example request:
lattice-surgery-compiler/webapi/local_compiler_api_server.py
Lines 92 to 96 in 6628f59
Response structure in Typescript:
https://github.com/latticesurgery-com/web-ui/blob/main/ls-ui-react-app/src/slices.ts