gchq / event-logging-schema

Event Logging is an XML Schema for describing the auditable events generated by computer systems, hardware devices and access control systems
Apache License 2.0
25 stars 6 forks source link

VersionSimpleType's enumeration attribute should be changed to 3.1.0 for the 3.1.0 version #18

Closed burnalting closed 7 years ago

burnalting commented 7 years ago

The restriction/enumeration value attribute should change from 3.0.0 to 3.1.0 or remove the enumeration. IE Change

 <xs:simpleType name="VersionSimpleType">
        <xs:annotation>
            <xs:documentation>Type for specifying version numbers in a common way, e.g. 2.4</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:pattern value="[0-9]+(\.[0-9]+)*"/>
            <xs:enumeration value="3.0.0"/>
        </xs:restriction>
    </xs:simpleType>

to

 <xs:simpleType name="VersionSimpleType">
        <xs:annotation>
            <xs:documentation>Type for specifying version numbers in a common way, e.g. 2.4</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:pattern value="[0-9]+(\.[0-9]+)*"/>
            <xs:enumeration value="3.1.0"/>
        </xs:restriction>
    </xs:simpleType>
burnalting commented 7 years ago

Should we set the enumeration to have multiple values for the 3.x.x series of schemas? That way we are applying a generic restriction but against the series ... otherwise why have a single entry enumeration?

Thoughts?

at055612 commented 7 years ago

After a discussion we agreed that a schema with version a.b.c should contain enumerations for all released versions that came before it with the same major version number, e.g. enumeration values that conform to:

major = a, minor <= b

This assumes that minor and patch versions do not introduce breaking changes so a version 3.1.1 schema can be used to validate an xml document written to conform to the 3.0.0 schema.