Jump to: navigation, search

Difference between revisions of "Documentation/WADL conventions"

(What is WADL?)
(WADL markup conventions)
Line 1: Line 1:
 +
{{OpenStack_Documentation_Navbar}}
 +
 
= WADL markup conventions =
 
= WADL markup conventions =
  

Revision as of 21:11, 20 February 2014

WADL markup conventions

What is WADL?

  • An acronym for Web Application Description Language.
  • An XML vocabulary that describes RESTful APIs.
  • Machine- and human-readable.
  • Can be referenced in Docbook files to generate API reference documentation.


For complete information about the WADL language, see Web Application Description Language (http://www.w3.org/Submission/wadl/).

Markup

For list methods, use the text: "Lists available xxx." Do not use "Gets a listing," or "Prints a listing." For show (or get) methods, use the text: "Shows xxx details." Do not use, "Retrieves information about," or "Gets information for."