]> git.proxmox.com Git - pve2-api-doc.git/commitdiff
add usage information
authorDietmar Maurer <dietmar@proxmox.com>
Fri, 24 Feb 2012 08:09:17 +0000 (09:09 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Fri, 24 Feb 2012 08:09:17 +0000 (09:09 +0100)
data/PVEAPI.js

index 50080854d0190675c5354cbfe7424467142da8ed..ff3cd447fde239547a2a3eb8368e0df8db937783 100644 (file)
@@ -83,15 +83,32 @@ Ext.onReady(function() {
 
        var items = [];
 
+       var clicmdhash = {
+           GET: 'get',
+           POST: 'create',
+           PUT: 'set',
+           DELETE: 'delete'
+       };
+
        Ext.Array.each(['GET', 'POST', 'PUT', 'DELETE'], function(method) {
            var info = md[method];
            if (info) {
 
+               var usage = "";
+
+               usage += "<table><tr><td>HTTP:&nbsp;&nbsp;&nbsp;</td><td>" + method + " /api2/json" + data.path + "</td></tr><tr><td>&nbsp</td></tr>";
+               usage += "<tr><td>CLI:</td><td>pvesh " + clicmdhash[method] + " " + data.path + "</td></tr></table>";
+
                var sections = [
                    {
                        title: 'Description',
                        html: Ext.htmlEncode(info.description),
                        bodyPadding: 10
+                   },
+                   {
+                       title: 'Usage',
+                       html: usage,
+                       bodyPadding: 10
                    }
                ];