ega-4-defs-schema-descriptor.md

Schema descriptor Schema

https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.protocol.json#/properties/schemaDescriptor

This node is intended to be used to describe the schemas and standards that a JSON document was based on. For instance, if a sample.json document was created to be validated against EGA.sample.json schema version 1.0.0, such information should be reflected in this block. This way, both a human and a machine can interpret and validate the JSON document efficiently, without the need of guessing versions.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	EGA.protocol.json*

schemaDescriptor Type

object (Schema descriptor)

schemaDescriptor Properties

Property	Type	Required	Nullable	Defined by
objectType	string	Required	cannot be null	EGA common metadata definitions
describedBySchemaUri	string	Required	cannot be null	EGA common metadata definitions
objectSchemaVersion	Merged	Required	cannot be null	EGA common metadata definitions
commonSchemaVersion	Merged	Required	cannot be null	EGA common metadata definitions

objectType

Type of the object (e.g. 'sample') the JSON document describes.

objectType

• is required

• Type: string (Type of the object)

• cannot be null

• defined in: EGA common metadata definitions

objectType Type

string (Type of the object)

objectType Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"experiment"
"study"
"sample"
"individual"
"submission"
"assay"
"dataset"
"analysis"
"policy"
"DAC"
"protocol"
"object-set"

describedBySchemaUri

URI of the schema that describes the JSON document (e.g. 'my_sample.json')

describedBySchemaUri

• is required

• Type: string (URI of the schema)

• cannot be null

• defined in: EGA common metadata definitions

describedBySchemaUri Type

string (URI of the schema)

describedBySchemaUri Constraints

URI: the string must be a URI, according to RFC 3986

describedBySchemaUri Examples

"https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.analysis.json"

objectSchemaVersion

The version of the object's schema, the one specific for the object the JSON document corresponds to (e.g. 'EGA.sample.json'), not the common definitions schema's version (i.e. 'EGA.common-definitions.json').

objectSchemaVersion

• is required

• Type: string (Version of the object's schema)

• cannot be null

• defined in: EGA common metadata definitions

objectSchemaVersion Type

string (Version of the object's schema)

all of

• Semantic versioning pattern

commonSchemaVersion

The version of the common definition's schema, the one containing all shared definitions (i.e. 'EGA.common-definitions.json'), not the one specific to the object described by the JSON document (e.g. 'EGA.sample.json').

commonSchemaVersion

• is required

• Type: string (Version of the common definition's schema)

• cannot be null

• defined in: EGA common metadata definitions

commonSchemaVersion Type

string (Version of the common definition's schema)

all of

• Semantic versioning pattern