Description
The suggestion
In JSON Forms argument schemas, one of the properties used (currently in most standard reports) is 'dir'
This is for 'direction' or 'sort direction' however it is not immediately clear during development what this means - needing to be interpreted from the description 'sort by dir'
Descriptions could also be expanded upon for developer use, from a bit of research this is their primary purpose (though with MUI can be used as a tooltip - not something we have in place currently)
Discussions here: #7406 (comment)
Example use case
Current property:
"dir": {
"description": "sort by dir",
"type": "string",
"enum": ["asc", "desc"]
}
Suggested property:
"direction": {
"description": "sort by direction",
"type": "string",
"enum": ["asc", "desc"]
}
Why should we invest time in this?
A small time investment to update the wording, however it will improve the development/pr review experience each time this is encountered.
Are there any risks associated with this change?
Low risk, no user facing changes. Will need to be cautious that all instances are updated and the UI schemas match
How much effort is required?
Small effort