Skip to content

Commit

Permalink
feat: add Expression (#10)
Browse files Browse the repository at this point in the history
* feat: add Expression
* chore: remove .readthedocs.yaml (#11)
  * not used at the moment
  • Loading branch information
korikuzma authored and larrybabb committed Jun 12, 2024
1 parent 5dfbd8c commit 4c487b1
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 13 deletions.
13 changes: 0 additions & 13 deletions .readthedocs.yaml

This file was deleted.

19 changes: 19 additions & 0 deletions schema/gks-common/common-source.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,22 @@ $defs:
type: string
heritableRequired:
- type

Expression:
type: object
maturity: draft
description: >-
Representation of a variation by a specified nomenclature or syntax for a Variation object.
Common examples of expressions for the description of molecular variation include the HGVS
and ISCN nomenclatures.
properties:
syntax:
type: string
enum: ["hgvs.c", "hgvs.p", "hgvs.g", "hgvs.m", "hgvs.n", "hgvs.r", "iscn", "gnomad", "spdi"]
value:
type: string
syntax_version:
type: string
required:
- syntax
- value
28 changes: 28 additions & 0 deletions schema/gks-common/def/Expression.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
**Computational Definition**

Representation of a variation by a specified nomenclature or syntax for a Variation object. Common examples of expressions for the description of molecular variation include the HGVS and ISCN nomenclatures.

**Information Model**

.. list-table::
:class: clean-wrap
:header-rows: 1
:align: left
:widths: auto

* - Field
- Type
- Limits
- Description
* - syntax
- string
- 1..1
-
* - value
- string
- 1..1
-
* - syntax_version
- string
- 0..1
-
35 changes: 35 additions & 0 deletions schema/gks-common/json/Expression
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://w3id.org/ga4gh/schema/gks-common/1.x/json/Expression",
"title": "Expression",
"type": "object",
"maturity": "draft",
"description": "Representation of a variation by a specified nomenclature or syntax for a Variation object. Common examples of expressions for the description of molecular variation include the HGVS and ISCN nomenclatures.",
"properties": {
"syntax": {
"type": "string",
"enum": [
"hgvs.c",
"hgvs.p",
"hgvs.g",
"hgvs.m",
"hgvs.n",
"hgvs.r",
"iscn",
"gnomad",
"spdi"
]
},
"value": {
"type": "string"
},
"syntax_version": {
"type": "string"
}
},
"required": [
"syntax",
"value"
],
"additionalProperties": false
}

0 comments on commit 4c487b1

Please sign in to comment.