@stencila/schema/dist/built/ImageObject.schema.json

Stencila schema and other specifications

{
  "title": "ImageObject",
  "@id": "schema:ImageObject",
  "role": "secondary",
  "status": "stable",
  "description": "An image file. https://schema.org/ImageObject\n",
  "properties": {
    "type": {
      "description": "The name of the type and all descendant types.",
      "type": "string",
      "enum": [
        "ImageObject"
      ],
      "default": "ImageObject",
      "from": "Thing"
    },
    "id": {
      "description": "The identifier for this item.",
      "type": "string",
      "from": "Thing"
    },
    "alternateNames": {
      "@id": "schema:alternateName",
      "description": "Alternate names (aliases) for the item.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "from": "Thing",
      "aliases": [
        "alternateName"
      ]
    },
    "description": {
      "@id": "schema:description",
      "description": "A description of the item.",
      "type": "string",
      "from": "Thing"
    },
    "meta": {
      "@id": "stencila:meta",
      "description": "Metadata associated with this item.",
      "type": "object",
      "from": "Thing"
    },
    "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"
    },
    "authors": {
      "@id": "schema:author",
      "description": "The authors of this this creative work.",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "Person.schema.json"
          },
          {
            "$ref": "Organization.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "author"
      ]
    },
    "citations": {
      "@id": "schema:citation",
      "description": "Citations or references to other creative works, such as another publication, \nweb page, scholarly article, etc.\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "$ref": "CreativeWork.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "citation"
      ]
    },
    "content": {
      "@id": "stencila:content",
      "description": "The structured content of this creative work c.f. property `text`.",
      "type": "array",
      "items": {
        "$ref": "Node.schema.json"
      },
      "from": "CreativeWork"
    },
    "dateCreated": {
      "@id": "schema:dateCreated",
      "description": "Date/time of creation.",
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "string",
          "format": "date-time"
        }
      ],
      "from": "CreativeWork"
    },
    "dateModified": {
      "@id": "schema:dateModified",
      "description": "Date/time of most recent modification.",
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "string",
          "format": "date-time"
        }
      ],
      "from": "CreativeWork"
    },
    "datePublished": {
      "@id": "schema:datePublished",
      "aliases": [
        "date"
      ],
      "description": "Date of first publication.",
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "string",
          "format": "date-time"
        }
      ],
      "from": "CreativeWork"
    },
    "editors": {
      "@id": "schema:editor",
      "description": "Persons who edited the CreativeWork.\n",
      "type": "array",
      "items": {
        "$ref": "Person.schema.json"
      },
      "from": "CreativeWork",
      "aliases": [
        "editor"
      ]
    },
    "funders": {
      "@id": "schema:funder",
      "description": "Person or organisation that funded the CreativeWork.\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "Person.schema.json"
          },
          {
            "$ref": "Organization.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "funder"
      ]
    },
    "isPartOf": {
      "@id": "schema:isPartOf",
      "description": "An item or other CreativeWork that this CreativeWork is a part of.\n",
      "allOf": [
        {
          "$ref": "CreativeWork.schema.json"
        }
      ],
      "from": "CreativeWork"
    },
    "licenses": {
      "@id": "schema:license",
      "description": "License documents that applies to this content, typically indicated by URL.\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "format": "uri"
          },
          {
            "$ref": "CreativeWork.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "license"
      ]
    },
    "parts": {
      "@id": "schema:hasParts",
      "aliases": [
        "hasParts",
        "part"
      ],
      "description": "Elements of the collection which can be a variety of different elements, \nsuch as Articles, Datatables, Tables and more.\n",
      "type": "array",
      "items": {
        "$ref": "CreativeWork.schema.json"
      },
      "from": "CreativeWork"
    },
    "publisher": {
      "@id": "schema:publisher",
      "description": "A publisher of the CreativeWork.\n",
      "anyOf": [
        {
          "$ref": "Person.schema.json"
        },
        {
          "$ref": "Organization.schema.json"
        }
      ],
      "from": "CreativeWork"
    },
    "text": {
      "@id": "schema:text",
      "description": "The textual content of this creative work.",
      "type": "string",
      "from": "CreativeWork"
    },
    "title": {
      "@id": "schema:headline",
      "aliases": [
        "headline"
      ],
      "type": "string",
      "from": "CreativeWork"
    },
    "version": {
      "@id": "schema:version",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "from": "CreativeWork"
    },
    "bitrate": {
      "@id": "schema:bitrate",
      "description": "Bitrate in megabits per second (Mbit/s, Mb/s, Mbps).\n",
      "type": "number",
      "from": "MediaObject"
    },
    "contentSize": {
      "@id": "schema:contentSize",
      "description": "File size in megabits (Mbit, Mb).\n",
      "type": "number",
      "from": "MediaObject"
    },
    "contentUrl": {
      "@id": "schema:contentUrl",
      "description": "URL for the actual bytes of the media object, for example the image file or video file.\n",
      "type": "string",
      "format": "uri",
      "from": "MediaObject"
    },
    "embedUrl": {
      "@id": "schema:embedUrl",
      "description": "URL that can be used to embed the media on a web page via a specific media player.\n",
      "type": "string",
      "format": "uri",
      "from": "MediaObject"
    },
    "format": {
      "@id": "schema:encodingFormat",
      "aliases": [
        "encoding",
        "encodingFormat"
      ],
      "description": "Media type (MIME type) as per http://www.iana.org/assignments/media-types/media-types.xhtml.\n",
      "type": "string",
      "pattern": "^[a-z]+(\\/[a-z\\+\\-]+)?$",
      "from": "MediaObject"
    },
    "caption": {
      "@id": "schema:caption",
      "description": "The caption for this image.\n",
      "type": "string",
      "from": "ImageObject"
    },
    "thumbnail": {
      "@id": "schema:thumbnail",
      "description": "Thumbnail image of this image.\n",
      "allOf": [
        {
          "$ref": "ImageObject.schema.json"
        }
      ],
      "from": "ImageObject"
    }
  },
  "source": "https://github.com/stencila/schema/blob/master/schema/media/ImageObject.schema.yaml",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stencila.github.com/schema/ImageObject.schema.json",
  "category": "media",
  "children": [],
  "descendants": [],
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "contentUrl"
  ],
  "parent": "MediaObject"
}