Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Results UI] Make id smaller and response bigger #44

Closed
egekorkan opened this issue Jun 1, 2020 · 4 comments
Closed

[Results UI] Make id smaller and response bigger #44

egekorkan opened this issue Jun 1, 2020 · 4 comments
Labels
enhancement New feature or functionality prio:low

Comments

@egekorkan
Copy link
Member

from Readme.md:

(+) Results UI: Make id smaller (write -> w, read -> r ...) and response bigger -> display as obj
@egekorkan egekorkan added enhancement New feature or functionality prio:med labels Jun 1, 2020
This was referenced Jul 1, 2020
@miguelrk
Copy link
Contributor

miguelrk commented Jul 14, 2020

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 ?

@egekorkan
Copy link
Member Author

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.

@miguelrk
Copy link
Contributor

miguelrk commented Jul 15, 2020

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

@egekorkan
Copy link
Member Author

Fixed in master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or functionality prio:low
Projects
None yet
Development

No branches or pull requests

3 participants