You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

87 lines
2.3 KiB

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