Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] api.latticesurgery.com API doc #158

Open
gwwatkin opened this issue Nov 16, 2021 · 0 comments
Open

[Feature Request] api.latticesurgery.com API doc #158

gwwatkin opened this issue Nov 16, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gwwatkin
Copy link
Member

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:

JSON_POST_PARAMETERS = {
"circuit_source": "str", # alternative would be 'file'
"circuit": SAMPLE_CIRCUIT,
"apply_litinski_transform": True,
}

Response structure in Typescript:
https://github.com/latticesurgery-com/web-ui/blob/main/ls-ui-react-app/src/slices.ts

@gwwatkin gwwatkin added the documentation Improvements or additions to documentation label Nov 16, 2021
@gwwatkin gwwatkin added this to Ready to Start in Lattice Surgery Compiler via automation Nov 16, 2021
@gwwatkin gwwatkin self-assigned this Nov 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant