[jira] [Commented] (ISIS-933) Allow the RO viewer to be configured so that it can honour or ignore UI hints (in particular, the @Render(EAGERLY) facet).

["Dan Haywood (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ISIS-933?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14182949#comment-14182949 ] 

Dan Haywood commented on ISIS-933:
----------------------------------

# whether to honor UI hints, in particular Render(EAGERLY).  Defaults to false.
#isis.viewer.restfulobjects.honorUiHints=false



###############################################################################
# Non-standard configuration settings.
#
# If enabled of the following are enabled then the viewer is deviating from the
# RO spec standard; compatibility may be compromised with RO clients.
###############################################################################

# whether to show only object properties for object members
# (on the object representation only)
# Takes precedence over the other 'suppress' below.
#isis.viewer.restfulobjects.objectPropertyValuesOnly=true
isis.viewer.restfulobjects.objectPropertyValuesOnly=true

# whether to suppress "describedby" links.  Defaults to false.
#isis.viewer.restfulobjects.suppressDescribedByLinks=true

# whether to suppress "update" links.  Defaults to false.
#isis.viewer.restfulobjects.suppressUpdateLink=true

# whether to suppress "id" json-prop for object members.  Defaults to false.
#isis.viewer.restfulobjects.suppressMemberId=true

# whether to suppress "links" json-prop for object members
# (on the object representation only).  Defaults to false.
#isis.viewer.restfulobjects.suppressMemberLinks=true

# whether to suppress "extensions" json-prop for object members
# (on the object representation only).  Defaults to false.
#isis.viewer.restfulobjects.suppressMemberExtensions=true

# whether to suppress "disabledReason" json-prop for object members
# (on the object representation only).  Defaults to false.
#isis.viewer.restfulobjects.suppressMemberDisabledReason=true
isis.viewer.restfulobjects.suppressMemberDisabledReason=true

###############################################################################


> Allow the RO viewer to be configured so that it can honour or ignore UI hints (in particular, the @Render(EAGERLY) facet).
> --------------------------------------------------------------------------------------------------------------------------
>
>                 Key: ISIS-933
>                 URL: https://issues.apache.org/jira/browse/ISIS-933
>             Project: Isis
>          Issue Type: New Feature
>          Components: Core: Viewer: RestfulObjects
>    Affects Versions: core-1.7.0
>            Reporter: Dan Haywood
>            Assignee: Dan Haywood
>            Priority: Minor
>             Fix For: core-1.8.0
>
>
> Currently in Estatio, retrieving a Property entity results in a 2.6Mb response.  This is  because its 'Units' collection is annotated as an eagerly rendered.
> We expect that most RO clients to be "data" API clients, ie will make their own decisions about which data to retrieve and how. 
> For this ticket, suggest simply a global configuration setting:
> # whether to honor UI hints, in particular Render(EAGERLY).  Default to false.
> #isis.viewer.restfulobjects.honorUiHints=false
> ~~~
> In the future, this could be generalized/refined by having the RO client send an HTTP Accept header and have the RO viewer server respond appropriately.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)