diff options
author | Dmitry Puzikov <d.puzikov2@partner.samsung.com> | 2020-03-03 10:18:41 +0100 |
---|---|---|
committer | Yuli Shlosberg <ys9693@att.com> | 2020-03-16 20:14:52 +0000 |
commit | cdca700bbc71af59acfe340b54d464f28206bb79 (patch) | |
tree | 6b5d42a082b098b8ce84f36b105301f4e17f5735 /catalog-be/templates | |
parent | 71b9e84b987f2b1bb8981ddc4270bf15d5d5675b (diff) |
Fix SDC-BE Swagger
General reorganisation of APIs rendering done.
Fixed mix of swagger.v2 and new swagger.v3
conflicting annotatons.
Moved to newer version of swagger-ui.
Removed unused/inconsistent parts of pom.xml.
Change-Id: Id1356b766caff6bf5817768c1a0f9b80541b85e8
Issue-ID: SDC-2718
Signed-off-by: Dmitry Puzikov <d.puzikov2@partner.samsung.com>
Diffstat (limited to 'catalog-be/templates')
-rw-r--r-- | catalog-be/templates/markdown.hbs | 105 | ||||
-rw-r--r-- | catalog-be/templates/operation.hbs | 73 | ||||
-rw-r--r-- | catalog-be/templates/security.hbs | 88 | ||||
-rw-r--r-- | catalog-be/templates/strapdown.html.hbs | 11 |
4 files changed, 0 insertions, 277 deletions
diff --git a/catalog-be/templates/markdown.hbs b/catalog-be/templates/markdown.hbs deleted file mode 100644 index cc87c38244..0000000000 --- a/catalog-be/templates/markdown.hbs +++ /dev/null @@ -1,105 +0,0 @@ -#{{#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 diff --git a/catalog-be/templates/operation.hbs b/catalog-be/templates/operation.hbs deleted file mode 100644 index 375d4f7701..0000000000 --- a/catalog-be/templates/operation.hbs +++ /dev/null @@ -1,73 +0,0 @@ -{{#deprecated}}-deprecated-{{/deprecated}} -<a id="{{operationId}}">{{summary}}</a> - -{{description}} - -{{#if externalDocs.url}}{{externalDocs.description}}. [See external documents for more details]({{externalDocs.url}}) -{{/if}} - -{{#if security}} -#### Security -{{/if}} - -{{#security}} -{{#each this}} -* {{@key}} -{{#this}} * {{this}} -{{/this}} -{{/each}} -{{/security}} - -#### Request - -{{#if consumes}} -**Content-Type: ** {{join consumes ", "}}{{/if}} - -##### Parameters -{{#if parameters}} -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> -{{/if}} - -{{#parameters}} -<tr> - <th>{{name}}</th> - <td>{{in}}</td> - <td>{{#if required}}yes{{else}}no{{/if}}</td> - <td>{{description}}{{#if pattern}} (**Pattern**: `{{pattern}}`){{/if}}</td> - <td>{{#if defaultValue}}{{defaultValue}}{{else}} - {{/if}}</td> -{{#ifeq in "body"}} - <td> - {{#ifeq schema.type "array"}}Array[<a href="{{schema.items.$ref}}">{{basename schema.items.$ref}}</a>]{{/ifeq}} - {{#schema.$ref}}<a href="{{schema.$ref}}">{{basename schema.$ref}}</a> {{/schema.$ref}} - </td> -{{else}} - {{#ifeq type "array"}} - <td>Array[{{items.type}}] ({{collectionFormat}})</td> - {{else}} - <td>{{type}} {{#format}}({{format}}){{/format}}</td> - {{/ifeq}} -{{/ifeq}} -</tr> -{{/parameters}} -{{#if parameters}} -</table> -{{/if}} - - -#### Response - -{{#if produces}}**Content-Type: ** {{join produces ", "}}{{/if}} - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -{{#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}}| -{{/each}}
\ No newline at end of file diff --git a/catalog-be/templates/security.hbs b/catalog-be/templates/security.hbs deleted file mode 100644 index 04f86e8380..0000000000 --- a/catalog-be/templates/security.hbs +++ /dev/null @@ -1,88 +0,0 @@ -{{#each securityDefinitions}} -### {{@key}} -{{#this}} -{{#ifeq type "oauth2"}} -<table> - <tr> - <th>type</th> - <th colspan="2">{{type}}</th> - </tr> -{{#if description}} - <tr> - <th>description</th> - <th colspan="2">{{description}}</th> - </tr> -{{/if}} -{{#if authorizationUrl}} - <tr> - <th>authorizationUrl</th> - <th colspan="2">{{authorizationUrl}}</th> - </tr> -{{/if}} -{{#if flow}} - <tr> - <th>flow</th> - <th colspan="2">{{flow}}</th> - </tr> -{{/if}} -{{#if tokenUrl}} - <tr> - <th>tokenUrl</th> - <th colspan="2">{{tokenUrl}}</th> - </tr> -{{/if}} -{{#if scopes}} - <tr> - <td rowspan="3">scopes</td> -{{#each scopes}} - <td>{{@key}}</td> - <td>{{this}}</td> - </tr> - <tr> -{{/each}} - </tr> -{{/if}} -</table> -{{/ifeq}} -{{#ifeq type "apiKey"}} -<table> - <tr> - <th>type</th> - <th colspan="2">{{type}}</th> - </tr> -{{#if description}} - <tr> - <th>description</th> - <th colspan="2">{{description}}</th> - </tr> -{{/if}} -{{#if name}} - <tr> - <th>name</th> - <th colspan="2">{{name}}</th> - </tr> -{{/if}} -{{#if in}} - <tr> - <th>in</th> - <th colspan="2">{{in}}</th> - </tr> -{{/if}} -</table> -{{/ifeq}} -{{#ifeq type "basic"}} -<table> - <tr> - <th>type</th> - <th colspan="2">{{type}}</th> - </tr> -{{#if description}} - <tr> - <th>description</th> - <th colspan="2">{{description}}</th> - </tr> -{{/if}} -</table> -{{/ifeq}} -{{/this}} -{{/each}}
\ No newline at end of file diff --git a/catalog-be/templates/strapdown.html.hbs b/catalog-be/templates/strapdown.html.hbs deleted file mode 100644 index fe722ab6f1..0000000000 --- a/catalog-be/templates/strapdown.html.hbs +++ /dev/null @@ -1,11 +0,0 @@ -<!DOCTYPE html> -<html> -<title>API Document</title> - -<!--xmp theme="united" style="display:none;"--> -<xmp theme="united" style="display:none;"> -{{>markdown}} -</xmp> - -<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script> -</html>
\ No newline at end of file |