VQS parameters

ga4gh-beacon · Feb 6, 2025 · d2035af · d2035af
1 parent 897f84d
commit d2035af
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 3 deletions.
diff --git a/docs/generated/requestProfiles_VQSrequest.md b/docs/generated/requestProfiles_VQSrequest.md
@@ -1,7 +1,67 @@
-# Beacon VQS Request Examples
+# Beacon VQS Requests
 
 This represents the generic collection of variant parameters supported in Beacon v2+ requests.
 
+* `assemblyId`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/Assembly`    
+* `referenceName`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/RefSeqId`    
+* `referenceBases`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/ReferenceBases`    
+* `alternateBases`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/AlternateBases`    
+* `variantType`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/VariantType`    
+* `start`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/Start`    
+* `end`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/End`    
+* `geneId`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/GeneId`    
+* `aminoacidChange`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/AminoacidChange`    
+* `genomicAlleleShortForm`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/GenomicAlleleShortForm`    
+* `variantMinLength`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/VariantMinLength`    
+* `variantMaxLength`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/VariantMaxLength`    
+* `requestProfileId`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/RequestProfileId`    
+* `referenceAccession`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/RefgetAccession`    
+* `start`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/SequenceStart`    
+* `end`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/SequenceEnd`    
+* `sequence`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/Sequence`    
+* `copyChange`:    
+    - `$ref`: `./common/requestParameterComponents.yaml#/$defs/CopyChange`    
+* `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`    
+
+
+## Beacon v2+/VQS "VRSified" Request Examples
+
 
 
 ### Query for a focal deletion involving TP53

diff --git a/docs/generated/requestProfiles_g_variant.md b/docs/generated/requestProfiles_g_variant.md
@@ -32,8 +32,6 @@ This represents the generic collection of variant parameters allowed in Beacon v
 
 ## Beacon v2 Request Examples
 
-This represents the generic collection of variant parameters allowed in Beacon v2 requests.
-
 
 
 ### Find small, _variable_ sequence insertions/deletions at an approximate position
Original file line number	Diff line number	Diff line change
Expand Up		@@ -32,8 +32,6 @@ This represents the generic collection of variant parameters allowed in Beacon v

		## Beacon v2 Request Examples

		This represents the generic collection of variant parameters allowed in Beacon v2 requests.



		### Find small, _variable_ sequence insertions/deletions at an approximate position
Expand Down