Extract common data structure out of <data-model>

[RaySinnema]

Consider a system for working with people and organizations they are affiliated with. There would be resources /organizations/{id}/ and /persons/{id}/ and the representation for both would include an address. With the current schema, we would have two <data-model> elements that contain nested properties for the address. IOW, we would have to duplicate the address structure.

I propose we eliminate that duplication by introducing a reference, e.g. something like:

<data-model name="address">
  <!-- properties -->
</data-model>

<data-model name="person">
  <properties>
    <property name="address">
      <properties ref="address"/>
    </property>
  </properties>
</data-model>

<data-model name="organization">
  <properties>
    <property name="visit-address">
      <properties ref="address"/>
    </property>
    <property name="post-address">
      <properties ref="address"/>
    </property>
  </properties>
</data-model>

[jonathanrobie]

+1

[gentlewind]

+1 for ref

[jonathanrobie]

Note that this is a breaking change for anyone using data models.

[RaySinnema]

Why is that? We're just adding the ref attribute, not taking anything away or changing any existing semantics, are we?

[jonathanrobie]

The ref attribute by itself is not a breaking change, we have several related issues, and the data-model element is going away.

[jonathanrobie]

See https://github.com/restful-api-description-language/RADL/issues/34

[jonathanrobie]

Is this resolved by the solution in issue #34 ?

[RaySinnema]

Yes.