schema
Heritage Science Schema Repository
This repository has been created to host completed heritage science metadata gathering json schema. Work and discussion relating to the development of these schema is being carried out within: https://github.com/E-RIHS/hs-interoperability
For each type of schema, such as Project, create a section in this README file, as shown for Project to provide direct links to the current and developmental versions of each scheme along with a table of recent updates and changes.
Schema documents should be named using lowercase letters, according to the following naming structure: name-v0.0.schema.json. Changes to the first version number are reserverd for major changes that might include breaking changes, the second version number should be used for more minor changes including.
Note: Versions below 1.0 should be used for the intial development of each schema and therefore all versions changes, below 1.0, can include breaking changes even though the first part of the version number stays at 0. These early versions predate the choice for Cordra as the central metadata store for E-RIHS and are not available within this system. Because of this, these schema have been moved to the ‘draft’ subfolder in GitHub.
GitHub pages have been set up based on the root directory of this repository, this provides a much cleaner URL, but there can be a temporary lag between when new files are added and when the links will work. However, once the files have been added in there is no additional delay.
Issues and ideas related to the schema published here can be added directly into the Issues System.
The schema GitHub repository can be access directly here. Additional modeling work and discussions relating to interoprability can be found here.
Schema overview
Catalogue metadata schema
This schema is intended to model the metadata and details required to document and describe catalogue (tools) used within an offered service in E-RIHS and IPERION-HS.
Current version: v1.0 [JSON] [Cordra] [Github]
Equipment metadata schema
This schema is intended to model the metadata and details required to document and describe equipments (tools) used within an offered service in E-RIHS and IPERION-HS.
Current version: v1.0 [JSON] [Cordra] [Github]
KPI metadata schema
This schema is intended to model the metadata and details required to document particular key performance indicators (KPIs) as defined by E-RIHS, capturing actual data.
Current version: v1.0 [JSON] [Cordra] [Github]
KPI definition metadata schema
This schema describes KPI definitions, which are used as a basis to calculate individual KPI scores.
Current version: v1.0 [JSON] [Cordra] [Github]
Method metadata schema
This new model has been created as a template for a range of method or setup descriptions - it allows for methods based on a series of statements and or a selection of the defined method parameters.
Current version: v1.0 [JSON] [Cordra] [Github]
Organisation metadata schema
This schema is intended to model the metadata and details required to document and describe organisations (actors) events within E-RIHS and IPERION-HS.
Current version: v1.0 [JSON] [Cordra] [Github]
Person metadata schema
This schema is intended to model the metadata and details required to document and describe persons (actors) events within E-RIHS and IPERION-HS.
Current version: v1.0 [JSON] [Cordra] [Github]
Service metadata schema
This schema is intended to model the metadata and details required to document and describe service or access providers within E-RIHS and IPERION-HS. These services will be offered by one or more funding programmes and exploited > in one or more research projects. It is anticipated that services will be defined as part of the registoring a service in the categlogue of service.
Current version: v1.0 [JSON] [Cordra] [Github]
Software metadata schema
This schema is intended to model the metadata and details required to document and describe software (tools) used within an offered service in E-RIHS and IPERION-HS.
Current version: v1.0 [JSON] [Cordra] [Github]
Technique metadata schema
This schema is intended to model the metadata and details required to document and describe techniques that are used within access offerings in E-RIHS and IPERION-HS.
Current version: v1.0 [JSON] [Cordra] [Github]
Special schemas
Controlled lists helper schema
This schema collects all controlled list definitions with the link to the corresponding endpoint. These definitions are referenced throughout all other schemas as reusable components, and as such, this schema is not meant to be used as a standalone schema to model instances. There is no related model.
Note: The schema in Github only contains a link to the controlled list endpoint. The version in Cordra is automatically populated with enum and enum_titles values
Current version: v1.0 [JSON] [Cordra] [Github]
CordraUser administrative schema
This schema serves administrative purposes within Cordra. It allows to define users in the system, providing authentication and authorization to the system and to types/objects.
Current version: v1.0 [JSON] [Cordra] [Github]
CordraGroup administrative schema
This schema serves administrative purposes within Cordra. It allows to define groups of users (and other groups), facilitating authorization on types/objects.
Current version: v1.0 [JSON] [Cordra] [Github]
Tools
The directory ‘tools’ contains a set of useful scripts manipulate (validation, synchronisation…) the schema.
Acknowledgement
This work project was supported by:
The H2020 IPERION-HS project
