Return REopt errors warns back to user #370
Conversation
and uncomment needed functionality
Return status 400 when REopt passes back an error
return job() function to its initial state
| @@ -0,0 +1,270 @@ | |||
| { | |||
There was a problem hiding this comment.
You know the default description that gets created for PRs in this repo that you fill in? In the "Please check if the PR fulfills these requirements" section, could you add a checkbox that says something like "Any new Django model inputs have also been added to job/test/posts/all_inputs_test.json"?
There was a problem hiding this comment.
Updated the PR description.
There was a problem hiding this comment.
I meant editing the default description that gets created for every PR. Adding to the 3 checkboxes at the top. That way for future PRs, people check that they have added to all_inputs_test.json.
There was a problem hiding this comment.
added issue #394 for this so I could approve this PR
|
Could you also fill out the PR description and update the changelog? |
Address PR#370 comments, update changelog, consolidate migration files, rename MessageOutputs to REoptjlMessageOutputs to differentiate. Update how errors and warns are returned to the user using existing Messages key, update error and informational text around error handling
Create a dictionary of errors and warnings to they are easy to process by API users. always return an empty dictionary if there are no errors/warnings. Update tests
|
@Bill-Becker @hdunham This PR should be ready for review next week (I just need to add documentation to REopt Wiki). Note that we would need to merge NREL/REopt.jl#118 before this can be merged into Develop. |
|
Some CHP tests are failing most likely because REopt TOML files point to REopt.jl's error-msgs branch. When that branch is merged into develop, failing tests should pass. |
This test had a chunk missing from it
|
@rathod-b I fixed a couple of accidental auto-merge deletion issues, and all the tests are passing now. I would comb through everything to make sure there are not more unintended deletions or other merge issues which may not be causing any issues with tests. Otherwise, looks good. Great work on this! |
|
@rathod-b The error-messages branch PR has been merged into master and published. Can you update the REopt.jl package in this branch? |
Yes, i can. Will let you know when this is updated, re-tested, and validated. |
This reverts commit 84aa2c1.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
(Bug fix, feature, docs update, ...)
Bug fix and feature
What is the current behavior?
(You can also link to an open issue here)
#371
Currently, some fields default to the previous iteration of defaults. Those have been identified and corrected.
#363
Currently, there is no ability for REopt.jl error messages to be passed back to the user in case of an error. This PR adds this functionality to REopt API's JOB app.
What is the new behavior (if this is a feature change)?
When there is an error or warning from REopt.jl, it is included under
Messageskey along with optimization response. Multiple errors and warnings can be accommodated in the API response.Documentation available here: https://github.com/NREL/REopt-API-Analysis/wiki/Common-Errors
Does this PR introduce a breaking change?
(What changes might users need to make in their application due to this PR?)
No. Users now receive additional information in their output JSON which they can use as appropriate.
Other information:
New test