Created
July 31, 2014 20:55
-
-
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<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