Dear All,

is there any recommended DocBook tag set for describing REST API?

My current structure is depicted in http://drifted.in/other/docbook/rest.png

I use common elements like sections, simplesects, tables, programlistings,
tips, but not sure what vocabulary use for URL fragments (1) or parameter
descriptions (3, 4).

(1) uri
(2) synopsis
(3, 4) informaltable

I especially don't like (3, 4) as tables are quite heavy/complex objects for
kind of variablelist with headers, which could be even auto-generated using
localized resources.

Any thoughts?

Thanks, 

Jan


---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org

Reply via email to