Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mbaudis committed Feb 5, 2025
1 parent 7eab738 commit 27a3f8d
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
18 changes: 17 additions & 1 deletion docs/generated/requestParameterComponents.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ HGVSId descriptor Origin: Beacon v2.0
### `Range`

#### description
An array of 2 integer sequence positions (0-based, inclusive).
An array of 2 integer values. If referring to sequence positions the "0-based, inclusive" format is used.
**type:** `array`
**items:**
- `type`: `integer`
Expand All @@ -108,6 +108,14 @@ A GA4GH RefGet identifier for the reference sequence, _i.e._ either a computed G
* `refseq:NC_000009.12`
* `ga4gh:SQ.S_KjnFVz-FE7M0W6yoaUDgYxLPc1jyWU`

### `RepeatSubunitLength`

#### description
The number of residues in a repeat subunit. In contrast to the VRS model we allow for range queries (e.g. all repeats with subunits of 1 or 2). Origin: VRS v2
**oneOf:**
* `integer`
* `{'$ref': '#/$defs/Range'}`

### `RequestProfileId`

#### description
Expand All @@ -127,6 +135,14 @@ DNA bases.
Origin: VRS v1.n TODO: Review use of base characters.
**type:** `string`

### `SequenceLength`

#### description
The sequence length when querying the conceptual representation of a sequence according to a VRS `ReferenceLengthExpression` class. Origin: VRS v2
**oneOf:**
* `integer`
* `{'$ref': '#/$defs/Range'}`

### `SequenceStart`

#### description
Expand Down
2 changes: 2 additions & 0 deletions docs/generated/requestProfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ This represents the generic collection of variant parameters supported in Beacon
- `adjacencyAccession`: `'$ref': './common/requestParameterComponents.yaml#/$defs/AdjacencyAccession'`
- `adjacencyStart`: `'$ref': './common/requestParameterComponents.yaml#/$defs/AdjacencyStart'`
- `adjacencyEnd`: `'$ref': './common/requestParameterComponents.yaml#/$defs/AdjacencyEnd'`
- `repeatSubunitLength`: `'$ref': './common/requestParameterComponents.yaml#/$defs/RepeatSubunitLength'`
- `geneId`: `'$ref': './common/requestParameterComponents.yaml#/$defs/GeneId'`
- `aminoacidChange`: `'$ref': './common/requestParameterComponents.yaml#/$defs/AminoacidChange'`
- `genomicAlleleShortForm`: `'$ref': './common/requestParameterComponents.yaml#/$defs/GenomicAlleleShortForm'`
- `sequenceLength`: `'$ref': './common/requestParameterComponents.yaml#/$defs/SequenceLength'`
- `variantMinLength`: `'$ref': './common/requestParameterComponents.yaml#/$defs/VariantMinLength'`
- `variantMaxLength`: `'$ref': './common/requestParameterComponents.yaml#/$defs/VariantMaxLength'`

Expand Down
2 changes: 1 addition & 1 deletion docs/query-solutions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The current version of query examples for the Beacon v2 parameters (_i.e._ not
using additional parameters beyond the specification) can be found in
**[Beacon v2 Examples](/generated/requestProfiles_g_variant)**.
**[Beacon v2 Examples](./generated/requestProfiles_g_variant)**.

<!--
TODO:
Expand Down

0 comments on commit 27a3f8d

Please sign in to comment.