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

   1 #{{#info}}{{title}}
   2
   3
   4 ## {{join schemes " | "}}://{{host}}{{basePath}}
   5
   6
   7 {{description}}
   8
   9 {{#contact}}
  10 [**Contact the developer**](mailto:{{email}})
  11 {{/contact}}
  12
  13 **Version** {{version}}
  14
  15 {{#license}}[**{{name}}**]({{url}}){{/license}}
  16
  17 {{/info}}
  18
  19 {{#if consumes}}**Consumes:** {{join consumes ", "}}{{/if}}
  20
  21 {{#if produces}}**Produces:** {{join produces ", "}}{{/if}}
  22
  23 {{#if securityDefinitions}}
  24 # Security Definitions
  25 {{/if}}
  26 {{> security}}
  27
  28 # APIs
  29
  30 {{#each paths}}
  31 ## {{@key}}
  32 {{#this}}
  33 {{#get}}
  34 ### GET
  35 {{> operation}}
  36 {{/get}}
  37
  38 {{#put}}
  39 ### PUT
  40 {{> operation}}
  41 {{/put}}
  42
  43 {{#post}}
  44 ### POST
  45
  46 {{> operation}}
  47
  48 {{/post}}
  49
  50 {{#delete}}
  51 ### DELETE
  52 {{> operation}}
  53 {{/delete}}
  54
  55 {{#option}}
  56 ### OPTION
  57 {{> operation}}
  58 {{/option}}
  59
  60 {{#patch}}
  61 ### PATCH
  62 {{> operation}}
  63 {{/patch}}
  64
  65 {{#head}}
  66 ### HEAD
  67 {{> operation}}
  68 {{/head}}
  69
  70 {{/this}}
  71 {{/each}}
  72
  73 # Definitions
  74 {{#each definitions}}
  75 ## <a name="/definitions/{{key}}">{{@key}}</a>
  76
  77 <table border="1">
  78     <tr>
  79         <th>name</th>
  80         <th>type</th>
  81         <th>required</th>
  82         <th>description</th>
  83         <th>example</th>
  84     </tr>
  85     {{#each this.properties}}
  86         <tr>
  87             <td>{{@key}}</td>
  88             <td>
  89                 {{#ifeq type "array"}}
  90                 {{#items.$ref}}
  91                     {{type}}[<a href="{{items.$ref}}">{{basename items.$ref}}</a>]
  92                 {{/items.$ref}}
  93                 {{^items.$ref}}{{type}}[{{items.type}}]{{/items.$ref}}
  94                 {{else}}
  95                     {{#$ref}}<a href="{{$ref}}">{{basename $ref}}</a>{{/$ref}}
  96                     {{^$ref}}{{type}}{{#format}} ({{format}}){{/format}}{{/$ref}}
  97                 {{/ifeq}}
  98             </td>
  99             <td>{{#required}}required{{/required}}{{^required}}optional{{/required}}</td>
 100             <td>{{#description}}{{{description}}}{{/description}}{{^description}}-{{/description}}</td>
 101             <td>{{example}}</td>
 102         </tr>
 103     {{/each}}
 104 </table>
 105 {{/each}}