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

Support external files for simulations through API #44

Open
steven-cd opened this issue May 19, 2022 · 0 comments
Open

Support external files for simulations through API #44

steven-cd opened this issue May 19, 2022 · 0 comments

Comments

@steven-cd
Copy link
Member

As we move to using the API for more production purposes, the config values are likely to get larger, and I think modellers may want to store them in individual files. The API doesn't really help them to do that though - because it's just the config they'd want to keep in the file, not the whole of the input, they can't just use something like curl -X POST /simulations --data "@file".

We could:

  • Add a different endpoint to which people can post the contents of the file (e.g. using --data "@file"), which returns some ID, followed by a call to POST /simulations referencing that ID to trigger the actual simulation
    • This requires us to store the config somewhere temporarily, which we can't do within the web-ui container. One option would be to store it in the Blob Store, which would correspond nicely with one of the options for Error on large payloads from GitHub API #43
  • Create a client library (or libraries) that has a convenience method for reading the config from a file
    • There are tools for generating libraries from the OpenAPI spec, and I'd assume we'd then be able to add some convenience. Might be good for other reasons as well, but doesn't have the ease of curl, and obviously has maintenance overhead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant