Merge pull request #3134 from ZuzannaSt/2.x

Add translations for each Authorize tag in 2.x

Dockerfile

@@ -10,4 +10,4 @@ ADD ./dist/ /usr/share/nginx/html
 
 EXPOSE 8080
 
-CMD nginx -g 'daemon off;'
+CMD exec nginx -g 'daemon off;'

README.md

@@ -8,7 +8,7 @@
 
 Swagger UI is part of the Swagger project.  The Swagger project allows you to produce, visualize and consume your OWN RESTful services.  No proxy or 3rd party services required.  Do it your own way.
 
-Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically
+Swagger UI is a dependency-free collection of HTML, JavaScript, and CSS assets that dynamically
 generate beautiful documentation and sandbox from a Swagger-compliant API. Because Swagger UI has no dependencies, you can host it in any server environment, or on your local machine.
 
 ## What's Swagger?
@@ -24,12 +24,14 @@ The OpenAPI Specification has undergone 4 revisions since initial creation in 20
 
 Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes | Status
 ------------------ | ------------ | -------------------------- | ----- | ------
-2.2.6              | 2016-10-14   | 1.1, 1.2, 2.0              | [tag v2.2.6](https://github.com/swagger-api/swagger-ui/tree/v2.2.6) |
+2.2.10             | 2017-01-04   | 1.1, 1.2, 2.0              | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10) |
 2.1.5              | 2016-07-20   | 1.1, 1.2, 2.0              | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5) |
 2.0.24             | 2014-09-12   | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
 1.0.13             | 2013-03-08   | 1.1, 1.2 | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) |
 1.0.1              | 2011-10-11   | 1.0, 1.1 | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1)   |
 
+**Note:** Support for versions older than 1.2 is limited and you may experience issues we cannot improve and support. We highly recommend that you upgrade your spec to the latest version.
+
 ## How to Use It
 
 ### Download
@@ -41,7 +43,8 @@ Swagger UI works in all evergreen desktop browsers (Chrome, Safari, Firefox). In
 ### Build
 You can rebuild swagger-ui on your own to tweak it or just so you can say you did.  To do so, follow these steps:
 
-### Windows Users: Please install [Python](https://www.python.org/downloads/windows/) before follow below guidelines for node-gyp rebuild to run.
+* Ensure you have `nodejs` 4.0 or greater installed, and on your classpath.
+* Windows Users: Please install [Python](https://www.python.org/downloads/windows/) before following the guidelines below for node-gyp rebuild to run.
 
 1. `npm install`
 2. `npm run build`
@@ -59,7 +62,7 @@ docker run -p 80:8080 swaggerapi/swagger-ui
 
 ### Build using Docker
 
-To build swagger-ui using a docker container:
+To build swagger-ui using a Docker container:
 
 ```
 docker build -t swagger-ui-builder .
@@ -69,7 +72,7 @@ docker run -p 80:8080 swagger-ui-builder
 This will start Swagger UI at `http://localhost`.
 
 ### Use
-Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.io/v2/swagger.json) service and show its APIs.  You can enter your own server url and click explore to view the API.
+Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.io/v2/swagger.json) service and show its APIs.  You can enter your own server url and click 'Explore' to view the API.
 
 ### Customize
 You may choose to customize Swagger UI for your organization. Here is an overview of what's in its various directories:
