Merge branch 'develop' into website-docs

ga4gh-beacon · May 3, 2024 · 7de0b56 · 7de0b56
2 parents f5be698 + db307ba
commit 7de0b56
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 3 deletions.
diff --git a/framework/json/responses/sections/beaconFilteringTermsResults.json b/framework/json/responses/sections/beaconFilteringTermsResults.json
@@ -28,6 +28,17 @@
                         "alphanumeric"
                     ],
                     "type": "string"
+                },
+                "scopes": {
+                    "description": "Entry types affected by this filter.",
+                    "examples": [
+                        ["individual", "biosample", "analysis", "run", "genomicVariation"], 
+                        ["biosample"]
+                    ],
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
                 }
             },
             "required": [
@@ -104,4 +115,4 @@
         }
     },
     "type": "object"
-}
+}
diff --git a/framework/src/responses/sections/beaconFilteringTermsResults.yaml b/framework/src/responses/sections/beaconFilteringTermsResults.yaml
@@ -46,6 +46,21 @@ definitions:
         examples:
           - 'B Lymphoblastic Leukemia/Lymphoma'
           - 'Aplasia/Hypoplasia of the middle ear'
+      scopes:
+        description: >- 
+          Entry types affected by this filter.
+        examples: 
+          - 
+            - individual 
+            - biosample 
+            - analysis 
+            - run 
+            - genomicVariation 
+          - 
+            - biosample
+        type: array
+        items:
+          type: string
   Resource:
     type: object
     description: >-

diff --git a/models/json/beacon-v2-default-model/common/age.json b/models/json/beacon-v2-default-model/common/age.json
@@ -3,11 +3,14 @@
     "description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
     "properties": {
         "iso8601duration": {
-            "description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
+            "description": "Represents age as a ISO8601 duration (e.g., 'P40Y10M05D').",
             "example": "P32Y6M1D",
             "type": "string"
         }
     },
+    "required": [
+        "iso8601duration"
+    ],
     "title": "Age",
     "type": "object"
-}
+}
diff --git a/models/json/beacon-v2-default-model/common/ageRange.json b/models/json/beacon-v2-default-model/common/ageRange.json
@@ -11,6 +11,10 @@
             "description": "Represents age as an ISO8601 duration (e.g., P18Y)."
         }
     },
+    "required": [
+        "end",
+        "start"
+    ],
     "title": "AgeRange",
     "type": "object"
 }
diff --git a/models/src/beacon-v2-default-model/common/age.yaml b/models/src/beacon-v2-default-model/common/age.yaml
@@ -7,3 +7,5 @@ properties:
     description: Represents age as a ISO8601 duration (e.g., P40Y10M05D).
     type: string
     example: P32Y6M1D
+required:
+  - iso8601duration
diff --git a/models/src/beacon-v2-default-model/common/ageRange.yaml b/models/src/beacon-v2-default-model/common/ageRange.yaml
@@ -9,3 +9,6 @@ properties:
   end:
     description: Represents age as an ISO8601 duration (e.g., P59Y).
     $ref: ./age.yaml
+required:
+  - start
+  - end