Skip to content

Commit

Permalink
update version identifier syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
ahwagner committed Dec 16, 2024
1 parent d373353 commit 93489c0
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/source/appendices/design_decisions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,18 @@ As an example, the Github JSON Schema URL ($id) for the VRS 2.0.0 Allele is:
}
During the **release and versioning** discussion at the GA4GH Connect April 2023 meeting the proposal
delved into the idea of including the major version number in the VRS identifier itself. Concern for the
change in digests (and their derived identifiers) between major versions of the same VRS object will
be clearly visible in the identifier itself if the major version is included in the identifier.

The trade-off is that new identifiers would be required for every type of VRS object for every major
version release. Meaning that even if a given type of object has no change that would result in a new
digest, a new identifier would still be required for the new major version.

After much discussion, the decision was made to not include the major version number in the VRS identifier
itself. Therefore, the :ref:`identifier-construction` does NOT contain the version number as follows:
delved into the idea of including the major version number in the VRS identifier itself. Proponents of
this approach cited concern for the change in digests (and their derived identifiers) between major
versions of the same VRS object, which would become clearly visible in the identifier itself if the
major version was included.

Opponents of this approach argued that new identifiers would be required for every type of VRS object
for every major version release. Meaning that even if a given type of object has no change that would
result in a new digest, a new identifier would still be required for the new major version.

After much discussion, the decision was made to NOT include the major version number in the VRS identifier
itself. Therefore, the :ref:`identifier-construction` does NOT contain the version number, resulting in
the following syntax:

**CURIE namespace resolution**

Expand Down

0 comments on commit 93489c0

Please sign in to comment.