ExaWorks / job-api-spec

https://exaworks.org/job-api-spec/
3 stars 3 forks source link

move `getMessage` to `meta_data`? #124

Open andre-merzky opened 3 years ago

andre-merzky commented 3 years ago

Is your request related to a problem? Please describe. I am find the usage of the status message attribute unclear / unclean. (a) according to @hategan, it is supposed to convey error messages onFAILED states - but that means that the field is only usable in that state. But also, (b), I consider the meta_data dict to be the catch-all for any non-standardized, backend specific information, and an error message would fit that bill.

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered remove Status.getMessage.

Additional context I am uncertain about this - this may be more a request for clarification / discussion than for immediate change. Maybe making the name clearer (getMessage -> getError) would also work, to make the intent and scope clear.

hategan commented 1 year ago

Would renaming it to getErrorMessage make more sense?