Removing references to filteringTerms URL both in EntryTypeDefinition…

…s and in Map
ga4gh-beacon · Oct 11, 2024 · a17c7b0 · a17c7b0
1 parent 2d00f95
commit a17c7b0
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 28 deletions.
diff --git a/framework/json/configuration/beaconMapSchema.json b/framework/json/configuration/beaconMapSchema.json
@@ -1,7 +1,7 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "additionalProperties": true,
-    "definitions": {
+    "$defs": {
         "Endpoint": {
             "properties": {
                 "endpoints": {
@@ -16,11 +16,6 @@
                     "description": "",
                     "type": "string"
                 },
-                "filteringTermsUrl": {
-                    "description": "Optional. Returns the list of filtering terms that could be applied to this entry type. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that endpoint. Also, in very simple Beacons, that endpoint could be the one of the few implemented, together with \u00b4rootUrl` and \u00b4singleEntryUrl`, in which case the whole map of endpoints is found in the current Map.",
-                    "format": "uri-template",
-                    "type": "string"
-                },
                 "openAPIEndpointsDefinition": {
                     "description": "Reference to the file that includes the OpenAPI definition of the endpoints implemented in this Beacon instance. The referenced file MUST BE a valid OpenAPI definition file, as it is expected that the Beacon clients (e.g. a Beacon Network) should be able to parse it to discover additional details on the supported verbs, parameters, etc.",
                     "type": "string"

diff --git a/framework/json/configuration/entryTypeDefinition.json b/framework/json/configuration/entryTypeDefinition.json
@@ -28,11 +28,6 @@
             "description": "A textual description for the element.",
             "type": "string"
         },
-        "filteringTerms": {
-            "$comment": "TO DO: Evaluate switch this to `url` or a more specific way for allowing URLs and local file paths (is this necessary?).",
-            "description": "Reference to the list of filtering terms that could be used to filter records of this entry type in this beacon.",
-            "type": "string"
-        },
         "id": {
             "description": "A unique identifier of the element.",
             "examples": [

diff --git a/framework/src/configuration/beaconMapSchema.yaml b/framework/src/configuration/beaconMapSchema.yaml
@@ -47,15 +47,6 @@ definitions:
           whole map of endpoints is found in the current Map.
         type: string
         format: uri-template
-      filteringTermsUrl:
-        description: Optional. Returns the list of filtering terms that could be applied
-          to this entry type. It is added here for convenience of the Beacon clients,
-          so they don't need to parse the OpenAPI endpoints definition to get that
-          endpoint. Also, in very simple Beacons, that endpoint could be the one of
-          the few implemented, together with ´rootUrl` and ´singleEntryUrl`, in which
-          case the whole map of endpoints is found in the current Map.
-        type: string
-        format: uri-template
       endpoints:
         description: Optional. A list describing additional endpoints implemented
           by this Beacon instance for that entry type. Additional details on the endpoint

diff --git a/framework/src/configuration/entryTypeDefinition.yaml b/framework/src/configuration/entryTypeDefinition.yaml
@@ -57,14 +57,6 @@ properties:
     includedConcepts:
       type: array
       $ref: ../common/basicElement.yaml
-  filteringTerms:
-    description: >-
-      Reference to the list of filtering terms that could be used to filter records
-      of this entry type in this beacon.
-    type: string
-    $comment: >-
-      TO DO: Evaluate switch this to `url` or a more specific way for allowing
-      URLs and local file paths (is this necessary?).
   nonFilteredQueriesAllowed:
     $ref: ../common/beaconCommonComponents.yaml#/definitions/NonFilteredQueriesAllowed
 required: