Skip to content

Commit

Permalink
... more try-outs
Browse files Browse the repository at this point in the history
testing ideas for more VRS compatibility - absolute WiP!
  • Loading branch information
mbaudis committed Nov 18, 2024
1 parent fed7fc9 commit f3a0720
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 15 deletions.
File renamed without changes.
File renamed without changes.
41 changes: 41 additions & 0 deletions schemas/LegacyRangeRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
$schema: https://json-schema.org/draft/2020-12/schema
$id: https://genomebeacons.org/schemas/beacon/BeaconRangeRequest/v1.1.0
title: VariantRangeRequest
description: >-
A request for matching variants in a genomic range. This request type requires
to provide *exactly* 1 `start` and 1 `end` position, which are both 0-based and
define the base range with which variants should be associated. The exact way
of variant association (e.g. complete or partial overlap or even proximity) is
being left to the individual implementations and use cases.
Beacon version: v2.0
Future considerations: There are some inherited ambiguities
* `assemblyId` and `referenceName` should be deprectated in favour of a versioned
`sequenceId`
* the shared use of the `start` and `end` parameters for both base positions and
bracket positions is not ideal - here addressed by the `sequencePosition` type
but still existing in parameters
type: object
required:
- referenceName
- start
- end

properties:
referenceName:
$ref: variantRequestParameters.yaml#/$defs/referenceName
start:
$ref: variantRequestParameters.yaml#/$defs/sequencePosition
end:
$ref: variantRequestParameters.yaml#/$defs/sequencePosition
alternateBases:
$ref: variantRequestParameters.yaml#/$defs/alternateBases
variantType:
$ref: variantRequestParameters.yaml#/$defs/variantType
assemblyId:
$ref: variantRequestParameters.yaml#/$defs/assemblyId

examples:
- referenceName: 17
assemblyId: GRCh38
start: [7572826]
end: [7579005]
23 changes: 9 additions & 14 deletions schemas/VariantRangeRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,27 @@ description: >-
define the base range with which variants should be associated. The exact way
of variant association (e.g. complete or partial overlap or even proximity) is
being left to the individual implementations and use cases.
Beacon version: v2.0
Future considerations: There are some inherited ambiguities
* `assemblyId` and `referenceName` should be deprectated in favour of a versioned
Beacon version: v2.n
There are some inherited ambiguities
* referenceName` should be deprectated in favour of a versioned
`sequenceId`
* the shared use of the `start` and `end` parameters for both base positions and
bracket positions is not ideal - here addressed by the `sequencePosition` type
but still existing in parameters
type: object
required:
- referenceName
- start
- end
- sequenceId
- sequenceInterval

properties:
referenceName:
sequenceId:
$ref: variantRequestParameters.yaml#/$defs/referenceName
start:
$ref: variantRequestParameters.yaml#/$defs/sequencePosition
end:
$ref: variantRequestParameters.yaml#/$defs/sequencePosition
alternateBases:
sequenceInterval:
$ref: variantRequestParameters.yaml#/$defs/sequenceInterval
sequence:
$ref: variantRequestParameters.yaml#/$defs/alternateBases
variantType:
$ref: variantRequestParameters.yaml#/$defs/variantType
assemblyId:
$ref: variantRequestParameters.yaml#/$defs/assemblyId

examples:
- referenceName: 17
Expand Down
2 changes: 1 addition & 1 deletion schemas/variantRequestParameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ $defs:
minItems: 1
maxItems: 1

sequenceBracket:
sequenceInterval:
description:
This is an explicit 2-values version of the `basePositions` generic, for use
in e.g. `VariantBracketRequest`.
Expand Down

0 comments on commit f3a0720

Please sign in to comment.