Optional. Used to define a header of a Hyper message. Fields in the header section apply to the entire message. There SHOULD be only one h:head property at the top level. All subsequent h:head properties after the first one, or the ones at deeper levels MUST be ignored.
h:head property points to a JSON object that MAY contain following optional fields:
optional. Version property indicates the version of the Hyper
specification that a message represents. Currently, there’s only one
version of the specification: 1.0, the current version. As such, the
version property, if present, MUST be set to 1.0, until there’s another
version of the specification. If the version field is omitted, it should be
assumed to be 1.0.
optional. Title of the document
optional. A JSON object where keys are prefixes and values are URIs of corresponding CURIEs, complying to the W3C definition. In Hyper, CURIEs can be used in values of “uri” fields or as any object’s key’s name. Please note that CURIEs can conflict with many valid uris, such as the ones starting with prefixes like “mailto:”, “git:”, “urn:”, “about:” etc. When Hyper sees a colon (“:”) in a key name or in a value of uri field, it considers the string to be a URI, unless it is a CURIE registered in the document. Case in point: if you define a CURIE with the prefix “data”, you will stop otherwise legit URIs of the form “data:” to be parsed as URIs, in your Hyper message. At such a point you may want to reconsider the prefix chosen. You can find the full list of possibly conflicting prefixes by looking at the IANA URI Schemes Registry.
Important: Hyper registers a special CURIE "h":
"http://hyperjson.io/props/" that is always present and cannot
be removed or overriden.
{
"h:head": {
"version": "1.0",
"title": "Department Employees",
"curies": {"ex": "http://api.example.com/"},
},
"department" : {
"name" : "North-East Region",
"h:ref" : { "about" : "ex:regions/north-east"}
}
}