Skip to content

Commit

Permalink
Added missing common/info.yaml / common/info.json
Browse files Browse the repository at this point in the history
... also added the `info` property to cohorts & genomicVariations, for consistency. Referencing #199

Note: the info.yaml file was added previously but probably got lost in some branch shuffling...
  • Loading branch information
mbaudis committed Feb 14, 2025
1 parent 3df917e commit 102f047
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 5 deletions.
6 changes: 3 additions & 3 deletions framework/json/configuration/entryTypeDefinition.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
},
"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).",
"type": "array",
"items": {
"$ref": "../common/basicElement.json"
}
},
"type": "array"
},
"additionallySupportedSchemas": {
"description": "List of additional schemas that could be used for this concept in this instance of Beacon.",
Expand Down Expand Up @@ -71,4 +71,4 @@
],
"title": "",
"type": "object"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,9 @@
"description": "Inclusion criteria used for defining the cohort. It is assumed that all cohort participants will match such criteria.",
"type": "object"
},
"info": {
"$ref": "../common/info.json"
},
"name": {
"description": "Name of the cohort. For `user-defined` this field could be generated upon the query, e.g. a value that is a concatenationor some representation of the user query.",
"examples": [
Expand Down
6 changes: 6 additions & 0 deletions models/json/beacon-v2-default-model/common/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Placeholder to allow the Beacon models to return additional information. It is recommended to encapsulate additional informations in this attribute instead of directly adding attributes at the schema's root level in order to avoid collision in the names of attributes in future versions of the specification.",
"title": "Info",
"type": "object"
}
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,9 @@
"identifiers": {
"$ref": "#/$defs/Identifiers"
},
"info": {
"$ref": "../common/info.json"
},
"molecularAttributes": {
"$ref": "#/$defs/MolecularAttributes"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ properties:
example: {}
info:
$ref: ../common/info.yaml

required:
- id
- biosampleStatus
Expand Down
3 changes: 3 additions & 0 deletions models/src/beacon-v2-default-model/cohorts/defaultSchema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ properties:
type: array
items:
$ref: '#/$defs/CollectionEvent'
info:
$ref: ../common/info.yaml

$defs:
CollectionEvent:
description: TBD
Expand Down
9 changes: 9 additions & 0 deletions models/src/beacon-v2-default-model/common/info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
$schema: https://json-schema.org/draft/2020-12/schema
title: Info
description: >-
Placeholder to allow the Beacon models to return additional information.
It is recommended to encapsulate additional informations in this attribute
instead of directly adding attributes at the schema's root level in
order to avoid collision in the names of attributes in future versions of
the specification.
type: object
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,12 @@ properties:
3986 format).
examples:
- https://example.org/wiki/Main_Page
info:
$ref: ../common/info.yaml
dataUseConditions:
description: Data use conditions applying to this dataset.
$ref: ../common/dataUseConditions.yaml
info:
$ref: ../common/info.yaml

required:
- id
- name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ properties:
type: array
items:
$ref: '#/$defs/FrequencyInPopulations'
info:
$ref: ../common/info.yaml

$defs:
LegacyVariation:
type: object
Expand Down

0 comments on commit 102f047

Please sign in to comment.