@stencila/schema/dist/PropertyValue.schema.json

{
  "title": "PropertyValue",
  "@id": "schema:PropertyValue",
  "extends": "Thing",
  "status": "stable",
  "role": "secondary",
  "category": "other",
  "description": "A property-value pair.",
  "$comment": "Always use specific properties when they exist and you can populate them.\nUsing `PropertyValue` as a substitute will typically not convey as much semantic\ninformation as using the specific property.\n\nMost of the time a `PropertyValue` node will need a `value` property\n(e.g. most of the examples on https://schema.org/PropertyValue have one)\nso this schema make that property required.\n\nThis type is mainly provided for use in `Thing.identifiers` (see the notes there).\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "PropertyValue"
      ],
      "default": "PropertyValue",
      "from": "Entity"
    },
    "id": {
      "@id": "schema:id",
      "description": "The identifier for this item.",
      "type": "string",
      "from": "Entity"
    },
    "meta": {
      "@id": "stencila:meta",
      "description": "Metadata associated with this item.",
      "type": "object",
      "from": "Entity"
    },
    "alternateNames": {
      "@id": "schema:alternateName",
      "description": "Alternate names (aliases) for the item.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "from": "Thing",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "alternateName"
      ]
    },
    "description": {
      "@id": "schema:description",
      "description": "A description of the item.",
      "$comment": "Allows for the description to be an array of nodes (e.g. an array of inline content,\nor a couple of paragraphs), or a string. The `minItems` restriction avoids a string\nbeing coerced into an array with a single string item.\n",
      "anyOf": [
        {
          "type": "array",
          "items": {
            "$ref": "BlockContent.schema.json"
          }
        },
        {
          "type": "array",
          "items": {
            "$ref": "InlineContent.schema.json"
          },
          "minItems": 2
        },
        {
          "type": "string"
        }
      ],
      "from": "Thing"
    },
    "identifiers": {
      "@id": "schema:identifier",
      "description": "Any kind of identifier for any kind of Thing.",
      "$comment": "Some identifiers have specific properties e.g the `issn` property for\nthe `Periodical` type. These should be used in preference to this\nproperty which is intended for identifiers that do not yet have a\nspecific property. Identifiers can be represented as strings, but\nusing a `PropertyValue` will usually be better because it allows\nfor `propertyID` (i.e. the type of identifier).\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "PropertyValue.schema.json"
          },
          {
            "type": "string"
          }
        ]
      },
      "from": "Thing",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "identifier"
      ]
    },
    "images": {
      "@id": "schema:image",
      "description": "Images of the item.",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "ImageObject.schema.json"
          },
          {
            "type": "string",
            "format": "uri"
          }
        ]
      },
      "from": "Thing",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "image"
      ]
    },
    "name": {
      "@id": "schema:name",
      "description": "The name of the item.",
      "type": "string",
      "from": "Thing"
    },
    "url": {
      "@id": "schema:url",
      "description": "The URL of the item.",
      "type": "string",
      "format": "uri",
      "from": "Thing"
    },
    "propertyID": {
      "@id": "schema:propertyID",
      "description": "A commonly used identifier for the characteristic represented by the property.",
      "type": "string",
      "from": "PropertyValue"
    },
    "value": {
      "@id": "schema:value",
      "description": "The value of the property.",
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        }
      ],
      "$comment": "This follows the expected types of https://schema.org/value except for `StructuredValue`,\nwhich at the time of writing was not implemented in this schema.\n",
      "from": "PropertyValue"
    }
  },
  "required": [
    "type",
    "value"
  ],
  "file": "PropertyValue.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/PropertyValue.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/PropertyValue.schema.yaml",
  "type": "object",
  "additionalProperties": false,
  "propertyAliases": {
    "alternateName": "alternateNames",
    "identifier": "identifiers",
    "image": "images"
  }
}