DRAFT Specification v. 0.0.1


Description

This Container profile specification presents a representation of a Container such as Docker or Singularity that is used in scientific compute.


Schema.org hierarchy

This is a new Profile that fits into the schema.org hierarchy as follows:

Thing



Key to specification table

Schema.org properties where the Expected Types have been changed, or new (i.e., Bioschemas created) properties/types are green.

Schema.org properties/types are red.

Pending Schema.org properties/types are blue.

External (i.e., from 3rd party ontology) properties/types are black.


CD = Cardinality


View all examples
Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
description Text
Schema:

A description of the item.


Bioschemas:

a linux container

ONE
featureList Text
URL
Schema:

Features or modules provided by this application (and possibly required by other applications).


Bioschemas:

Please choose values from EDAM:Operation.

MANY

EDAM:Operation

View ≪featureList≫ example
name Text
Schema:

The name of the item.


ONE
softwareVersion Text
Schema:

Version of the software instance.


Bioschemas:

version of the container instance

ONE
View ≪softwareVersion≫ example
url URL
Schema:

URL of the item.


Bioschemas:

URL of the container, typically associated with a registry that shows the ContainerRecipe, vulnerability scans, and other metadata. This property can be used on a page listing many containers to indicate each individual container’s page.

ONE
Marginality: Recommended.
ImageMediaType Text
URL
Schema:

The media type of the container image


Bioschemas:

The media type of the container image

ONE

https://github.com/opencontainers/image-spec/blob/master/media-types.md

alternateName Text
Schema:

An alias for the item.


MANY
citation CreativeWork
Text
Schema:

A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.


Bioschemas:

Publication about this software.

MANY
View ≪citation≫ example
config Text
URL
Schema:

This REQUIRED property references a configuration object for a container, by digest.


ONE

https://github.com/opencontainers/image-spec/blob/master/manifest.md

configMediaType Text
URL
Schema:

This descriptor property has additional restrictions for config.


ONE

https://github.com/opencontainers/image-spec/blob/master/manifest.md

identifier PropertyValue
Text
URL
Schema:

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.


Bioschemas:

Unique identifier for the container, typically corresponding to a uri to designate a registry source

ONE
View ≪identifier≫ example
input URL
Bioschemas:

The input format of the data. Must be one of the EDAM:Data concept labels or one of its synonyms.

MANY

EDAM:Data

View ≪input≫ example
layers Text
URL
Schema:

Each item in the array MUST be a descriptor. The array MUST have the base layer at index 0. Subsequent layers MUST then follow in stack order (i.e. from layers[0] to layers[len(layers)-1]). The final filesystem layout MUST match the result of applying the layers to an empty directory. The ownership, mode, and other attributes of the initial empty directory are unspecified.


Bioschemas:

Each item in the array MUST be a descriptor. The array MUST have the base layer at index 0. Subsequent layers MUST then follow in stack order (i.e. from layers[0] to layers[len(layers)-1]). The final filesystem layout MUST match the result of applying the layers to an empty directory. The ownership, mode, and other attributes of the initial empty directory are unspecified.

MANY

https://github.com/opencontainers/image-spec/blob/master/manifest.md

layersMediaType Text
URL
Schema:

This descriptor property has additional restrictions for layers[].


Bioschemas:

This descriptor property has additional restrictions for layers[].

MANY

https://github.com/opencontainers/image-spec/blob/master/manifest.md

license Text
URL
Schema:

A license document that applies to this content, typically indicated by URL.


Bioschemas:

The applicable software license. Note: Bioschemas have changed the Expected Types to URL or Text.

MANY
View ≪license≫ example
mediaType Text
URL
Schema:

This property is reserved for use, to maintain compatibility. When used, this field contains the media type of this document, which differs from the descriptor use of mediaType.


Bioschemas:

This property is reserved for use, to maintain compatibility. When used, this field contains the media type of this document, which differs from the descriptor use of mediaType.

ONE

https://github.com/opencontainers/image-spec/blob/master/manifest.md

output URL
Bioschemas:

The output format of the data. Must be one of the EDAM:Data concept labels or one of its synonyms.

MANY

EDAM:Data

View ≪output≫ example
publisher Organization
Person
Schema:

The publisher of the creative work.


MANY
View ≪publisher≫ example
schemaVersion Number
Text
Schema:

This REQUIRED property specifies the image manifest schema version. For this version of the specification, this MUST be 2 to ensure backward compatibility with older versions of Docker. The value of this field will not change. This field MAY be removed in a future version of the specification.


Bioschemas:

This REQUIRED property specifies the image manifest schema version. For this version of the specification, this MUST be 2 to ensure backward compatibility with older versions of Docker. The value of this field will not change. This field MAY be removed in a future version of the specification.

ONE

https://github.com/opencontainers/image-spec/blob/master/manifest.md

Marginality: Optional.
annotations Text
Schema:

This OPTIONAL property contains arbitrary metadata for the image manifest. This OPTIONAL property MUST use the annotation rules.


Bioschemas:

This OPTIONAL property contains arbitrary metadata for the image manifest. This OPTIONAL property MUST use the annotation rules.

MANY

https://github.com/opencontainers/image-spec/blob/master/manifest.md

applicationCategory Text
Schema:

Type of software application, e.g. ‘Game, Multimedia’.


Bioschemas:

Type of software e.g. database, tool, service. Note: Bioschemas have removed URL from the Expected Types.

MANY

Please indicate the container technology in all lowercase

View ≪applicationCategory≫ example
dateCreated Date
DateTime
Schema:

The date on which the CreativeWork was created or the item was added to a DataFeed.


ONE
View ≪dateCreated≫ example
dateModified Date
DateTime
Schema:

The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed.


ONE
View ≪dateModified≫ example
downloadUrl URL
Schema:

If the file can be downloaded, URL to download the binary. For containers without an exposed wget url or similar, this can be the pull command.


MANY
View ≪downloadUrl≫ example
hasPart CreativeWork
Schema:

Indicates a CreativeWork that is (in some sense) a part of this CreativeWork. Inverse property: isPartOf.


Bioschemas:

Used to describe tools included into suites/bundles/workflows.

MANY
keywords Text
Schema:

Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.


ONE

EDAM:Topic

View ≪keywords≫ example
operatingSystem Text
Schema:

Operating systems supported (Windows 7, OSX 10.6, Android 1.6).


Bioschemas:

Operating systems on which the container runs, typically Linux derivatives and (for some containers) Windows.

MANY
View ≪operatingSystem≫ example
softwareHelp CreativeWork
Schema:

Software application help.


Bioschemas:

A documentation for the container, typically showing install steps, usage, and a changelog.

MANY
View ≪softwareHelp≫ example
softwareRequirements Text
URL
Schema:

Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (Examples: DirectX, Java or .NET runtime). Supersedes requirements.


MANY
View ≪softwareRequirements≫ example

Top ▲