[jira] [Created] (ISIS-1975) REST: discrepancy between schema and actual resonse content

[Andi Huber (JIRA)]

Andi Huber created ISIS-1975:
--------------------------------

Summary: REST: discrepancy between schema and actual resonse content
Key: ISIS-1975
URL: https://issues.apache.org/jira/browse/ISIS-1975
Project: Isis
Issue Type: Improvement
Components: Core: Viewer: RestfulObjects
Reporter: Andi Huber
Fix For: 2.0.0-M2


We do have some property names $$... in our REST responses, which are not part of the swagger schema (which is available for download from the UI when in prototyping mode).

This was reported on the user mailing list [1] ...

[1] [https://lists.apache.org/thread.html/ecbf2d3c25527c55716ea02c0adae2d815aa1546244c6ee15131b26c@%3Cusers.isis.apache.org%3E]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

[Andi Huber (JIRA)]

[ https://issues.apache.org/jira/browse/ISIS-1975?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andi Huber updated ISIS-1975:
-----------------------------
Summary: REST: discrepancy between schema export and actual response content (was: REST: discrepancy between schema and actual resonse content)

REST: discrepancy between schema export and actual response content
-------------------------------------------------------------------
Key: ISIS-1975
URL: https://issues.apache.org/jira/browse/ISIS-1975
Project: Isis
Issue Type: Improvement
Components: Core: Viewer: RestfulObjects
Reporter: Andi Huber
Priority: Minor
Fix For: 2.0.0-M2
We do have some property names $$... in our REST responses, which are not part of the swagger schema (which is available for download from the UI when in prototyping mode).
This was reported on the user mailing list [1] ...

--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

[Andi Huber (JIRA)]

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

Andi Huber commented on ISIS-1975:
----------------------------------

Unrelated but popped up in this context:

Users might not be aware of how to obtain an persistent object's ID. Since IsisJDOSupport seems to be used as common entry point for JDO concerns, we could extend the IsisJDOSupport class to also have a method that delegates to javax.jdo.JDOHelper's getObjectId(Object).

Post by Andi Huber (JIRA)
REST: discrepancy between schema export and actual response content
-------------------------------------------------------------------
Key: ISIS-1975
URL: https://issues.apache.org/jira/browse/ISIS-1975
Project: Isis
Issue Type: Improvement
Components: Core: Viewer: RestfulObjects
Reporter: Andi Huber
Priority: Minor
Fix For: 2.0.0-M2
We do have some property names $$... in our REST responses, which are not part of the swagger schema (which is available for download from the UI when in prototyping mode).
This was reported on the user mailing list [1] ...

--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

[Dan Haywood (JIRA)]

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

Dan Haywood commented on ISIS-1975:
-----------------------------------

I think maybe that the framework could provide a configuration property to allow user-defined prefix instead of "$$".

Post by Andi Huber (JIRA)
REST: discrepancy between schema export and actual response content
-------------------------------------------------------------------
Key: ISIS-1975
URL: https://issues.apache.org/jira/browse/ISIS-1975
Project: Isis
Issue Type: Improvement
Components: Core: Viewer: RestfulObjects
Reporter: Andi Huber
Priority: Minor
Fix For: 2.0.0-M2
We do have some property names $$... in our REST responses, which are not part of the swagger schema (which is available for download from the UI when in prototyping mode).
This was reported on the user mailing list [1] ...

--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

[Andi Huber (JIRA)]

[ https://issues.apache.org/jira/browse/ISIS-1975?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andi Huber reassigned ISIS-1975:
--------------------------------

Assignee: Andi Huber

Post by Andi Huber (JIRA)
REST: discrepancy between schema export and actual response content
-------------------------------------------------------------------
Key: ISIS-1975
URL: https://issues.apache.org/jira/browse/ISIS-1975
Project: Isis
Issue Type: Improvement
Components: Core: Viewer: RestfulObjects
Reporter: Andi Huber
Assignee: Andi Huber
Priority: Minor
Fix For: 2.0.0-M2
We do have some property names $$... in our REST responses, which are not part of the swagger schema (which is available for download from the UI when in prototyping mode).
This was reported on the user mailing list [1] ...

--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

[Andi Huber (JIRA)]

[ https://issues.apache.org/jira/browse/ISIS-1975?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andi Huber closed ISIS-1975.
----------------------------
Resolution: Fixed

The content negotiation parameter 'suppress' does now allow more control on which '$$..' properties one wants to suppress. New options are
{code:java}
public static enum SuppressionType {
/** suppress '$$RO', RO Spec representation*/
RO,

/** suppress '$$href', hyperlink to the representation*/
HREF,

/** suppress '$$instanceId', instance id of the domain object*/
ID,

/** suppress '$$title', title of the domain object*/
TITLE,

/** suppress all '$$...' entries*/
ALL
}{code}
where these are case-insensitive and may be combined to a comma-separated set.

Eg. to suppress $$title and $$href one could simply request
{noformat}
application/json;profile=urn:org.apache.isis/v1;suppress=title,href
{noformat}

We do not break the previous behavior with 'suppress=true' being equivalent to 'suppress=ro'

Post by Andi Huber (JIRA)
REST: discrepancy between schema export and actual response content
-------------------------------------------------------------------
Key: ISIS-1975
URL: https://issues.apache.org/jira/browse/ISIS-1975
Project: Isis
Issue Type: Improvement
Components: Core: Viewer: RestfulObjects
Reporter: Andi Huber
Assignee: Andi Huber
Priority: Minor
Fix For: 2.0.0-M2
We do have some property names $$... in our REST responses, which are not part of the swagger schema (which is available for download from the UI when in prototyping mode).
This was reported on the user mailing list [1] ...

--
This message was sent by Atlassian JIRA
(v7.6.3#76005)