Template Model that leverage the Beacon Framework v2 and is the starting point for creating new models from scratch.
The GA4GH Beacon specification is composed by two parts:
- the Beacon Framework
- the Beacon Models
The Beacon Framework (in Framework repo repo) is the part that describes the overall structure of the API requests, responses, parameters, teh common components, etc. It could also be referred in this document as simply the Framework.
Beacon Models describes the set of concepts included in a Beacon version (e.g. Beacon v2), like individual or biosample, and also the relationships between them. It could also be referred in this document as simply the Model.
The Framework could be considered the syntax and the Model as the semantics.
Refer to the Framework repo for further information about the Framework and its parts.
A Beacon instance is just an implementation of a Beacon Model that follows the rules stated by the Beacon Framework.
If you are a Beacon implementer, then, you don't need to clone the Framework repo, you only need to copy (or clone) a Beacon Model and modify it to your specific case. You will find plenty of references to the Framework in the Model copy, and you will use the Json schemas there to validate that both the structure of your requests and responses are compliant with the Beacon Framework. The Framewrok is not used to check the schema in the responses payload (e.g. the actual details of a biosample of a cohort). The schemas for that are included in the Model that you should have copied.
The TEMPLATE Model: (in this repo) is the most basic model. Its purpose is twofold 1) as starting point for any new model (so to say, not Beacon v2) and 2) as a learning tool.
Refer to the Models repo for a list of other Models.