summaryrefslogtreecommitdiffstats
path: root/sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs
diff options
context:
space:
mode:
authorJean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com>2014-05-02 15:26:33 +0200
committerJean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com>2014-05-02 15:26:39 +0200
commitb381d5b574194862203e9ddde9da79a374e5a334 (patch)
tree1142b234ff0b86d6fe0beed99c4bae23fd287126 /sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs
parent13d7c8d2c4f3b5de9c423ba802fde9ac843e23d8 (diff)
downloadsonarqube-b381d5b574194862203e9ddde9da79a374e5a334.tar.gz
sonarqube-b381d5b574194862203e9ddde9da79a374e5a334.zip
SONAR-5250 Modify layout, add WS path to action title
Diffstat (limited to 'sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs')
-rw-r--r--sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs28
1 files changed, 15 insertions, 13 deletions
diff --git a/sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs b/sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs
index e427a94d28d..2527d4cb5b7 100644
--- a/sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs
+++ b/sonar-server/src/main/hbs/api-documentation/api-documentation-action.hbs
@@ -1,25 +1,27 @@
-<code>
+<h3 class="big">
{{#if post}}POST{{else}}GET{{/if}}
- /{{key}}{{#if params}}?{{#each params}}{{#if required}}{{key}}={{exampleValue}}&amp;{{/if}}{{/each}}{{/if}}
-</code>
-<span class="subtitle">Since {{since}}</span>
+ {{path}}
+</h3>
+<span class="subtitle">
+ {{#if since}}Since {{since}}{{#if internal}} -{{/if}}{{/if}}
+ {{#if internal}}For internal use only{{/if}}
+</span>
<p>{{description}}</p>
-{{#if internal}}<p class="subtitle">For internal use only</p>{{/if}}
{{#if params}}
-<table class="data">
- <thead>
- <tr>
- <th>Key</th>
- <th>Description</th>
- </tr>
- </thead>
+<h3>Parameters</h3>
+<table>
{{#each params}}
<tr>
<td style="width:10em">
<code>{{key}}</code>
<div class="subtitle">{{#if required}}required{{else}}optional{{/if}}</div>
</td<>
- <td>{{description}}</td>
+ <td>
+ <p>{{description}}</p>
+ {{#if exampleValue}}
+ <em>Example value:</em> <code>{{exampleValue}}</code>
+ {{/if}}
+ </td>
</tr>
{{/each}}
</table>