Merge pull request #109 from redmitry/FileringTerm.scopes

add scopes[] to the FilteringTerm
ga4gh-beacon · Jan 10, 2024 · e2d7941 · e2d7941
2 parents e7d7962 + e2190ef
commit e2d7941
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/framework/json/responses/sections/beaconFilteringTermsResults.json b/framework/json/responses/sections/beaconFilteringTermsResults.json
@@ -28,6 +28,16 @@
                         "alphanumeric"
                     ],
                     "type": "string"
+                },
+                "scopes": {
+                    "description": "Entry types this filter may be applied to.",
+                    "examples": [
+                        "[\"individual\", \"biosample\"]"
+                    ],
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
                 }
             },
             "required": [

diff --git a/framework/src/responses/sections/beaconFilteringTermsResults.yaml b/framework/src/responses/sections/beaconFilteringTermsResults.yaml
@@ -46,6 +46,14 @@ definitions:
         examples:
           - 'B Lymphoblastic Leukemia/Lymphoma'
           - 'Aplasia/Hypoplasia of the middle ear'
+      scopes:
+        description: >- 
+          Entry types this filter may be applied to.
+        examples:
+          - '["individual", "biosample"]'
+        type: array
+        items:
+          type: string
   Resource:
     type: object
     description: >-