-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changed name to Species to OntologyTerm, removed DbIds not in 2.1 mod… #616
base: LzLang-patch-1
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"$defs": { | ||
"ObservationUnitHierarchyLevel": { | ||
"description": "The exact level and level code of an observation unit. \n\nFor more information on Observation Levels, please review the <a target=\"_blank\" href=\"https://wiki.brapi.org/index.php/Observation_Levels\">Observation Levels documentation</a>. \n\nMIAPPE V1.1 DM-71 Observation unit type \"Type of observation unit in textual form, usually one of the following: study, block, sub-block, plot, sub-plot, pot, plant. Use of other observation unit types is possible but not recommended. \nThe observation unit type can not be used to indicate sub-plant levels. However, observations can still be made on the sub-plant level, as long as the details are indicated in the associated observed variable (see observed variables). \nAlternatively, it is possible to use samples for more detailed tracing of sub-plant units, attaching the observations to them instead.\" ", | ||
"properties": { | ||
"levelName": { | ||
"description": "A name for this level \n\n**Standard Level Names: study, field, entry, rep, block, sub-block, plot, sub-plot, plant, pot, sample** \n\nFor more information on Observation Levels, please review the <a target=\"_blank\" href=\"https://wiki.brapi.org/index.php/Observation_Levels\">Observation Levels documentation</a>. ", | ||
"type": [ | ||
"null", | ||
"string" | ||
] | ||
}, | ||
"levelOrder": { | ||
"description": "`levelOrder` defines where that level exists in the hierarchy of levels. `levelOrder`'s lower numbers \nare at the top of the hierarchy (ie field -> 1) and higher numbers are at the bottom of the hierarchy (ie plant -> 9). \n\nFor more information on Observation Levels, please review the <a target=\"_blank\" href=\"https://wiki.brapi.org/index.php/Observation_Levels\">Observation Levels documentation</a>. ", | ||
"type": [ | ||
"null", | ||
"integer" | ||
] | ||
} | ||
}, | ||
"required": [], | ||
"title": "ObservationUnitHierarchyLevel", | ||
"type": "object", | ||
"brapi-metadata": { | ||
"interface": true | ||
} | ||
} | ||
}, | ||
"$id": "https://brapi.org/Specification/BrAPI-Schema/BrAPI-Common/ObservationUnitHierarchyLevel.json", | ||
"$schema": "http://json-schema.org/draft/2020-12/schema" | ||
} |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -100,12 +100,9 @@ | |
}, | ||
"growthFacility": { | ||
"description": "Short description of the facility in which the study was carried out.", | ||
"relationshipType": "one-to-many", | ||
"relationshipType": "many-to-one", | ||
"referencedAttribute": "study", | ||
"items": { | ||
"$ref": "../BrAPI-Core/Study.json#/$defs/GrowthFacility", | ||
"description": "GrowthFacility" | ||
} | ||
"$ref": "../BrAPI-Core/Study.json#/$defs/GrowthFacility" | ||
}, | ||
"lastUpdate": { | ||
"description": "The date and time when this study was last modified", | ||
|
@@ -129,9 +126,8 @@ | |
"observationLevels": { | ||
"description": "Observation levels indicate the granularity level at which the measurements are taken. `levelName` \ndefines the level, `levelOrder` defines where that level exists in the hierarchy of levels. \n`levelOrder`s lower numbers are at the top of the hierarchy (ie field > 0) and higher numbers are \nat the bottom of the hierarchy (ie plant > 6). \n\n**Standard Level Names: study, field, entry, rep, block, sub-block, plot, sub-plot, plant, pot, sample** \n\nFor more information on Observation Levels, please review the <a target=\"_blank\" href=\"https://wiki.brapi.org/index.php/Observation_Levels\">Observation Levels documentation</a>. ", | ||
"relationshipType": "one-to-many", | ||
"referencedAttribute": "study", | ||
"items": { | ||
"$ref": "../BrAPI-Core/Study.json#/$defs/ObservationLevels", | ||
"$ref": "../BrAPI-Common/ObservationUnitHierarchyLevel.json#/$defs/ObservationUnitHierarchyLevel", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You have here a association to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am not sure it is needed. It is not in the model. Actually many of the reverse associations are not in the model, we need to discuss with @BrapiCoordinatorSelby about what we should do about this. |
||
"description": "ObservationLevels" | ||
}, | ||
"title": "ObservationLevels", | ||
|
@@ -394,10 +390,6 @@ | |
}, | ||
"ExperimentalDesign": { | ||
"properties": { | ||
"experimentalDesignDbId": { | ||
"description": "The experimental and statistical design full description plus a category PUI taken from crop research ontology or agronomy ontology", | ||
"type": "string" | ||
}, | ||
"PUI": { | ||
"description": "MIAPPE V1.1 (DM-23) Type of experimental design - Type of experimental design of the study, in the form of an accession number from the Crop Ontology.", | ||
"type": [ | ||
|
@@ -419,9 +411,6 @@ | |
"referencedAttribute": "experimentalDesign" | ||
} | ||
}, | ||
"required": [ | ||
"experimentalDesignDbId" | ||
], | ||
"title": "ExperimentalDesign", | ||
"type": "object", | ||
"brapi-metadata": { | ||
|
@@ -430,10 +419,6 @@ | |
}, | ||
"GrowthFacility": { | ||
"properties": { | ||
"growthFacilityDbId": { | ||
"description": "Short description of the facility in which the study was carried out.", | ||
"type": "string" | ||
}, | ||
"PUI": { | ||
"description": "MIAPPE V1.1 (DM-27) Type of growth facility - Type of growth facility in which the study was carried out, in the form of an accession number from the Crop Ontology.", | ||
"type": [ | ||
|
@@ -455,9 +440,6 @@ | |
"referencedAttribute": "growthFacility" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You changed the relationship in "Study" from "one-to-many" to "many-to-one". There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A study has one growth facility, but a growth facility may have several studies so study -> growth facility is many-to-one |
||
} | ||
}, | ||
"required": [ | ||
"growthFacilityDbId" | ||
], | ||
"title": "GrowthFacility", | ||
"type": "object", | ||
"brapi-metadata": { | ||
|
@@ -498,42 +480,6 @@ | |
"brapi-metadata": { | ||
"primaryModel": false | ||
} | ||
}, | ||
"ObservationLevels": { | ||
"properties": { | ||
"observationLevelsDbId": { | ||
"description": "Observation levels indicate the granularity level at which the measurements are taken. `levelName` defines the level, `levelOrder` defines where that level exists in the hierarchy of levels. `levelOrder`s lower numbers are at the top of the hierarchy (ie field > 0) and higher numbers are at the bottom of the hierarchy (ie plant > 6). ", | ||
"type": "string" | ||
}, | ||
"levelName": { | ||
"description": "A name for this level \n\n**Standard Level Names: study, field, entry, rep, block, sub-block, plot, sub-plot, plant, pot, sample** \n\nFor more information on Observation Levels, please review the <a target=\"_blank\" href=\"https://wiki.brapi.org/index.php/Observation_Levels\">Observation Levels documentation</a>. ", | ||
"type": [ | ||
"null", | ||
"string" | ||
] | ||
}, | ||
"levelOrder": { | ||
"description": "`levelOrder` defines where that level exists in the hierarchy of levels. `levelOrder`'s lower numbers \nare at the top of the hierarchy (ie field -> 1) and higher numbers are at the bottom of the hierarchy (ie plant -> 9). \n\nFor more information on Observation Levels, please review the <a target=\"_blank\" href=\"https://wiki.brapi.org/index.php/Observation_Levels\">Observation Levels documentation</a>. ", | ||
"type": [ | ||
"null", | ||
"integer" | ||
] | ||
}, | ||
"study": { | ||
"description": "Observation levels associated with a study", | ||
"$ref": "../BrAPI-Core/Study.json#/$defs/Study", | ||
"relationshipType": "many-to-one", | ||
"referencedAttribute": "observationLevels" | ||
} | ||
}, | ||
"required": [ | ||
"observationLevelsDbId" | ||
], | ||
"title": "ObservationUnitHierarchyLevel", | ||
"type": "object", | ||
"brapi-metadata": { | ||
"primaryModel": false | ||
} | ||
} | ||
}, | ||
"$id": "https://brapi.org/Specification/BrAPI-Schema/BrAPI-Core/Study.json", | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't it make sense to use referenceDbId here so that it is standardized or would that lead to a model change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It the OpenAPI specification it is 'referenceId' so we should keep it to that. Also I think it is technically not a DbId but can be any ID.