docs/template/tizen/partials/rest.child.tmpl.partial

   1 {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
   2
   3 {{^_disableContribution}}
   4 {{#docurl}}
   5 <span class="small pull-right mobile-hide">
   6   <span class="divider">|</span>
   7   <a href="{{docurl}}">Improve this Doc</a>
   8 </span>{{/docurl}}
   9 {{#sourceurl}}
  10 <span class="small pull-right mobile-hide">
  11   <a href="{{sourceurl}}">View Source</a>
  12 </span>{{/sourceurl}}
  13 {{/_disableContribution}}
  14  <h3 id="{{htmlId}}" data-uid="{{uid}}" class="text-capitalize">{{operationId}}</h3>
  15 {{#summary}}
  16 <div class="markdown level1 summary">{{{summary}}}</div>
  17 {{/summary}}
  18 {{#description}}
  19 <div class="markdown level1 description">{{{description}}}</div>
  20 {{/description}}
  21 {{#conceptual}}
  22   <div class="markdown level1 conceptual">{{{conceptual}}}</div>
  23 {{/conceptual}}
  24 <h5>Request</h5>
  25 <div class="codewrapper">
  26   <pre><code class="lang-restApi hljs">{{operation}} {{path}}</code></pre>
  27 </div>
  28 {{#parameters.0}}
  29 <h5>Parameters</h5>
  30 <table class="table table-bordered table-striped table-condensed">
  31   <thead>
  32     <tr>
  33       <th>Name</th>
  34       <th>Type</th>
  35       <th>Value</th>
  36       <th>Notes</th>
  37     </tr>
  38   </thead>
  39   <tbody>
  40 {{/parameters.0}}
  41 {{#parameters}}
  42     <tr>
  43       <td><span class="parametername">{{#required}}*{{/required}}{{name}}</span></td>
  44       <td>{{type}}</td>
  45       <td>{{default}}</td>
  46       <td>{{{description}}}</td>
  47     </tr>
  48   {{/parameters}}
  49   {{#parameters.0}}
  50   </tbody>
  51 </table>
  52 {{/parameters.0}}
  53 {{#responses.0}}
  54 <div class="responses">
  55   <h5>Responses</h5>
  56   <table class="table table-bordered table-striped table-condensed">
  57     <thead>
  58       <tr>
  59         <th>Status Code</th>
  60         <th>Description</th>
  61         <th>Samples</th>
  62       </tr>
  63     </thead>
  64     <tbody>
  65 {{/responses.0}}
  66 {{#responses}}
  67     <tr>
  68       <td><span class="status">{{statusCode}}</span></td>
  69       <td>{{{description}}}</td>
  70       <td class="sample-response">
  71         {{#examples}}
  72         <div class="mime-type">
  73           <i>Mime type: </i><span class="mime">{{mimeType}}</span>
  74         </div>
  75         <pre class="response-content"><code class="lang-js json hljs">{{content}}</code></pre>
  76         {{/examples}}
  77       </td>
  78     </tr>
  79   {{/responses}}
  80   {{#responses.0}}
  81     </tbody>
  82   </table>
  83 </div>
  84 {{/responses.0}}
  85 {{#footer}}
  86 <div class="markdown level1 api-footer">{{{footer}}}</div>
  87 {{/footer}}