search

biocompute-objects / BCO_Documentation

Repository for documentation to support the IEEE 2791-2020 standard. Please see our home page for communications/publications:
http://biocomputeobject.org/
BSD 3-Clause "New" or "Revised" License
16 stars 12 forks source link

What is a type? #11

Closed stain closed 5 years ago

stain commented 6 years ago

type is explained as if one is already meant to know how types are declared.

As any object of type 'type,' it has its own fields: _type, _id, _inherits, name, title and description. Type of this JSON object is "antiviral_resistance_detection"

The meaning of these fields are nowhere explained, and this typing system is not explained.

Suggestion is to remove the type field or to add a section that explain the typing system. data-typing.md might be an early attempt of this, but it has no technical information.

HadleyKing commented 5 years ago

After the virtual rooms from the BioCompute Spec Hack-a-thon closed yesterday @rajamazumder @anton-golikov @kee007ney @kkaragiannis @rykahsay and I all discussed this. When the BCO spec was first being developed JSON Schema did not exist. The _type and type and the primitives were all an attempt to do what has been done in JSON schema.

Given this we all agreed that removing the "data typing" requirements and the associated sections is warranted.

mr-c commented 5 years ago

@HadleyKing Okay, so will we be removing this from the BCO spec?