Standard message for PropertyValueTypeError

Hi Jeff,
We can use like null/empty array/empty object/invalid data type(many more will add up) as generic value instead of getting the value from request which can solve the issue. But if we add one generic message in Base using only property alone , it will be good for future use.

Another option is to provide Property name, property data type allowed(data type) alone in message args instead of parsing value provided in request body(where the value can't or shouldn't be included in the message)

Thanks,
Mani

Thanks for adding to next release.

Thanks,
Mani

Hi Jeff,
We are able to see PropertyValueError message addition in redfish.dmtf.org/registries/Base.1.11.0.json and thanks for adding that.
I have a clarification related to returning two different messaes based on request body and would like to know whether this is ok in implementation

Assume user is patching AssetTag which is string and request body for patch request  as below

Use case 1 

"AssetTag": "{test{test1}}"

Above request data can contain/nested objects/nested array and mainly targeting invalidat data. For above request returning bad request with PropertyValueError as response


Use case 2


"AssetTag": true


Above request data can different direct data type like boolean, numbers and mainly targeting invalidat data. For above request returning bad request with PropertyValueTypeError since service is able to print property vale in message

For same URI patch with same attributes, returning two error messages based on request data.


Do we need service implementation to return uniform message(PropertyValueError) always irrespective  of request body or show different mesage(PropertyValueError/PropertyValueTypeError) based on request body?

Thanks,
Mani

Hi Jeff,

Thanks for the prompt reply.
I would like to explain some more details. I think the group helped to add the general message PropertyValueError that can apply to different cases and its very useful.
The actual problem @mani and I have right now is for same type of invalid input, do we allow to use different messages or shall use single one is better.

For example, user try to PATCH a property with invalid data type values. We use "AssetTag" (string) as example here and assume user try to give following invalid values.

PATCH
A - {"AssetTag": true}
B - {"AssetTag": 123}
C - {"AssetTag": ["a", "b", "c"]}
D - {"AssetTag": {"a": 123}}



For case A and B, Redfish returns PropertyValueError
For case C and D, Redfish returns PropertyValueTypeError.

The question here is A, B, C and D all are invalid type input cases. Is above implementation ok? or we shall pick only one to use is better?

Please share your thoughts. Many thanks.


Caffrey

Caffrey's four cases are technically all "type errors" (since none of those are strings) - but my answer will be the same, regardless.

Either of those messages are accurate, and what you return may be dependent on how the code works (and likely depends on the language used and libraries involved). In the case above, it may be that since C and D are array/object types that they cause a different code path than the A or B cases which are single values but wrong data type.

So if the code detects one error condition (wrong data type) in some cases, but another error condition in others, that's fine. In all those cases, the results will be the same, with the same HTTP response code and fixes needed in the request.

Jeff