FLINT.Cloud icon indicating copy to clipboard operation
FLINT.Cloud copied to clipboard

Feat: GCBM Refactor Idea Draft

Open Freeman-kuch opened this issue 3 years ago • 1 comments

Pull Request Template

Description

flint-UI has plans to separate the "/upload" endpoint into different endpoints depending on the category of config input. so endpoints like

  • "/gcbm/upload/disturbances"
  • "/gcbm/upload/classifiers"
  • "/gcbm/upload/miscellaneous"
  • "/gcbm/upload/db"
  • "/upload/title" (this sort of is likened to the "/create" endpoint which creates a new simulation and assigns a name to the simulation from user input)
  • A separate endpoint to Run the simulation would also be used instead of "/dynamic"(might get deprecated). The endpoint would just run the simulation after the necessary configs have been set

All these would be used instead of the all-purpose "/upload" and "/dynamic" endpoints

Fixes #205

Type of change

  • [ ] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I tested these new features locally using Postman without a Docker container and successfully created a simulation and uploaded the different config files and variables(attributes) @SanjaySinghRajpoot, @Namyalg, @HarshCasper , @aornugent , @Dabjazz. ...

Checklist:

  • [ ] My code follows the style guidelines of this project
  • [ ] I have performed a self-review of my own code
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • [ ] My changes generate no new warnings
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] New and existing unit tests pass locally with my changes
  • [ ] Any dependent changes have been merged and published in downstream modules
  • [ ] I have checked my code and corrected any misspellings
  • [ ] I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • [ ] I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

Freeman-kuch avatar Oct 27 '22 23:10 Freeman-kuch

@Namyalg - do you have time to read through this PR?

@Freeman-kuch - I've taken a quick look and it seems to be structured in a nicely modular way. You'll need to add more documentation to help us understand your design choices.

Thanks for the contribution!

aornugent avatar Dec 20 '22 11:12 aornugent