BlockMeta schemablocks

{S}[B] Status [i]
proposed
Provenance
Used by
Contributors
Source (v0.0.1)

Attributes

Type: object
Description: BlockMeta defines the format of the SchemaBlocks metadata, used to describe e.g. the given block’s provenance, scope, external usage.

Properties

Property Type
contributors array of "https://schemablocks.org/schemas/sb-phenopackets/v1.0.0/ExternalReference.json [SRC] [HTML]"
provenance array of "https://schemablocks.org/schemas/sb-phenopackets/v1.0.0/ExternalReference.json [SRC] [HTML]"
sb_status string
use_cases array of "https://schemablocks.org/schemas/sb-phenopackets/v1.0.0/ExternalReference.json [SRC] [HTML]"

contributors

The contributors attribute provides a list of one or more contributors which had been involved in the block’s definition or support its format.

contributors Value Example
{
   "description" : "Michael Baudis",
   "id" : "orcid:0000-0002-9903-4248"
}

provenance

The provenance attribute provides a list of pointers to e.g. external schemas, predecessors of the current schema or external documentation describing the schema’s genesis.

provenance Value Example
{
   "description" : "Original GA4GH schema",
   "id" : "https://github.com/ga4gh/ga4gh-schemas/blob/master/src/main/proto/ga4gh/bio_metadata.proto#L111"
}

sb_status

With sb_status the current support level of the schema block inside the {S}[B] ecosystem has to be demonstrated. A first recommendation of levels is:

sb_status Value Examples
"core"
"implementation"
"proposed"
"playground"

use_cases

With the use_cases attribute one can provide links and descriptions for the use of a given block in an external implementation. This is not intended to provide a catalogue of all known implementations of the schema.

use_cases Value Examples
{
   "description" : "Phenopackets",
   "id" : "https://github.com/phenopackets/phenopacket-schema/blob/master/docs/age.rst"
}
{
   "description" : "Progenetix database schema (Beacon+ backend)",
   "id" : "https://github.com/progenetix/schemas/tree/master/main/yaml"
}

BlockMeta Value Example

{
   "contributors" : [
      {
         "description" : "Michael Baudis",
         "id" : "orcid:0000-0002-9903-4248"
      },
      {
         "description" : "Ben Hutton",
         "id" : "https://github.com/Relequestual"
      }
   ],
   "provenance" : [
      {
         "description" : "Developer branch of original GA4GH schema",
         "id" : "https://github.com/ga4gh-metadata/metadata-schemas/blob/master/schemas/shared.proto#L60"
      }
   ],
   "sb_status" : "playground",
   "used_by" : [
      {
         "description" : "Phenopackets",
         "id" : "https://github.com/phenopackets/phenopacket-schema/blob/master/docs/geolocation.rst"
      },
      {
         "description" : "Progenetix database schema (Beacon+ backend)",
         "id" : "https://github.com/progenetix/schemas/tree/master/main/yaml"
      }
   ]
}