Skip to content

Commit

Permalink
entry type as default instead entity
Browse files Browse the repository at this point in the history
  • Loading branch information
mbaudis committed Jun 19, 2023
1 parent d3f7a92 commit dd943ae
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions framework/json/configuration/entryTypeDefinition.json
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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": {
Expand Down
12 changes: 6 additions & 6 deletions framework/src/configuration/entryTypeDefinition.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -48,19 +48,19 @@ 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
$ref: ../common/basicElement.yaml
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
Expand Down

0 comments on commit dd943ae

Please sign in to comment.