hydra.json

{
    "@context": {
      "hydra": "http://www.w3.org/ns/hydra/core#",
      "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
      "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
      "xsd": "http://www.w3.org/2001/XMLSchema#",
      "owl": "http://www.w3.org/2002/07/owl#",
      "vs": "http://www.w3.org/2003/06/sw-vocab-status/ns#",
      "dc": "http://purl.org/dc/terms/",
      "cc": "http://creativecommons.org/ns#",
      "apiDocumentation": "hydra:apiDocumentation",
      "ApiDocumentation": "hydra:ApiDocumentation",
      "title": "hydra:title",
      "description": "hydra:description",
      "entrypoint": { "@id": "hydra:entrypoint", "@type": "@id" },
      "supportedClass": { "@id": "hydra:supportedClass", "@type": "@vocab" },
      "Class": "hydra:Class",
      "supportedProperty": { "@id": "hydra:supportedProperty", "@type": "@id" },
      "SupportedProperty": "hydra:SupportedProperty",
      "property": { "@id": "hydra:property", "@type": "@vocab" },
      "required": "hydra:required",
      "readable": "hydra:readable",
      "writeable": "hydra:writeable",
      "supportedOperation": { "@id": "hydra:supportedOperation", "@type": "@id" },
      "Operation": "hydra:Operation",
      "method": "hydra:method",
      "expects": { "@id": "hydra:expects", "@type": "@vocab" },
      "returns": { "@id": "hydra:returns", "@type": "@vocab" },
      "possibleStatus": { "@id": "hydra:possibleStatus", "@type": "@id" },
      "Status": "hydra:Status",
      "statusCode": "hydra:statusCode",
      "Error": "hydra:Error",
      "Resource": "hydra:Resource",
      "operation": "hydra:operation",
      "Collection": "hydra:Collection",
      "member": { "@id": "hydra:member", "@type": "@id" },
      "search": "hydra:search",
      "freetextQuery": "hydra:freetextQuery",
      "view": { "@id": "hydra:view", "@type": "@id" },
      "PartialCollectionView": "hydra:PartialCollectionView",
      "totalItems": "hydra:totalItems",
      "first": { "@id": "hydra:first", "@type": "@id" },
      "last": { "@id": "hydra:last", "@type": "@id" },
      "next": { "@id": "hydra:next", "@type": "@id" },
      "previous": { "@id": "hydra:previous", "@type": "@id" },
      "Link": "hydra:Link",
      "TemplatedLink": "hydra:TemplatedLink",
      "IriTemplate": "hydra:IriTemplate",
      "template": "hydra:template",
      "Rfc6570Template": "hydra:Rfc6570Template",
      "variableRepresentation": { "@id": "hydra:variableRepresentation", "@type": "@vocab" },
      "VariableRepresentation": "hydra:VariableRepresentation",
      "BasicRepresentation": "hydra:BasicRepresentation",
      "ExplicitRepresentation": "hydra:ExplicitRepresentation",
      "mapping": "hydra:mapping",
      "IriTemplateMapping": "hydra:IriTemplateMapping",
      "variable": "hydra:variable",
      "defines": { "@reverse": "rdfs:isDefinedBy" },
      "comment": "rdfs:comment",
      "label": "rdfs:label",
      "preferredPrefix": "http://purl.org/vocab/vann/preferredNamespacePrefix",
      "cc:license": {"@type": "@id" },
      "cc:attributionURL": {"@type": "@id" },
      "domain": { "@id": "rdfs:domain", "@type": "@vocab" },
      "range": {"@id": "rdfs:range", "@type": "@vocab" },
      "subClassOf": { "@id": "rdfs:subClassOf", "@type": "@vocab" },
      "subPropertyOf": { "@id": "rdfs:subPropertyOf", "@type": "@vocab" },
      "seeAlso": { "@id": "rdfs:seeAlso", "@type": "@id" }
    },
    "@id": "http://www.w3.org/ns/hydra/core",
    "@type": "owl:Ontology",
    "label": "The Hydra Core Vocabulary",
    "comment": "A lightweight vocabulary for hypermedia-driven Web APIs",
    "preferredPrefix": "hydra",
    "dc:description": "The Hydra Core Vocabulary is a lightweight vocabulary to create hypermedia-driven Web APIs. By specifying a number of concepts commonly used in Web APIs it enables the creation of generic API clients.",
    "dc:rights": "Copyright © 2012-2014 the Contributors to the Hydra Core Vocabulary Specification",
    "dc:publisher": "Hydra W3C Community Group",
    "cc:license": "http://creativecommons.org/licenses/by/4.0/",
    "cc:attributionName": "Hydra W3C Community Group",
    "cc:attributionURL": "http://www.hydra-cg.com/",
    "defines": [
      {
        "@id": "hydra:Resource",
        "@type": "hydra:Class",
        "subClassOf": "rdfs:Resource",
        "label": "Hydra Resource",
        "comment": "The class of dereferenceable resources.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Class",
        "@type": [ "hydra:Resource", "rdfs:Class" ],
        "subClassOf": [ "hydra:Resource", "rdfs:Class" ],
        "label": "Hydra Class",
        "comment": "The class of Hydra classes. Hydra classes and their instances are dereferenceable resources.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Link",
        "@type": "hydra:Class",
        "subClassOf": [ "hydra:Resource", "rdf:Property" ],
        "label": "Link",
        "comment": "The class of properties representing links.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:apiDocumentation",
        "@type": "hydra:Link",
        "label": "apiDocumentation",
        "comment": "A link to the API documentation",
        "range": "hydra:ApiDocumentation",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:ApiDocumentation",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "ApiDocumentation",
        "comment": "The Hydra API documentation class",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:entrypoint",
        "@type": "hydra:Link",
        "label": "entrypoint",
        "comment": "A link to main entry point of the Web API",
        "domain": "hydra:ApiDocumentation",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:supportedClass",
        "@type": "hydra:Link",
        "label": "supported classes",
        "comment": "A class known to be supported by the Web API",
        "domain": "hydra:ApiDocumentation",
        "range": "hydra:Class",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:possibleStatus",
        "@type": "hydra:Link",
        "label": "possible status",
        "comment": "A status that might be returned by the Web API (other statuses should be expected and properly handled as well)",
        "range": "hydra:Status",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:supportedProperty",
        "@type": "hydra:Link",
        "label": "supported properties",
        "comment": "The properties known to be supported by a Hydra class",
        "domain": "hydra:Class",
        "range": "hydra:SupportedProperty",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:SupportedProperty",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "Supported Property",
        "comment": "A property known to be supported by a Hydra class.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:property",
        "@type": "rdf:Property",
        "label": "property",
        "comment": "A property",
        "range": "rdf:Property",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:required",
        "@type": "rdf:Property",
        "label": "required",
        "comment": "True if the property is required, false otherwise.",
        "range": "xsd:boolean",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:readable",
        "@type": "rdf:Property",
        "label": "readable",
        "comment": "True if the client can retrieve the property's value, false otherwise.",
        "domain": "hydra:SupportedProperty",
        "range": "xsd:boolean",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:writeable",
        "@type": "rdf:Property",
        "label": "writeable",
        "comment": "True if the client can change the property's value, false otherwise.",
        "domain": "hydra:SupportedProperty",
        "range": "xsd:boolean",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:supportedOperation",
        "@type": "hydra:Link",
        "label": "supported operation",
        "comment": "An operation supported by instances of the specific Hydra class or the target of the Hydra link",
        "range": "hydra:Operation",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:operation",
        "@type": "hydra:Link",
        "label": "operation",
        "comment": "An operation supported by the Hydra resource",
        "domain": "hydra:Resource",
        "range": "hydra:Operation",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Operation",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "Operation",
        "comment": "An operation.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:method",
        "@type": "rdf:Property",
        "label": "method",
        "comment": "The HTTP method.",
        "domain": "hydra:Operation",
        "range": "xsd:string",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:expects",
        "@type": "hydra:Link",
        "label": "expects",
        "comment": "The information expected by the Web API.",
        "domain": "hydra:Operation",
        "range": "hydra:Class",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:returns",
        "@type": "hydra:Link",
        "label": "returns",
        "comment": "The information returned by the Web API on success",
        "domain": "hydra:Operation",
        "range": "hydra:Class",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Status",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "Status code description",
        "comment": "Additional information about a status code that might be returned.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:statusCode",
        "@type": "rdf:Property",
        "label": "status code",
        "comment": "The HTTP status code",
        "domain": "hydra:Status",
        "range": "xsd:integer",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:title",
        "@type": "rdf:Property",
        "subPropertyOf": "rdfs:label",
        "label": "title",
        "comment": "A title, often used along with a description.",
        "range": "xsd:string",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:description",
        "@type": "rdf:Property",
        "subPropertyOf": "rdfs:comment",
        "label": "description",
        "comment": "A description.",
        "range": "xsd:string",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Error",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Status",
        "label": "Error",
        "comment": "A runtime error, used to report information beyond the returned status code.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Collection",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "Collection",
        "comment": "A collection holding references to a number of related resources.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:member",
        "@type": "hydra:Link",
        "label": "member",
        "comment": "A member of the collection",
        "domain": "hydra:Collection",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:view",
        "@type": "hydra:Link",
        "label": "view",
        "comment": "A specific view of a resource.",
        "domain": "hydra:Resource",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:PartialCollectionView",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "PartialCollectionView",
        "comment": "A PartialCollectionView describes a partial view of a Collection. Multiple PartialCollectionViews can be connected with the the next/previous properties to allow a client to retrieve all members of the collection.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:totalItems",
        "@type": "rdf:Property",
        "label": "total items",
        "comment": "The total number of items referenced by a collection.",
        "domain": "hydra:Collection",
        "range": "xsd:integer",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:first",
        "@type": "hydra:Link",
        "label": "first",
        "comment": "The first resource of an interlinked set of resources.",
        "domain": "hydra:Resource",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:last",
        "@type": "hydra:Link",
        "label": "last",
        "comment": "The last resource of an interlinked set of resources.",
        "domain": "hydra:Resource",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:next",
        "@type": "hydra:Link",
        "label": "next",
        "comment": "The resource following the current instance in an interlinked set of resources.",
        "domain": "hydra:Resource",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:previous",
        "@type": "hydra:Link",
        "label": "previous",
        "comment": "The resource preceding the current instance in an interlinked set of resources.",
        "domain": "hydra:Resource",
        "range": "hydra:Resource",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:search",
        "@type": "hydra:TemplatedLink",
        "label": "search",
        "comment": "A IRI template that can be used to query a collection.",
        "range": "hydra:IriTemplate",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:freetextQuery",
        "@type": "rdf:Property",
        "label": "freetext query",
        "comment": "A property representing a freetext query.",
        "range": "xsd:string",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:TemplatedLink",
        "@type": "hydra:Class",
        "subClassOf": [ "hydra:Resource", "rdf:Property" ],
        "label": "Templated Link",
        "comment": "A templated link.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:IriTemplate",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "IRI Template",
        "comment": "The class of IRI templates.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:template",
        "@type": "rdf:Property",
        "label": "template",
        "comment": "A templated string with placeholders. The literal's datatype indicates the template syntax; if not specified, hydra:Rfc6570Template is assumed.",
        "seeAlso": "hydra:Rfc6570Template",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:Rfc6570Template",
        "@type": "rdfs:Datatype",
        "label": "RFC6570 IRI template",
        "comment": "An IRI template as defined by RFC6570.",
        "seeAlso": "http://tools.ietf.org/html/rfc6570",
        "range": "xsd:string",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:variableRepresentation",
        "@type": "rdf:Property",
        "label": "variable representation",
        "comment": "The representation format to use when expanding the IRI template.",
        "range": "hydra:VariableRepresentation",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:VariableRepresentation",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "VariableRepresentation",
        "comment": "A representation specifies how to serialize variable values into strings.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:BasicRepresentation",
        "@type": "hydra:VariableRepresentation",
        "label": "BasicRepresentation",
        "comment": "A representation that serializes just the lexical form of a variable value, but omits language and type information.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:ExplicitRepresentation",
        "@type": "hydra:VariableRepresentation",
        "label": "ExplicitRepresentation",
        "comment": "A representation that serializes a variable value including its language and type information and thus differentiating between IRIs and literals.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:mapping",
        "@type": "rdf:Property",
        "label": "mapping",
        "comment": "A variable-to-property mapping of the IRI template.",
        "domain": "hydra:IriTemplate",
        "range": "hydra:IriTemplateMapping",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:IriTemplateMapping",
        "@type": "hydra:Class",
        "subClassOf": "hydra:Resource",
        "label": "IriTemplateMapping",
        "comment": "A mapping from an IRI template variable to a property.",
        "vs:term_status": "testing"
      },
      {
        "@id": "hydra:variable",
        "@type": "rdf:Property",
        "label": "variable",
        "comment": "An IRI template variable",
        "domain": "hydra:IriTemplateMapping",
        "range": "xsd:string",
        "vs:term_status": "testing"
      }
    ]
  }