From e2190ef3a9248c63f2963f4fb568a7190990dfec Mon Sep 17 00:00:00 2001 From: redmitry Date: Tue, 5 Sep 2023 11:15:17 +0200 Subject: [PATCH 1/3] add scopes[] to the FilteringTerm --- .../sections/beaconFilteringTermsResults.json | 10 ++++++++++ .../sections/beaconFilteringTermsResults.yaml | 8 ++++++++ 2 files changed, 18 insertions(+) diff --git a/framework/json/responses/sections/beaconFilteringTermsResults.json b/framework/json/responses/sections/beaconFilteringTermsResults.json index e7a0ab74a..daaf0fc92 100644 --- 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 index 4c3bd96c3..ff1474355 100644 --- 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: >- From edf561ed1a4c612efd3921beecbb5f6378c684f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oriol=20L=C3=B3pez-Doriga?= Date: Wed, 20 Mar 2024 16:02:44 +0100 Subject: [PATCH 2/3] filtering terms results example listed --- .../sections/beaconFilteringTermsResults.json | 2 +- .../sections/beaconFilteringTermsResults.yaml | 13 ++++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/framework/json/responses/sections/beaconFilteringTermsResults.json b/framework/json/responses/sections/beaconFilteringTermsResults.json index daaf0fc92..29a1761bd 100644 --- a/framework/json/responses/sections/beaconFilteringTermsResults.json +++ b/framework/json/responses/sections/beaconFilteringTermsResults.json @@ -30,7 +30,7 @@ "type": "string" }, "scopes": { - "description": "Entry types this filter may be applied to.", + "description": "Entry types affected by this filter.", "examples": [ "[\"individual\", \"biosample\"]" ], diff --git a/framework/src/responses/sections/beaconFilteringTermsResults.yaml b/framework/src/responses/sections/beaconFilteringTermsResults.yaml index ff1474355..5c4ddec4a 100644 --- a/framework/src/responses/sections/beaconFilteringTermsResults.yaml +++ b/framework/src/responses/sections/beaconFilteringTermsResults.yaml @@ -48,9 +48,16 @@ definitions: - 'Aplasia/Hypoplasia of the middle ear' scopes: description: >- - Entry types this filter may be applied to. - examples: - - '["individual", "biosample"]' + Entry types affected by this filter. + examples: + - + - individual + - biosample + - analysis + - run + - genomicVariation + - + - biosample type: array items: type: string From 1447418ae20062d48c6644b705a4e0c31b8355af Mon Sep 17 00:00:00 2001 From: Dmitry Repchevsky Date: Wed, 20 Mar 2024 16:28:22 +0100 Subject: [PATCH 3/3] fix "examples" beaconFilteringTermsResults.json should be an array of arrays... --- .../json/responses/sections/beaconFilteringTermsResults.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/framework/json/responses/sections/beaconFilteringTermsResults.json b/framework/json/responses/sections/beaconFilteringTermsResults.json index 29a1761bd..a821680e8 100644 --- a/framework/json/responses/sections/beaconFilteringTermsResults.json +++ b/framework/json/responses/sections/beaconFilteringTermsResults.json @@ -32,7 +32,8 @@ "scopes": { "description": "Entry types affected by this filter.", "examples": [ - "[\"individual\", \"biosample\"]" + ["individual", "biosample", "analysis", "run", "genomicVariation"], + ["biosample"] ], "type": "array", "items": { @@ -114,4 +115,4 @@ } }, "type": "object" -} \ No newline at end of file +}