RELATED IDEAS
REST API Swagger schema example clarity
Please, fill in the below fields to enable the processing of your idea.
Who would benefit? |
Developers. |
What impact would it make? |
Make it easier to identify what data is expected to be supplied. |
How should it work? |
Give more explicit examples for the Schema examples values. |
Why is it needed? |
Because it is not clear what data can or should be supplied in certain scenarios. |
Additional feedback, background or context:
My issue is with examples like below, where "additionalProp1", "additionalProp2", etc. gives me no further info as to what is expected. I can in this case somewhat think that I should supply "en": "some value", "da":"some other value", but that is only because I would normally have a LocaleString in this scenario when using the Remoting API.
{
"id": "string",
"name": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
In general I feel that the documentation of the REST API is lacking, just like the implementation.
