schema

Enumeration

Lists or enumerations, for example, a list of cuisines or music genres, etc.

This type is an extension of schema:Enumeration.

Properties

Name @id Type Description Inherited from
alternateNames schema:alternateName Array of string Alternate names (aliases) for the item. Thing
description schema:description Array of BlockContent or Array of InlineContent or string A description of the item. See note 1. Thing
id schema:id string The identifier for this item. Entity
identifiers schema:identifier Array of (PropertyValue or string) Any kind of identifier for any kind of Thing. See note 2. Thing
images schema:image Array of (ImageObject or Format β€˜uri’) Images of the item. Thing
meta stencila:meta object Metadata associated with this item. Entity
name schema:name string The name of the item. Thing
url schema:url Format β€˜uri’ The URL of the item. Thing

Notes

  1. description : Allows for the description to be an array of nodes (e.g. an array of inline content, or a couple of paragraphs), or a string. The minItems restriction avoids a string being coerced into an array with a single string item.
  2. identifiers : Some identifiers have specific properties e.g the issn property for the Periodical type. These should be used in preference to this property which is intended for identifiers that do not yet have a specific property. Identifiers can be represented as strings, but using a PropertyValue will usually be better because it allows for propertyID (i.e. the type of identifier).

Available as

Source

This documentation was generated from Enumeration.schema.yaml.