From 5b47a87236b304317ad1964d7a81c0a1f48f7a5a Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Sat, 17 Jun 2023 17:42:10 -0700 Subject: [PATCH 1/5] Update entryTypeDefinition.yaml The parameter descriptions in the EntryTypeDefinitions schema seem somewhat hard to parse and potentially misleading - this is a go at cleaning them up a bit. --- .../configuration/entryTypeDefinition.yaml | 51 +++++++++---------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/framework/src/configuration/entryTypeDefinition.yaml b/framework/src/configuration/entryTypeDefinition.yaml index 99f3ef974..4ca04013f 100644 --- a/framework/src/configuration/entryTypeDefinition.yaml +++ b/framework/src/configuration/entryTypeDefinition.yaml @@ -1,23 +1,22 @@ $schema: https://json-schema.org/draft/2020-12/schema title: '' -description: "Definition of an element or entry type including the Beacon v2 required\ - \ and suggested attributes. This schema purpose is to describe each type of entities\ - \ included in a Beacon, hence Beacon clients could have some metadata about such\ - \ entities.\n\nThe `id` attribute is the key that should be used in other parts\ - \ of the Beacon Model to allow Beacon clients to identify the different parts (e.g.\ - \ endpoints, filteringTerms, request parameters, etc.) that fully describe an entry\ - \ type." +description: >- + Definition of an element or entity, to describe each type of entity included in + a beacon. + The `id` attribute is the key that should be used in other parts of the data model + to allow Beacon clients to identify the different parts (e.g. endpoints, filteringTerms, + request parameters, etc.) that relvant for an entity. type: object -$comment: 'TO DO: The tagged parts should reference to `common/ontologizedElement.json`. - But that configuration fails to validate. Further investigation is required, but - should not affect the resulting schema.' properties: $schema: $ref: ../common/beaconCommonComponents.yaml#/definitions/$schema id: - $comments: ++++++ THIS IS THE START OF THE ontologized element ++++++ type: string description: A (unique) identifier of the element. + examples: + - biosample + - individual + - dataset name: type: string description: A distinctive name for the element. @@ -26,7 +25,6 @@ properties: description: A textual description for the element. ontologyTermForThisType: $ref: ../common/ontologyTerm.yaml - $comments: ++++++ THIS IS THE END OF THE ontologized element ++++++ partOfSpecification: description: This is label to group together entry types that are part of the same specification. @@ -42,25 +40,26 @@ properties: items: $ref: ../common/referenceToAnSchema.yaml aCollectionOf: - description: If the entry type is a collection of other entry types, (e.g. a Dataset - is a collection of Records), then this attribute must list the entry types that - could be included. One collection type could be defined as included more than - one entry type (e.g. a Dataset could include Individuals or Genomic Variants), - in such cases the entries are alternative, meaning that a given instance of - this entry type could be of only one of the types (e.g. a given Dataset contains - Individuals, while another Dataset could contain Genomic Variants, but not both - at once). + description: >- + If the entry type is a collection of other entities, (e.g. a Dataset + is a collection of Records), then this attribute must list the entities that + can be included. One _collection_ can include more than one entity + (e.g. a Dataset in teh Beacon cdefault model could include Individuals, Biosamples, + GenomicVariations, Analyses amnd Runs). In such cases in each individual + response (e.g. `resultSetsResponse` of collections of type "dataset") will + contain entries of a single entity type (e.g. biosamples) even if a dataset + may contain records of multiple types. includedConcepts: type: array $ref: ../common/basicElement.yaml filteringTerms: - description: Reference to the file with the list of filtering terms that could - be used to filter this concept in this instance of Beacon. The referenced file - could be used to populate the `filteringTerms`endpoint. Having it independently - should allow for updating the list of accepted filtering terms when it is necessary. + description: >- + Reference to the list of filtering terms that could be used to filter records + of this entity in this beacon. type: string - $comment: "TO DO: Double-check the proper way of referencing a path or relative\ - \ path. 'format: uri' is throwing validation errors for relative file paths" + $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: From 6aeb06ffebea6284c7b57f569b981bd08d4a081c Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:11:35 +0200 Subject: [PATCH 2/5] Update entryTypeDefinition.json --- .../json/configuration/entryTypeDefinition.json | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/framework/json/configuration/entryTypeDefinition.json b/framework/json/configuration/entryTypeDefinition.json index 434bebcf6..13c094cc1 100644 --- a/framework/json/configuration/entryTypeDefinition.json +++ b/framework/json/configuration/entryTypeDefinition.json @@ -1,14 +1,13 @@ { - "$comment": "TO DO: The tagged parts should reference to `common/ontologizedElement.json`. But that configuration fails to validate. Further investigation is required, but should not affect the resulting schema.", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true, - "description": "Definition of an element or entry type including the Beacon v2 required and suggested attributes. This schema purpose is to describe each type of entities included in a Beacon, hence Beacon clients could have some metadata about such entities.\n\nThe `id` attribute is the key that should be used in other parts of the Beacon Model to allow Beacon clients to identify the different parts (e.g. endpoints, filteringTerms, request parameters, etc.) that fully describe an entry type.", + "description": "Definition of an element or entity, to describe each type of entity included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filteringTerms, request parameters, etc.) that relvant for an entity.", "properties": { "$schema": { "$ref": "../common/beaconCommonComponents.json#/definitions/$schema" }, "aCollectionOf": { - "description": "If the entry type is a collection of other entry types, (e.g. a Dataset is a collection of Records), then this attribute must list the entry types that could be included. One collection type could be defined as included more than one entry type (e.g. a Dataset could include Individuals or Genomic Variants), in such cases the entries are alternative, meaning that a given instance of this entry type could be of only one of the types (e.g. a given Dataset contains Individuals, while another Dataset could contain Genomic Variants, but not both at once).", + "description": "If the entry type is a collection of other entities, (e.g. a Dataset is a collection of Records), then this attribute must list the entities that can be included. One _collection_ can include more than one entity (e.g. a Dataset in teh Beacon cdefault model could include Individuals, Biosamples, GenomicVariations, Analyses amnd Runs). In such cases in each individual response (e.g. `resultSetsResponse` of collections of type \"dataset\") will contain entries of a single entity type (e.g. biosamples) even if a dataset may contain records of multiple types.", "includedConcepts": { "$ref": "../common/basicElement.json", "type": "array" @@ -30,13 +29,17 @@ "type": "string" }, "filteringTerms": { - "$comment": "TO DO: Double-check the proper way of referencing a path or relative path. 'format: uri' is throwing validation errors for relative file paths", - "description": "Reference to the file with the list of filtering terms that could be used to filter this concept in this instance of Beacon. The referenced file could be used to populate the `filteringTerms`endpoint. Having it independently should allow for updating the list of accepted filtering terms when it is necessary.", + "$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 entity in this beacon.", "type": "string" }, "id": { - "$comments": "++++++ THIS IS THE START OF THE ontologized element ++++++", "description": "A (unique) identifier of the element.", + "examples": [ + "biosample", + "individual", + "dataset" + ], "type": "string" }, "name": { @@ -47,7 +50,6 @@ "$ref": "../common/beaconCommonComponents.json#/definitions/NonFilteredQueriesAllowed" }, "ontologyTermForThisType": { - "$comments": "++++++ THIS IS THE END OF THE ontologized element ++++++", "$ref": "../common/ontologyTerm.json" }, "partOfSpecification": { From d3f7a9262e0b93d1e562f6fd2979d04cca1b941d Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:26:37 +0200 Subject: [PATCH 3/5] removed ontologyTermForThisType requirement It is not clear how to use ontologyTermForThisType w/o examples (i.e. terms for biosample, individual... - added some but incomplete...) and there is also a logical duplication having a "unique" id and an ontology term. Overall this should be clarified but the current modification seems (a) sensible (step). --- .../json/configuration/entryTypeDefinition.json | 17 +++++++++++++---- .../src/configuration/entryTypeDefinition.yaml | 12 ++++++++---- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/framework/json/configuration/entryTypeDefinition.json b/framework/json/configuration/entryTypeDefinition.json index 13c094cc1..400fdb004 100644 --- a/framework/json/configuration/entryTypeDefinition.json +++ b/framework/json/configuration/entryTypeDefinition.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true, - "description": "Definition of an element or entity, to describe each type of entity included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filteringTerms, request parameters, etc.) that relvant for an entity.", + "description": "Definition of an element or entity, to describe each type of entity included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering terms, request parameters, etc.) that are relvant for an entity.", "properties": { "$schema": { "$ref": "../common/beaconCommonComponents.json#/definitions/$schema" @@ -34,7 +34,7 @@ "type": "string" }, "id": { - "description": "A (unique) identifier of the element.", + "description": "A unique identifier of the element.", "examples": [ "biosample", "individual", @@ -50,7 +50,17 @@ "$ref": "../common/beaconCommonComponents.json#/definitions/NonFilteredQueriesAllowed" }, "ontologyTermForThisType": { - "$ref": "../common/ontologyTerm.json" + "$ref": "../common/ontologyTerm.json", + "examples": [ + { + "id": "EFO:0000542", + "label": "individual" + }, + { + "id": "OBI:0000747", + "label": "material sample" + } + ] }, "partOfSpecification": { "description": "This is label to group together entry types that are part of the same specification.", @@ -61,7 +71,6 @@ "required": [ "id", "name", - "ontologyTermForThisType", "partOfSpecification", "defaultSchema" ], diff --git a/framework/src/configuration/entryTypeDefinition.yaml b/framework/src/configuration/entryTypeDefinition.yaml index 4ca04013f..a101afe75 100644 --- a/framework/src/configuration/entryTypeDefinition.yaml +++ b/framework/src/configuration/entryTypeDefinition.yaml @@ -4,15 +4,15 @@ description: >- Definition of an element or entity, to describe each type of entity included in a beacon. The `id` attribute is the key that should be used in other parts of the data model - to allow Beacon clients to identify the different parts (e.g. endpoints, filteringTerms, - request parameters, etc.) that relvant for an entity. + to allow Beacon clients to identify the different parts (e.g. endpoints, filtering + terms, request parameters, etc.) that are relvant for an entity. type: object properties: $schema: $ref: ../common/beaconCommonComponents.yaml#/definitions/$schema id: type: string - description: A (unique) identifier of the element. + description: A unique identifier of the element. examples: - biosample - individual @@ -25,6 +25,11 @@ properties: description: A textual description for the element. ontologyTermForThisType: $ref: ../common/ontologyTerm.yaml + examples: + - id: EFO:0000542 + label: individual + - id: OBI:0000747 + label: material sample partOfSpecification: description: This is label to group together entry types that are part of the same specification. @@ -65,7 +70,6 @@ properties: required: - id - name - - ontologyTermForThisType - partOfSpecification - defaultSchema additionalProperties: true From dd943aece56a0f814cc1af4272da306e39344c8d Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Mon, 19 Jun 2023 14:43:28 +0200 Subject: [PATCH 4/5] entry type as default instead entity --- .../json/configuration/entryTypeDefinition.json | 6 +++--- framework/src/configuration/entryTypeDefinition.yaml | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/framework/json/configuration/entryTypeDefinition.json b/framework/json/configuration/entryTypeDefinition.json index 400fdb004..b20352764 100644 --- a/framework/json/configuration/entryTypeDefinition.json +++ b/framework/json/configuration/entryTypeDefinition.json @@ -1,13 +1,13 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true, - "description": "Definition of an element or entity, to describe each type of entity included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering terms, request parameters, etc.) that are relvant for an entity.", + "description": "Definition of an element or entry type, to describe each type of entry type included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering terms, request parameters, etc.) that are relvant for an entry type.", "properties": { "$schema": { "$ref": "../common/beaconCommonComponents.json#/definitions/$schema" }, "aCollectionOf": { - "description": "If the entry type is a collection of other entities, (e.g. a Dataset is a collection of Records), then this attribute must list the entities that can be included. One _collection_ can include more than one entity (e.g. a Dataset in teh Beacon cdefault model could include Individuals, Biosamples, GenomicVariations, Analyses amnd Runs). In such cases in each individual response (e.g. `resultSetsResponse` of collections of type \"dataset\") will contain entries of a single entity type (e.g. biosamples) even if a dataset may contain records of multiple types.", + "description": "If the entry type is a collection of other entities, (e.g. a Dataset is a collection of Records), then this attribute must list the entities that can be included. One _collection_ can include more than one entry type (e.g. a Dataset in teh Beacon cdefault model could include Individuals, Biosamples, GenomicVariations, Analyses amnd Runs). In such cases in each individual response (e.g. `resultSetsResponse` of collections of type \"dataset\") will contain entries of a single entry type (e.g. biosamples) even if a dataset may contain records of multiple types.", "includedConcepts": { "$ref": "../common/basicElement.json", "type": "array" @@ -30,7 +30,7 @@ }, "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 entity in this beacon.", + "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": { diff --git a/framework/src/configuration/entryTypeDefinition.yaml b/framework/src/configuration/entryTypeDefinition.yaml index a101afe75..136c2980a 100644 --- a/framework/src/configuration/entryTypeDefinition.yaml +++ b/framework/src/configuration/entryTypeDefinition.yaml @@ -1,11 +1,11 @@ $schema: https://json-schema.org/draft/2020-12/schema title: '' description: >- - Definition of an element or entity, to describe each type of entity included in - a beacon. + Definition of an element or entry type, to describe each type of entry type included + in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering - terms, request parameters, etc.) that are relvant for an entity. + terms, request parameters, etc.) that are relvant for an entry type. type: object properties: $schema: @@ -48,11 +48,11 @@ properties: description: >- If the entry type is a collection of other entities, (e.g. a Dataset is a collection of Records), then this attribute must list the entities that - can be included. One _collection_ can include more than one entity + can be included. One _collection_ can include more than one entry type (e.g. a Dataset in teh Beacon cdefault model could include Individuals, Biosamples, GenomicVariations, Analyses amnd Runs). In such cases in each individual response (e.g. `resultSetsResponse` of collections of type "dataset") will - contain entries of a single entity type (e.g. biosamples) even if a dataset + contain entries of a single entry type (e.g. biosamples) even if a dataset may contain records of multiple types. includedConcepts: type: array @@ -60,7 +60,7 @@ properties: filteringTerms: description: >- Reference to the list of filtering terms that could be used to filter records - of this entity in this beacon. + of this entry type in this beacon. type: string $comment: >- TO DO: Evaluate switch this to `url` or a more specific way for allowing From 94b789198ec296830c67877097c0c828eef77e30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oriol=20L=C3=B3pez-Doriga?= Date: Tue, 20 Jun 2023 16:46:19 +0200 Subject: [PATCH 5/5] update entryType description --- framework/json/configuration/entryTypeDefinition.json | 2 +- framework/src/configuration/entryTypeDefinition.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/json/configuration/entryTypeDefinition.json b/framework/json/configuration/entryTypeDefinition.json index b20352764..27d425770 100644 --- a/framework/json/configuration/entryTypeDefinition.json +++ b/framework/json/configuration/entryTypeDefinition.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true, - "description": "Definition of an element or entry type, to describe each type of entry type included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering terms, request parameters, etc.) that are relvant for an entry type.", + "description": "Definition of an element or scope of the element, to describe each type of entry type included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering terms, request parameters, etc.) that are relvant for an entry type.", "properties": { "$schema": { "$ref": "../common/beaconCommonComponents.json#/definitions/$schema" diff --git a/framework/src/configuration/entryTypeDefinition.yaml b/framework/src/configuration/entryTypeDefinition.yaml index 136c2980a..61916df7e 100644 --- a/framework/src/configuration/entryTypeDefinition.yaml +++ b/framework/src/configuration/entryTypeDefinition.yaml @@ -1,7 +1,7 @@ $schema: https://json-schema.org/draft/2020-12/schema title: '' description: >- - Definition of an element or entry type, to describe each type of entry type included + Definition of an element or scope of the element, to describe each type of entry type included in a beacon. The `id` attribute is the key that should be used in other parts of the data model to allow Beacon clients to identify the different parts (e.g. endpoints, filtering