The Core Base Definitions are definitions that can be used on resources, links, actions, etc.

Definitions

Definition Title Type Description
id ID string Unique ID
name Name string Name of a resource, link, action, etc.
class Class Name string Class name of of a resource, link, action, etc.
classes Class Array array An array of classes
mediaType Media Type string A media type
mediaTypes Media Types array A list of media types
title Title string A title for a resource, link, action, etc.
description Description string A description for a resource, link, action, etc.
prefix Prefix string Prefix used for curies

Schema

{
  "definitions": {
    "id": {
      "title": "ID",
      "description": "Unique ID",
      "type": "string"
    },
    "name": {
      "title": "Name",
      "description": "Name of a resource, link, action, etc.",
      "type": "string"
    },
    "class": {
      "title": "Class Name",
      "description": "Class name of of a resource, link, action, etc.",
      "type": "string"
    },
    "classes": {
      "title": "Class Array",
      "description": "An array of classes",
      "type": "array",
      "items": {
        "$ref": "#/definitions/class"
      }
    },
    "mediaType": {
      "title": "Media Type",
      "description": "A media type",
      "type": "string"
    },
    "mediaTypes": {
      "title": "Media Types",
      "description": "A list of media types",
      "type": "array",
      "items": {
        "$ref": "#/definitions/mediaType"
      }
    },
    "title": {
      "title": "Title",
      "description": "A title for a resource, link, action, etc.",
      "type": "string"
    },
    "description": {
      "title": "Description",
      "description": "A description for a resource, link, action, etc.",
      "type": "string"
    },
    "prefix": {
      "title": "Prefix",
      "description": "Prefix used for curies",
      "type": "string"
    }
  }
}