From: Dietmar Maurer <dietmar@proxmox.com>
Date: Mon, 5 Sep 2016 07:42:35 +0000 (+0200)
Subject: api-viewer: use verbose_description if available
X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=61e5a832cde3f8215c96bfea50109fd39f4821f0

api-viewer: use verbose_description if available
---

diff --git a/api-viewer/PVEAPI.js b/api-viewer/PVEAPI.js
index 75168e6..9c3ca67 100644
--- a/api-viewer/PVEAPI.js
+++ b/api-viewer/PVEAPI.js
@@ -11,8 +11,8 @@ Ext.onReady(function() {
     Ext.define('pve-param-schema', {
         extend: 'Ext.data.Model',
         fields:  [ 
-	    'name', 'type', 'typetext', 'description', 'enum', 
-	    'minimum', 'maximum', 'minLength', 'maxLength',
+	    'name', 'type', 'typetext', 'description', 'verbose_description',
+	    'enum', 'minimum', 'maximum', 'minLength', 'maxLength',
 	    'pattern', 'title', 'requires', 'format', 'default',
 	    'disallow', 'extends', 'links',
 	    {
@@ -42,9 +42,13 @@ Ext.onReady(function() {
         }]
     });
     
-    var render_text = function(value, metaData, record) {
+    var render_description = function(value, metaData, record) {
 	var pdef = record.data;
 
+	value = pdef.verbose_description || value;
+
+	TODO: try to render asciidoc correctly
+
 	metaData.style = 'white-space:pre-wrap;'
 
 	return Ext.htmlEncode(value);
@@ -168,7 +172,7 @@ Ext.onReady(function() {
 			    { 
 				header: 'Description',
 				dataIndex: 'description',
-				renderer: render_text,
+				renderer: render_description,
 				flex: 2
 			    }
 			]