Skip to content

Instantly share code, notes, and snippets.

@smizell
Created July 31, 2014 20:55
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save smizell/63033e18a9b8ce88515d to your computer and use it in GitHub Desktop.
Save smizell/63033e18a9b8ce88515d to your computer and use it in GitHub Desktop.
ALPS doc for defining semantics and links for error messages, as taken from the vnd.error media type
<alps version="1.0">
<descriptor id="error" type="semantic">
<doc>Error Message</doc>
<descriptor id="message" type="semantic">
<doc>
For expressing a human readable message related to the current error which may be displayed to the user of the api
</doc>
</descriptor>
<descriptor id="logref" type="semantic">
<doc>
For expressing an identifier to refer to the specific error on the server side for logging purposes
</doc>
</descriptor>
<descriptor id="help" type="safe">
<doc>
Links to a document describing the error, consistent with http://www.w3.org/TR/html5/links.html#link-type-help
</doc>
</descriptor>
<descriptor id="describes" type="safe">
<doc>
Links to another representation of this error, consistent with http://tools.ietf.org/html/rfc6892
</doc>
</descriptor>
</descriptor>
</alps>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment