Building Hypermedia APIs with HTML5 and Node

Appendix D. Maze+XML Media Type

The Maze+XML media type is an XML data format for sharing maze state information between clients and servers. It can be used to implement simple mazes, adventure games, and other related data.

The IANA Registry lists the media type identifier as application/vnd.amundsen.maze+xml.

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Elements

Below is a map of the Maze+XML media type. This map shows all of the possible elements, attributes, link relations, and data types.

It should be noted that the media type map below does not necessarily represent a valid instance of a Maze+XML document. It is only useful as a map to explore the various features of the media type:

<maze version="1.0">
  <collection href="URI">
    <link href="URI" rel="maze" />
    <link href="URI" rel="maze" />
    ...
  </collection>
  <item href="URI" >
    <link href="URI" rel="start" />
    <debug>CDATA</debug>
  </item>  
  <cell href="URI"  debug="TEXT" total="NUMBER" side="NUMBER">
    <link href="URI" rel="current" debug="TEXT" total="NUMBER" side="NUMBER" /> <!-- alternate 'current' link -->
    <link href="URI" rel="north" />
    <link href="URI" rel="south" />
    <link href="URI" rel="east" />
    <link href="URI" rel="west" />
    <link href="URI" rel="exit" />
  </cell>
  <error href="URI">
    <title>TEXT</title>
    <code>TEXT</code>
    <message>CDATA</message>
  </error>
</maze>

cell

The <cell> element represents ...