@@ -149,9 +152,9 @@ swaggerUi.api.clientAuthorizations.add("key", new SwaggerClient.ApiKeyAuthorizat
 Note!  You can pass multiple header params on a single request, just use unique names for them (`key` is used in the above example).
 
 ### Localization and translation
-The localization files are in the [lang](/lang) directory. Note that language files and translator is not included in SwaggerUI by default. You need to add them manually.
+The localization files are in the [lang](/lang) directory. Note that language files and translator are not included in SwaggerUI by default. You need to add them manually.
 
-To enable translation you should append next two lines in your Swagger's index.html (or another entry point you use)
+To enable translation, you should append the next two lines in your Swagger's index.html (or another entry point you use)
 ```html
 <script src='lang/translator.js' type='text/javascript'></script>
 <script src='lang/en.js' type='text/javascript'></script>
@@ -176,7 +179,7 @@ At this moment only inner html, title-attribute and value-attribute are going to
 ## CORS Support
 ### OR: How to deal with "Can't read from server. It may not have the appropriate access-control-origin settings."
 
-CORS is a technique to prevent websites from doing bad things with your personal data.  Most browsers + javascript toolkits not only support CORS but enforce it, which has implications for your API server which supports Swagger.
+CORS is a technique to prevent websites from doing bad things with your personal data.  Most browsers + JavaScript toolkits not only support CORS but enforce it, which has implications for your API server which supports Swagger.
 
 You can read about CORS here: http://www.w3.org/TR/cors.
 

composer.json

@@ -1,24 +1,24 @@
 {
-    "name": "swagger-api/swagger-ui",
-    "description": "Swagger UI is a dependency-free collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API",
-    "keywords": [
-        "Swagger",
-        "OpenAPI",
-        "specification",
-        "documentation",
-        "API",
-        "UI"
-    ],
-    "homepage": "http://swagger.io",
-    "license": "Apache-2.0",
-    "authors": [
-        {
-            "name": "Tony Tam",
-            "email": "fehguy@gmail.com"
-        },
-        {
-            "name": "Mohsen Azimi",
-            "email": "me@azimi.me"
-        }
-    ]
-}
+  "name": "swagger-api/swagger-ui",
+  "description": "Swagger UI is a dependency-free collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API",
+  "keywords": [
+    "Swagger",
+    "OpenAPI",
+    "specification",
+    "documentation",
+    "API",
+    "UI"
+  ],
+  "homepage": "http://swagger.io",
+  "license": "Apache-2.0",
+  "authors": [
+    {
+      "name": "Tony Tam",
+      "email": "fehguy@gmail.com"
+    },
+    {
+      "name": "Mohsen Azimi",
+      "email": "me@azimi.me"
+    }
+  ]
+}

dist/css/reset.css

@@ -1 +1 @@
-a,abbr,acronym,address,applet,article,aside,audio,b,big,blockquote,body,canvas,caption,center,cite,code,dd,del,details,dfn,div,dl,dt,em,embed,fieldset,figcaption,figure,footer,form,h1,h2,h3,h4,h5,h6,header,hgroup,html,i,iframe,img,ins,kbd,label,legend,li,mark,menu,nav,object,ol,output,p,pre,q,ruby,s,samp,section,small,span,strike,strong,sub,summary,sup,table,tbody,td,tfoot,th,thead,time,tr,tt,u,ul,var,video{margin:0;padding:0;border:0;font-size:100%;font:inherit;vertical-align:baseline}article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:after,blockquote:before,q:after,q:before{content:'';content:none}table{border-collapse:collapse;border-spacing:0}
+a,abbr,acronym,address,applet,article,aside,audio,b,big,blockquote,body,canvas,caption,center,cite,code,dd,del,details,dfn,div,dl,dt,em,embed,fieldset,figcaption,figure,footer,form,h1,h2,h3,h4,h5,h6,header,hgroup,html,i,iframe,img,ins,kbd,label,legend,li,mark,menu,nav,object,ol,output,p,pre,q,ruby,s,samp,section,small,span,strike,strong,sub,summary,sup,table,tbody,td,tfoot,th,thead,time,tr,tt,u,ul,var,video{margin:0;padding:0;border:0;font-size:100%;font:inherit;vertical-align:baseline}article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:after,blockquote:before,q:after,q:before{content:"";content:none}table{border-collapse:collapse;border-spacing:0}

lang/de.js

@@ -0,0 +1,57 @@
+'use strict';
+
+/* jshint quotmark: double */
+window.SwaggerTranslator.learn({
+    "Warning: Deprecated":"Warnung: Deprecated",
+    "Implementation Notes":"Implementierungshinweise",
+    "Response Class":"Response Class",
+    "Status":"Status",
+    "Parameters":"Parameter",
+    "Parameter":"Parameter",
+    "Value":"Wert",
+    "Description":"Beschreibung",
+    "Parameter Type":"Parametertyp",
+    "Data Type":"Datentyp",
+    "Response Messages":"Response Messages",
+    "HTTP Status Code":"HTTP Status Code",
+    "Reason":"Grund",
+    "Response Model":"Response Model",
+    "Request URL":"Request URL",
+    "Response Body":"Response Body",
+    "Response Code":"Response Code",
+    "Response Headers":"Response Headers",
+    "Hide Response":"Response ausblenden",
+    "Headers":"Headers",
+    "Try it out!":"Ausprobieren",
+    "Show/Hide":"Einblenden/Ausblenden",
+    "List Operations":"Endpunkte anzeigen",
+    "Expand Operations":"Endpunkte ausklappen",
+    "Raw":"Raw",
+    "can't parse JSON.  Raw result":"Parsen von JSON fehlgeschlagen.  Raw result",
+    "Example Value":"Beispielwert",
+    "Model Schema":"Schemamodell",
+    "Model":"Modell",
+    "Click to set as parameter value":"Klicken um Parameter zu setzen",
+    "apply":"anlegen",
+    "Username":"Benutzername",
+    "Password":"Passwort",
+    "Terms of service":"Nutzungsbedingungen",
+    "Created by":"Erstellt von",
+    "See more at":"Mehr unter",
+    "Contact the developer":"Entwickler kontaktieren",
+    "api version":"API-Version",
+    "Response Content Type":"Response Content Type",
+    "Parameter content type:":"Parameter Content Type:",
+    "fetching resource":"Lade Ressourcen",
+    "fetching resource list":"Lade Liste der Ressourcen",
+    "Explore":"Erkunde",
+    "Show Swagger Petstore Example Apis":"Anzeigen der Swagger Petstore Example Apis",
+    "Can't read from server.  It may not have the appropriate access-control-origin settings.":"Lesen vom Server nicht möglich. Prüfen Sie die 'access-control-origin' Einstellungen.",
+    "Please specify the protocol for":"Bitte geben Sie das Protokoll an",
+    "Can't read swagger JSON from":"Swagger JSON kann nicht gelesen werden",
+    "Finished Loading Resource Information. Rendering Swagger UI":"Ressourceninformationen sind geladen. Rendern der Swagger UI",
+    "Unable to read api":"API kann nicht gelesen werden",
+    "from path":"von Pfad",
+    "server returned":"Server antwortet",
+    "Authorize":"Autorisieren"
+});

lang/en.js

@@ -52,5 +52,6 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Finished Loading Resource Information. Rendering Swagger UI",
     "Unable to read api":"Unable to read api",
     "from path":"from path",
-    "server returned":"server returned"
+    "server returned":"server returned",
+    "Authorize":"Authorize"
 });

lang/fr.js

@@ -50,5 +50,6 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Chargement des informations terminé. Affichage de Swagger UI",
     "Unable to read api":"Impossible de lire l'api",
     "from path":"à partir du chemin",
-    "server returned":"réponse du serveur"
+    "server returned":"réponse du serveur",
+    "Authorize":"Autorisez"
 });

lang/it.js

@@ -48,5 +48,6 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Lettura informazioni risorse termianta. Swagger UI viene mostrata",
     "Unable to read api":"Impossibile leggere la api",
     "from path":"da cartella",
-    "server returned":"il server ha restituito"
+    "server returned":"il server ha restituito",
+    "Authorize":"Autorizzare"
 });

lang/pl.js

@@ -49,5 +49,6 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Ukończono Ładowanie Informacji o Zasobie. Renderowanie Swagger UI",
     "Unable to read api":"Nie można odczytać api",
     "from path":"ze ścieżki",
-    "server returned":"serwer zwrócił"
+    "server returned":"serwer zwrócił",
+    "Authorize":"Autoryzuj"
 });

lang/pt-br.js

@@ -0,0 +1,54 @@
+'use strict';
+
+/* jshint quotmark: double */
+window.SwaggerTranslator.learn({
+    "Warning: Deprecated":"Aviso: Descontinuado",
+    "Implementation Notes":"Notas de Implementação",
+    "Response Class":"Classe de resposta",
+    "Status":"Status",
+    "Parameters":"Parâmetros",
+    "Parameter":"Parâmetro",
+    "Value":"Valor",
+    "Description":"Descrição",
+    "Parameter Type":"Tipo de parâmetro",
+    "Data Type":"Tipo de dados",
+    "Response Messages":"Mensagens de resposta",
+    "HTTP Status Code":"Código de status HTTP",
+    "Reason":"Razão",
+    "Response Model":"Modelo de resposta",
+    "Request URL":"Requisição URL",
+    "Response Body":"Corpo da resposta",
+    "Response Code":"Código da resposta",
+    "Response Headers":"Cabeçalho da resposta",
+    "Headers":"Cabeçalhos",
+    "Hide Response":"Esconder resposta",
+    "Try it out!":"Tente agora!",
+    "Show/Hide":"Mostrar/Esconder",
+    "List Operations":"Listar operações",
+    "Expand Operations":"Expandir operações",
+    "Raw":"Cru",
+    "can't parse JSON.  Raw result":"Falha ao analisar JSON.  Resulto cru",
+    "Model Schema":"Esquema do modelo",
+    "Model":"Modelo",
+    "apply":"Aplicar",
+    "Username":"Usuário",
+    "Password":"Senha",
+    "Terms of service":"Termos de serviço",
+    "Created by":"Criado por",
+    "See more at":"Veja mais em",
+    "Contact the developer":"Contate o desenvolvedor",
+    "api version":"Versão da api",
+    "Response Content Type":"Tipo do conteúdo de resposta",
+    "fetching resource":"buscar recurso",
+    "fetching resource list":"buscar lista de recursos",
+    "Explore":"Explorar",
+    "Show Swagger Petstore Example Apis":"Show Swagger Petstore Example Apis",
+    "Can't read from server.  It may not have the appropriate access-control-origin settings.":"Não é possível ler do servidor. Ele pode não ter as configurações apropriadas de access-control-origin",
+    "Please specify the protocol for":"Por favor especifique o protocolo",
+    "Can't read swagger JSON from":"Não é possível ler o JSON Swagger de",
+    "Finished Loading Resource Information. Rendering Swagger UI":"Carregamento de informação de recurso finalizada. Renderizando Swagger UI",
+    "Unable to read api":"Não foi possível ler a api",
+    "from path":"do caminho",
+    "server returned":"servidor retornou",
+    "Example Value":"Exemplo de Valores"
+});

lib/swagger-oauth.js

@@ -53,7 +53,7 @@ function handleLogin() {
         '<ul class="api-popup-scopes">',
         '</ul>',
         '<p class="error-msg"></p>',
-        '<div class="api-popup-actions"><button class="api-popup-authbtn api-button green" type="button">Authorize</button><button class="api-popup-cancel api-button gray" type="button">Cancel</button></div>',
+        '<div class="api-popup-actions"><button class="api-popup-authbtn api-button green" type="button" data-sw-translate>Authorize</button><button class="api-popup-cancel api-button gray" type="button">Cancel</button></div>',
       '</div>',
       '</div>'].join(''));
   $(document.body).append(popupDialog);

package.json

@@ -8,7 +8,7 @@
     }
   ],
   "description": "Swagger UI is a dependency-free collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API",
-  "version": "2.2.9",
+  "version": "2.2.10",
   "homepage": "http://swagger.io",
   "license": "Apache-2.0",
   "main": "dist/swagger-ui.js",
@@ -63,6 +63,6 @@
     "run-sequence": "^1.2.2",
     "selenium-webdriver": "^2.45.0",
     "sinon-chai": "2.8.0",
-    "swagger-client": "2.1.28"
+    "swagger-client": "2.1.32"
   }
 }

src/main/javascript/helpers/handlebars.js

@@ -23,7 +23,7 @@ Handlebars.registerHelper('sanitize', function (text) {
 
 Handlebars.registerHelper('renderTextParam', function(param) {
     var result, type = 'text', idAtt = '';
-    var paramType = param.type || param.schema && param.schema.type || '';
+    var paramType = (param.schema) ? param.type || param.schema.type || '' : param.type || ''; 
     var isArray = paramType.toLowerCase() === 'array' || param.allowMultiple;
     var defaultValue = isArray && Array.isArray(param.default) ? param.default.join('\n') : param.default;
     var name = Handlebars.Utils.escapeExpression(param.name);

src/main/less/specs.less

@@ -44,6 +44,26 @@
     table {
         border-collapse: collapse;
         border-spacing: 0;
+       .param-name-col {
+          width: 100px; 
+          max-width: 100px;
+        }
+        .param-value-col {
+          width: 310px; 
+          max-width: 310px;
+        }
+        .param-description-col {
+          width: 200px; 
+          max-width: 200px;
+        }
+        .param-type-col {
+          width: 100px; 
+          max-width: 100px;
+        }
+        .param-data-type-col {
+          width: 220px; 
+          max-width: 230px;
+        }
         thead {
             tr {
                 th {

src/main/template/auth_button.handlebars

@@ -1 +1 @@
-<a class='authorize__btn' href="#">Authorize</a>
+<a class='authorize__btn' href="#" data-sw-translate>Authorize</a>

src/main/template/operation.handlebars

@@ -72,11 +72,11 @@
           <table class='fullwidth parameters'>
           <thead>
             <tr>
-            <th style="width: 100px; max-width: 100px" data-sw-translate>Parameter</th>
-            <th style="width: 310px; max-width: 310px" data-sw-translate>Value</th>
-            <th style="width: 200px; max-width: 200px" data-sw-translate>Description</th>
-            <th style="width: 100px; max-width: 100px" data-sw-translate>Parameter Type</th>
-            <th style="width: 220px; max-width: 230px" data-sw-translate>Data Type</th>
+            <th class="param-name-col" data-sw-translate>Parameter</th>
+            <th class="param-value-col" data-sw-translate>Value</th>
+            <th class="param-description-col" data-sw-translate>Description</th>
+            <th class="param-type-col" data-sw-translate>Parameter Type</th>
+            <th class="param-data-type-col" data-sw-translate>Data Type</th>
             </tr>
           </thead>
           <tbody class="operation-params">

src/main/template/param.handlebars

@@ -29,7 +29,7 @@
 	{{/if}}
 
 </td>
-<td class="markdown">{{{sanitize description}}}</td>
+<td class="markdown param-description-col">{{{sanitize description}}}</td>
 <td>{{{escape paramType}}}</td>
 <td>
 	<span class="model-signature"></span>

src/main/template/param_list.handlebars

@@ -14,6 +14,6 @@
 
   </select>
 </td>
-<td class="markdown">{{#if required}}<strong>{{/if}}{{{description}}}{{#if required}}</strong>{{/if}}</td>
+<td class="markdown param-description-col">{{#if required}}<strong>{{/if}}{{{description}}}{{#if required}}</strong>{{/if}}</td>
 <td>{{{escape paramType}}}</td>
 <td><span class="model-signature"></span></td>

src/main/template/param_readonly.handlebars

@@ -11,6 +11,6 @@
         {{/if}}
     {{/if}}
 </td>
-<td class="markdown">{{{sanitize description}}}</td>
+<td class="markdown param-description-col">{{{sanitize description}}}</td>
 <td>{{{escape paramType}}}</td>
 <td><span class="model-signature"></span></td>

src/main/template/param_readonly_required.handlebars

@@ -10,6 +10,6 @@
         {{/if}}
     {{/if}}
 </td>
-<td class="markdown">{{{sanitize description}}}</td>
+<td class="markdown param-description-col">{{{sanitize description}}}</td>
 <td>{{{escape paramType}}}</td>
 <td><span class="model-signature"></span></td>

src/main/template/param_required.handlebars

@@ -26,7 +26,7 @@
 	{{/if}}
 </td>
 <td>
-	<strong><span class="markdown">{{{sanitize description}}}</span></strong>
+	<strong><span class="markdown param-description-col">{{{sanitize description}}}</span></strong>
 </td>
 <td>{{{escape paramType}}}</td>
 <td><span class="model-signature"></span></td>

src/main/template/templates.js

@@ -23,7 +23,7 @@ templates['apikey_auth'] = template({"1":function(container,depth0,helpers,parti
     + "        </div>\n    </div>\n</div>\n";
 },"useData":true});
 templates['auth_button'] = template({"compiler":[7,">= 4.0.0"],"main":function(container,depth0,helpers,partials,data) {
-    return "<a class='authorize__btn' href=\"#\">Authorize</a>\n";
+    return "<a class='authorize__btn' href=\"#\" data-sw-translate>Authorize</a>\n";
 },"useData":true});
 templates['auth_button_operation'] = template({"1":function(container,depth0,helpers,partials,data) {
     return "        authorize__btn_operation_login\n";