Updated Documentation for GCBM REST API #144
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aornugent
reviewed
Jul 10, 2022
aornugent
previously approved these changes
Jul 10, 2022
local/rest_api_gcbm/README.md
Outdated
|
|
||
| 1. Create a new simulation (the default title of the simulation is `simulation`, here the title `run4` is used): | ||
| ``` | ||
| curl -d "title=run4" -X POST http://localhost:8080/gcbm/new |
There was a problem hiding this comment.
The title can be anything eg. "example-run"
|
Hey @Saurabh-Suchak is it possible for you to change the PR to a meaningful name? "Documentation for GCBM REST API" or something on that line? |
padmajabhol
requested changes
Jul 11, 2022
There was a problem hiding this comment.
@Namyalg had worked on the the endpoint that lets us change the table schema for the data base.
Please refer to https://github.com/Namyalg/gcbm-table-schema to understand how it works and we can interact with the endpoint. I'm sure we need it to go along with the entire documentation.
Sure, I will update the documentation as per the requirement |
HarshCasper
approved these changes
Oct 16, 2022
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 20, 2022
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * changed the endpoint name * Update app.py * Update README.md Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 20, 2022
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * changed the endpoint name * Update app.py * Update README.md Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 20, 2022
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * changed the endpoint name * Update app.py * Update README.md Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 27, 2022
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * changed the endpoint name * Update app.py * Update README.md Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Freeman-kuch
pushed a commit
to Freeman-kuch/FLINT.Cloud
that referenced
this pull request
Oct 28, 2022
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * changed the endpoint name * Update app.py * Update README.md Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com> Signed-off-by: Freeman <freemanoparaocha@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
Since a new GCBM run has been developed, this PR contains a new readme file containing the steps to run GCBM simulation locally.
Fixes the old documentation with updated instructions.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
The steps provided in the readme are executed are multiple times and verified.