[ODATA-360] Remove edm:documentation element from [CSDL] - OASIS Technical Committees Issue Tracker

XML

Word

Printable

Proposal:

Hide

Remove the <documentation> element from CSDL and define a documentation term in the core vocabulary. See also ~~ODATA-361~~

<Term Name="Description" Type="Edm.String">
<Annotation Term="Core.Description" String="A brief description of a model element" />
<Annotation Term="Core.IsLanguageDependent" />
</Term>

<Term Name="LongDescription" Type="Edm.String">
<Annotation Term="Core.Description" String="A lengthy description of a model element" />
<Annotation Term="Core.IsLanguageDependent" />
</Term>

Show
Remove the <documentation> element from CSDL and define a documentation term in the core vocabulary. See also ODATA-361 <Term Name="Description" Type="Edm.String"> <Annotation Term="Core.Description" String="A brief description of a model element" /> <Annotation Term="Core.IsLanguageDependent" /> </Term> <Term Name="LongDescription" Type="Edm.String"> <Annotation Term="Core.Description" String="A lengthy description of a model element" /> <Annotation Term="Core.IsLanguageDependent" /> </Term>
Resolution:

Hide

Accepted: https://www.oasis-open.org/committees/download.php/49055/odata-meeting-35_on-20130502-minutes.html#odata-360

Show
Accepted: https://www.oasis-open.org/committees/download.php/49055/odata-meeting-35_on-20130502-minutes.html#odata-360

OData V1 introduced a <Documentation> element in order to annotate a model element with a description.

This is an ideal application of annotations, we just didn't have one defined at the time.

We should not get rid of the <documentation> element and instead define a documentation annotation in the core vocabulary.