tum-esi/wade

[Results UI] Make id smaller and response bigger

egekorkan opened this issue · 4 comments

from Readme.md:

(+) Results UI: Make id smaller (write -> w, read -> r ...) and response bigger -> display as obj

I came up with some WIP alternatives to solve this:

Regarding "Make id smaller (write -> w, read -> r ...)":

Good that interactionName (e.g. r, w, o) comes at the end, which is better for cases where no interactionName is present (e.g. actions). An alternative is to do r: state or state: r for example but this can be confused with key-value pairs
props

Regarding "Make results bigger -> display as obj":

Properties is I think is clear: the key should be the property name and the value its resulting value
properties1

Actions option 1: object with result with actionName as key
actions1
Actions option 2: object with result with "res" as key
actions2

Events option 1: string of result
events1
Events option 2: object with result with "res" as key (just like option 2 for actions) e.g. { "key": "lorem ipsum" }. This required more work so I have no preview.

This is being worked on on branch bugfix-ui-fixes and references PR #78

What are your thoughts on this @egekorkan ?

I agree with the (r) and (w) kind of annotations.
Regarding wrapping the responses in another object is misleading. Some implementations actually return this kind of response already and this would give the impression that every implementation does this. I would say that the response should never be wrapped into another object.

Regarding wrapping the responses in another object is misleading. Some implementations actually return this kind of response already and this would give the impression that every implementation does this. I would say that the response should never be wrapped into another object.

Makes sense, wade shouldn't assume/enforce anything which is implementation-dependant. Will fall-back to non-object results for properties, action and event.

Edit: this is how it looks like after above fixes:

results-ui

Fixed in master