fixing the ontology term CUSTOM format

This is a pure documentation change for the handover format. Addresses #83
ga4gh-beacon · Jun 10, 2023 · 11312cd · 11312cd
1 parent 8065376
commit 11312cd
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 11 deletions.
diff --git a/framework/json/common/beaconCommonComponents.json b/framework/json/common/beaconCommonComponents.json
@@ -111,15 +111,19 @@
         },
         "HandoverType": {
             "$ref": "./ontologyTerm.json",
-            "description": "Handover type, as an Ontology_term object with CURIE syntax for the `id` value. Use `CUSTOM` for the `id` when no ontology is available.",
+            "description": "Handover type, as an Ontology_term object with CURIE syntax for the `id` value. Use \"CUSTOM:123455\" CURIE-style `id` when no ontology is available.",
             "examples": [
                 {
-                    "id": "EFO:0004157",
-                    "label": "BAM format"
+                    "id": "EDAM:2572",
+                    "label": "BAM"
                 },
                 {
-                    "id": "CUSTOM",
-                    "label": "download genomic variants in .pgxseg file format"
+                    "id": "EDAM:3016",
+                    "label": "VCF"
+                },
+                {
+                    "id": "CUSTOM:pgxseg",
+                    "label": "genomic variants in .pgxseg file format"
                 }
             ]
         },

diff --git a/framework/src/common/beaconCommonComponents.yaml b/framework/src/common/beaconCommonComponents.yaml
@@ -265,11 +265,13 @@ definitions:
         example: https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/
   HandoverType:
     description: >-
-      Handover type, as an Ontology_term object with CURIE syntax for the `id` value.
-      Use `CUSTOM` for the `id` when no ontology is available.
+      Handover type, as an Ontology_term object with CURIE syntax for the `id`
+      value. Use "CUSTOM:123455" CURIE-style `id` when no ontology is available.
     $ref: ./ontologyTerm.yaml
     examples:
-      - id: EFO:0004157
-        label: BAM format
-      - id: CUSTOM
-        label: download genomic variants in .pgxseg file format
+      - id: EDAM:2572
+        label: BAM
+      - id: EDAM:3016
+        label: VCF
+      - id: CUSTOM:pgxseg
+        label: genomic variants in .pgxseg file format