diff options
| author |   Avi Ziv <avi.ziv@amdocs.com> | 2019-06-17 13:04:58 +0300 |
|---|---|---|
| committer |   Avi Gaffa <avi.gaffa@amdocs.com> | 2019-06-18 06:45:51 +0000 |
| commit | 4bf6e7f32c573b9c5096b84f6dd11674f2a53ad9 (patch) | |
| tree | f22d52e7679c4cd40ec5b9f95b65ba6353f719f4 /catalog-be/templates/markdown.hbs | |
| parent | 47292bce13d2963a30c007995ebb36cc94f30dab (diff) | |
Issue-ID: SDC-2370
Signed-off-by: dfx1971 <avi.ziv@amdocs.com>
Change-Id: Ibfe11277ab9a6f9eb0c402190e41ef94e6ae55f3
Diffstat (limited to 'catalog-be/templates/markdown.hbs')
| -rw-r--r-- | catalog-be/templates/markdown.hbs | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/catalog-be/templates/markdown.hbs b/catalog-be/templates/markdown.hbs new file mode 100644 index 0000000000..cc87c38244 --- /dev/null +++ b/catalog-be/templates/markdown.hbs @@ -0,0 +1,105 @@ +#{{#info}}{{title}} + + +## {{join schemes " | "}}://{{host}}{{basePath}} + + +{{description}} + +{{#contact}} +[**Contact the developer**](mailto:{{email}}) +{{/contact}} + +**Version** {{version}} + +{{#license}}[**{{name}}**]({{url}}){{/license}} + +{{/info}} + +{{#if consumes}}**Consumes:** {{join consumes ", "}}{{/if}} + +{{#if produces}}**Produces:** {{join produces ", "}}{{/if}} + +{{#if securityDefinitions}} +# Security Definitions +{{/if}} +{{> security}} + +# APIs + +{{#each paths}} +## {{@key}} +{{#this}} +{{#get}} +### GET +{{> operation}} +{{/get}} + +{{#put}} +### PUT +{{> operation}} +{{/put}} + +{{#post}} +### POST + +{{> operation}} + +{{/post}} + +{{#delete}} +### DELETE +{{> operation}} +{{/delete}} + +{{#option}} +### OPTION +{{> operation}} +{{/option}} + +{{#patch}} +### PATCH +{{> operation}} +{{/patch}} + +{{#head}} +### HEAD +{{> operation}} +{{/head}} + +{{/this}} +{{/each}} + +# Definitions +{{#each definitions}} +## <a name="/definitions/{{key}}">{{@key}}</a> + +<table border="1"> + <tr> + <th>name</th> + <th>type</th> + <th>required</th> + <th>description</th> + <th>example</th> + </tr> + {{#each this.properties}} + <tr> + <td>{{@key}}</td> + <td> + {{#ifeq type "array"}} + {{#items.$ref}} + {{type}}[<a href="{{items.$ref}}">{{basename items.$ref}}</a>] + {{/items.$ref}} + {{^items.$ref}}{{type}}[{{items.type}}]{{/items.$ref}} + {{else}} + {{#$ref}}<a href="{{$ref}}">{{basename $ref}}</a>{{/$ref}} + {{^$ref}}{{type}}{{#format}} ({{format}}){{/format}}{{/$ref}} + {{/ifeq}} + </td> + <td>{{#required}}required{{/required}}{{^required}}optional{{/required}}</td> + <td>{{#description}}{{{description}}}{{/description}}{{^description}}-{{/description}}</td> + <td>{{example}}</td> + </tr> + {{/each}} +</table> +{{/each}}
\ No newline at end of file |