openecomp-be/api/openecomp-sdc-rest-webapp/onboarding-rest-war/templates/operation.hbs

   1 {{#deprecated}}-deprecated-{{/deprecated}}
   2 <a id="{{operationId}}">{{summary}}</a>
   3
   4 {{description}}
   5
   6 {{#if externalDocs.url}}{{externalDocs.description}}. [See external documents for more details]({{externalDocs.url}})
   7 {{/if}}
   8
   9 {{#if security}}
  10 #### Security
  11 {{/if}}
  12
  13 {{#security}}
  14 {{#each this}}
  15 * {{@key}}
  16 {{#this}}   * {{this}}
  17 {{/this}}
  18 {{/each}}
  19 {{/security}}
  20
  21 #### Request
  22
  23 {{#if consumes}}
  24 **Content-Type: ** {{join consumes ", "}}{{/if}}
  25
  26 ##### Parameters
  27 {{#if parameters}}
  28 <table border="1">
  29     <tr>
  30         <th>Name</th>
  31         <th>Located in</th>
  32         <th>Required</th>
  33         <th>Description</th>
  34         <th>Default</th>
  35         <th>Schema</th>
  36     </tr>
  37 {{/if}}
  38
  39 {{#parameters}}
  40 <tr>
  41     <th>{{name}}</th>
  42     <td>{{in}}</td>
  43     <td>{{#if required}}yes{{else}}no{{/if}}</td>
  44     <td>{{description}}{{#if pattern}} (**Pattern**: `{{pattern}}`){{/if}}</td>
  45     <td>{{#if defaultValue}}{{defaultValue}}{{else}} - {{/if}}</td>
  46 {{#ifeq in "body"}}
  47     <td>
  48     {{#ifeq schema.type "array"}}Array[<a href="{{schema.items.$ref}}">{{basename schema.items.$ref}}</a>]{{/ifeq}}
  49     {{#schema.$ref}}<a href="{{schema.$ref}}">{{basename schema.$ref}}</a> {{/schema.$ref}}
  50     </td>
  51 {{else}}
  52     {{#ifeq type "array"}}
  53             <td>Array[{{items.type}}] ({{collectionFormat}})</td>
  54     {{else}}
  55             <td>{{type}} {{#format}}({{format}}){{/format}}</td>
  56     {{/ifeq}}
  57 {{/ifeq}}
  58 </tr>
  59 {{/parameters}}
  60 {{#if parameters}}
  61 </table>
  62 {{/if}}
  63
  64
  65 #### Response
  66
  67 {{#if produces}}**Content-Type: ** {{join produces ", "}}{{/if}}
  68
  69
  70 | Status Code | Reason      | Response Model |
  71 |-------------|-------------|----------------|
  72 {{#each responses}}| {{@key}}    | {{description}} | {{#schema.$ref}}<a href="{{schema.$ref}}">{{basename schema.$ref}}</a>{{/schema.$ref}}{{#ifeq schema.type "array"}}Array[<a href="{{schema.items.$ref}}">{{basename schema.items.$ref}}</a>]{{/ifeq}}{{^schema}} - {{/schema}}|
  73 {{/each}}