[OASIS Issue Tracker] (ODATA-875) Use of $ref for referencing elements in a JSON Schema

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ https://issues.oasis-open.org/browse/ODATA-875?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=61129#comment-61129 ] 

Ralf Handl commented on ODATA-875:
----------------------------------

The IETF draft for JSON References https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03 says:

1.  Introduction

   [...] This
   provides the basis for transclusion in JSON: the use of a target
   resource as an effective substitute for the reference.

3.  Syntax

   [...]
   Any members other than "$ref" in a JSON Reference object SHALL be
   ignored.

This seems to indicate that
(a) we should use JSON references only in places where the reference can be replaced with referenced JSON fragment, and
(b) we should not place relevant information inside the reference.

> Use of $ref for referencing elements in a JSON Schema
> -----------------------------------------------------
>
>                 Key: ODATA-875
>                 URL: https://issues.oasis-open.org/browse/ODATA-875
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData JSON CSDL
>    Affects Versions: V4.0_WD01
>            Reporter: Michael Pizzo
>             Fix For: V4.0_WD01
>
>
> Should we use $ref to reference the identify of something that must be externally defined (i.e., the function in a functionimport or entity type of an entity set or base term in a term)?
> In places where we choose $ref: should additional keywords that refine/decorate the use of the referenced element be placed next to $ref within the reference object, or should the reference be wrapped in an "allOf":[{"$ref":"..."}] construct and the additional keywords be placed next to allOf?



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)