boaviztapi icon indicating copy to clipboard operation
boaviztapi copied to clipboard

Add warnings and comments in verbose mode

Open da-ekchajzer opened this issue 2 years ago • 0 comments

Problem

The values sent by the user may be inconsistent. In this case, it is necessary to inform the user.

In addition, the evaluations we produce are subject to many limitations. For the sake of transparency, it is important to send them back to the user

We propose to add a feature to send warnings to the users to transmit this type of information.

Solution

We could use a state variable warning = [] where we push warnings when they appear during the processing of the request.

Warning could be of this form :

{
"description": "...",
"type": "Input/Methodology"
}

Additional context

See state variables : https://www.starlette.io/requests/#other-state

da-ekchajzer avatar Nov 21 '22 11:11 da-ekchajzer