update schema guidance for start/end

ga4gh · Dec 16, 2024 · d9450f4 · d9450f4
1 parent de029e5
commit d9450f4
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/schema/vrs/def/SequenceLocation.rst b/schema/vrs/def/SequenceLocation.rst
@@ -86,12 +86,12 @@ Some SequenceLocation attributes are inherited from :ref:`Ga4ghIdentifiableObjec
       - 
       - integer | :ref:`Range`
       - 0..1
-      - The start coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. MUST represent a coordinate or range less than or equal to the value of `end`.
+      - The start coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. For locations on linear sequences, this MUST represent a coordinate or range  less than or equal to the value of `end`. For circular sequences, `start` is greater than `end` when the location spans the sequence 0 coordinate.
    *  - end
       - 
       - integer | :ref:`Range`
       - 0..1
-      - The end coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. MUST represent a coordinate or range greater than or equal to the value of `start`.
+      - The end coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. For locations on linear sequences, this MUST represent a coordinate or range  grater than or equal to the value of `start`. For circular sequences, `end` is less than `start` when the location spans the sequence 0 coordinate.
    *  - sequence
       - 
       - :ref:`sequenceString`

diff --git a/schema/vrs/json/SequenceLocation b/schema/vrs/json/SequenceLocation
@@ -76,7 +76,7 @@
                "type": "integer"
             }
          ],
-         "description": "The start coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. MUST represent a coordinate or range less than or equal to the value of `end`."
+         "description": "The start coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. For locations on linear sequences, this MUST represent a coordinate or range  less than or equal to the value of `end`. For circular sequences, `start` is greater than `end` when the location spans the sequence 0 coordinate."
       },
       "end": {
          "oneOf": [
@@ -87,7 +87,7 @@
                "type": "integer"
             }
          ],
-         "description": "The end coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. MUST represent a coordinate or range greater than or equal to the value of `start`."
+         "description": "The end coordinate or range of the SequenceLocation. The minimum value of this coordinate or range is 0. For locations on linear sequences, this MUST represent a coordinate or range  grater than or equal to the value of `start`. For circular sequences, `end` is less than `start` when the location spans the sequence 0 coordinate."
       },
       "sequence": {
          "description": "The literal sequence encoded by the `sequenceReference` at these coordinates.",

diff --git a/schema/vrs/vrs-source.yaml b/schema/vrs/vrs-source.yaml
@@ -304,15 +304,19 @@ $defs:
         description: >-
           The start coordinate or range of the SequenceLocation.
           The minimum value of this coordinate or range is 0.
-          MUST represent a coordinate or range less than or equal to the value of `end`.
+          For locations on linear sequences, this MUST represent a coordinate or range 
+          less than or equal to the value of `end`. For circular sequences, `start` is
+          greater than `end` when the location spans the sequence 0 coordinate.
       end:
         oneOf:
           - type: integer
           - $ref: "#/$defs/Range"
         description: >-
           The end coordinate or range of the SequenceLocation.
           The minimum value of this coordinate or range is 0.
-          MUST represent a coordinate or range greater than or equal to the value of `start`.
+          For locations on linear sequences, this MUST represent a coordinate or range 
+          grater than or equal to the value of `start`. For circular sequences, `end` is
+          less than `start` when the location spans the sequence 0 coordinate.
       sequence:
         description: >-
           The literal sequence encoded by the `sequenceReference` at these coordinates.