openhab-core/bundles/org.openhab.core.io.rest.ui
Yannick Schaus 065177b730
[rest] Add summary option to rules, things, UI components resources (#1827)
The /things, /rules, /ui/components endpoints retrieve all objects
in their entirety, which can become very big, i.e. channels, config
parameters, script rule modules or trees of UI components can
quickly add up to the size.

When the UI simply displays a list of those objects it retrieves all
this extra information but does nothing with it.

This introduces an optional ?summary=true query parameter for the
above resources to limit the output to pre-defined fields which are
deemed most relevant for displaying these lists, omitting the rest.

When the option is not set, the behavior remains unchanged so this
change is not API breaking. The API version has therefore not been
incremented. The client is responsible for adding the option to
retrieve summarized collections instead of the entire objects.

Signed-off-by: Yannick Schaus <github@schaus.net>
2020-11-21 18:40:48 +01:00
..
src/main/java/org/openhab/core/io/rest/ui [rest] Add summary option to rules, things, UI components resources (#1827) 2020-11-21 18:40:48 +01:00
.classpath [infrastructure] add external null-annotations (#1775) 2020-11-03 21:33:48 +01:00
.project Refactor dashboard tiles into core (#1329) 2020-01-17 15:28:05 +01:00
NOTICE Refactor dashboard tiles into core (#1329) 2020-01-17 15:28:05 +01:00
pom.xml Refactor dashboard tiles into core (#1329) 2020-01-17 15:28:05 +01:00