[OASIS Issue Tracker] (ODATA-1058) Add ability to annotate revisions with information on all elements

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

     [ https://issues.oasis-open.org/browse/ODATA-1058?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Pizzo updated ODATA-1058:
---------------------------------

    Proposal: 

The proposal is to create a 'Revision' term in the Core vocabulary that may be applied to any element.  Elements defined in a schema may then evolve over time and with their complete revision history intact. The proposal is as follows:
			<Term Name="Revision"  Type="Collection(CsdlMetamodel.RevisionType)">
				<Annotation Term="OData.Description" String="Defines an annotation to mark a revision." />
			</Term>

The members of the collection are sequential.
			
			<ComplexType Name="RevisionType">
				<Property Name="Version" Type="Edm.String">
					<Annotation Term="OData.Description" String="An 'm.n.e' string value composed of three decimal values separated by '.'.  These values express major, minor, and errata version numbers for this revision where 'm' is an integer representing a major version.  Major versions are expected to provide similar but extended functionality, but may be incompatible in any way. The minor version 'n' may include additional features and may not remove any features from previous minor versions of the same major version.  The set of allowable values must include all allowable values of previous minor versions of the same major version. The errata version 'e' is used to mark a change that fixes something that was broken in the including minor version.  By its nature, an errata version may include incompatible changes to fix a prior version."/>
				</Property>
				<Property Name="Kind" Type="CsdlMetamodel.RevisionKind">
					<Annotation Term="Core.Description" String="An enumerated value expressing the type of revision." />
				</Property>
				<Property Name="Description" Type="String">
					<Annotation Term="Core.Description" String="Text description of the reason for the revision." />
				</Property>
			</ComplexType>
			
			<EnumType Name="RevisionKind">
				<Member Name="Added"/>
				<Member Name="Modified"/>
				<Member Name="Deprecated"/>
			</EnumType>


  was:
The proposal is to create a 'Revision' term in the Core vocabulary that may be applied to any element.  Elements defined in a schema may then evolve over time and with their complete revision history intact. The proposal is as follows:
			<Term Name="Revision"  Type="CsdlMetamodel.RevisionType">
				<Annotation Term="OData.Description" String="Defines an annotation to mark a revision." />
			</Term>
			
			<ComplexType Name="RevisionType">
				<Property Name="Version" Type="Edm.String">
					<Annotation Term="OData.Description" String="An 'm.n.e' string value composed of three decimal values separated by '.'.  These values express major, minor, and errata version numbers for this revision where 'm' is an integer representing a major version.  Major versions are expected to provide similar but extended functionality, but may be incompatible in any way. The minor version 'n' may include additional features and may not remove any features from previous minor versions of the same major version.  The set of allowable values must include all allowable values of previous minor versions of the same major version. The errata version 'e' is used to mark a change that fixes something that was broken in the including minor version.  By its nature, an errata version may include incompatible changes to fix a prior version."/>
				</Property>
				<Property Name="Type" Type="CsdlMetamodel.RevisionKind">
					<Annotation Term="Core.Description" String="An enumerated value expressing the type of revision." />
				</Property>
				<Property Name="Description" Type="String">
					<Annotation Term="Core.Description" String="Text description of the reason for the revision." />
				</Property>
			</ComplexType>
			
			<EnumType Name="RevisionKind">
				<Member Name="Add"/>
				<Member Name="Insert"/>
				<Member Name="Change"/>
				<Member Name="Delete"/>
				<Member Name="Deprecate"/>
			</EnumType>



> Add ability to annotate revisions with information on all elements
> ------------------------------------------------------------------
>
>                 Key: ODATA-1058
>                 URL: https://issues.oasis-open.org/browse/ODATA-1058
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: New Feature
>          Components: Vocabularies
>    Affects Versions: V4.01_CSD01
>         Environment: Schema declarations
>            Reporter: George Ericson
>            Assignee: George Ericson
>              Labels: Extension, Practices, Usability
>             Fix For: V4.01_CSD02
>
>
> Currently there is no defined means to mark revisions to schema.  Some organizations have solved this by convention of creating a new schema for each set of revisions, primarily related only by time.
> Each schema represents a new namespace, so we get a proliferation of namespaces.  Type definitions are specific to namespaces, but since the evolving types really represent the same type declaration, they are sub classed across these namespaces.  This creates an unnecessarily complex model. 



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