Added implementation notes to documentation

swagger-api · Jul 31, 2011 · 7bd8ebc · 7bd8ebc
1 parent 74eddf7
commit 7bd8ebc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/src/main/html/index.html b/src/main/html/index.html
@@ -114,6 +114,10 @@ <h3>
             </ul>
         </div>
         <div class='content' id='${apiName}_${nickname}_${httpMethod}_content' style='display:none'>
+            {{if notes}}
+            <h4>Implementation Notes</h4>
+            <p>${notes}</p>
+            {{/if}}
             <form id="${apiName}_${nickname}_${httpMethod}_form" accept-charset="UTF-8" action="#" class="sandbox" method="post">
                 <div style="margin:0;padding:0;display:inline"></div>
                 <h4>Parameters</h4>

diff --git a/src/main/html/javascript/swagger-service.js b/src/main/html/javascript/swagger-service.js
@@ -146,7 +146,7 @@ function SwaggerService(baseUrl, _apiKey, statusCallback) {
     });
 
 	// Model: ApiOperation
-	var ApiOperation = Spine.Model.setup("ApiOperation", ["baseUrl", "path", "path_json", "path_xml", "summary", "deprecated", "open", "httpMethod", "httpMethodLowercase", "nickname", "responseClass", "parameters", "apiName"]);
+	var ApiOperation = Spine.Model.setup("ApiOperation", ["baseUrl", "path", "path_json", "path_xml", "summary", "notes", "deprecated", "open", "httpMethod", "httpMethodLowercase", "nickname", "responseClass", "parameters", "apiName"]);
     ApiOperation.include({
 		init: function(atts) {
 	        if (atts) this.load(atts);