test: fix e2e

fixes #1036

.travis.yml

@@ -29,7 +29,7 @@ deploy:
     skip_cleanup: true
     email: gotsijroman@gmail.com
     api_key:
-      secure: PuhWLERrCEFmXmdFpw2OVFlqpOIVDmgwk5JUJOYaFdVCh/smp0+jZCQ4vrdFpuG96rnDVirD+A8xvW6NgsNNaRthLgOB/LRdFN69rU6Gvn3At6wlnC55t5dlhxPvCfnzJcHVBLXX4EmMkjnZqDg2uczXTzPodr3FnQJNuXmP8B33fzDVLyHccvXZ90abwXWVrgRIXPU28niqCR8DOC2OTzs7wqz+BLNkYDRRbyYXsg62HWuD33x5iof5IqBmhzBt3usCGmF3QGcgHrXHdZw3sZnit8+Bua++3KrXR0x6HGXXN1AoXVmCAkCa5OTQ5R3tCRxiJN3P2KLnvWeZR74sTFkovJB/6pGCvbJ/c7Wnuw6sD7SgOUBD359ULB6lAf5OnxBLoNebX4JxxVXF+zA4E3Bl44VxkzDpPWc15xqBPMB5vBREzMVmJ5mExn2s5cmLQjADbl9h0y6gZnhnNJ+iTmqtrVyM0ZkF2rPrzrTdGD+ULmRIlTMkdD1bh+/TJ3RdXT3P4/zNUJmiNnvgnnJVYYvsGaXWF+7uCVHT/8k2RsoSHqgkqh0gkDqGSwVix55y5mC7T2Vk9lMBhm6MvFJXaonOX0kxJS4EDQ3plPd6/ybG+TLhwggYnQ8o9msU5Nt6FpUShKiezjKurIhbQZdwlVivX3tahjW2QjNDO58xGgY=
+      secure: TJlRyyXdH/lSRKQkV1RQ0cAWGY5Go0IxWmCV+q4LQPtaisqvZJDu9FG0vFSDYAncDGkUkhgy3CNMl+6T5U21LDNz3pt7Uy8LIbJpVGW3aIlWDO14oVd6pjDwGT/72P3+sL/5Bsr/rhVqe7N3o49xdfE8kM3PBeJwFfwynYvWuegTy7LnbQTAWNv7MJXnM/fwNS0Yo5hfm7VhIBgac1o9mEiklX0DBk189rva45Q95nG2t6Me6dS+TYXDXN1cDuPIAqBxINNWEbIFXCJv9Wq3uEicS3zyoso0tEwtdSJh2zkhc7wEZRGvMpzMmkY5C5vS7QgkJBpvlc/aFqJvkp1wJMEwU4Ti6T6/PR05yJCKmam/FE49iMuy3CnaWm/NfExxEHRyIvfR8ZQxqXrzEkSZSG9tHNVynaF53dGLSU9swk5bR6Ru9ROTwijxwZjzr2qsdUCSXk+zIbE6+s2zDwJm3FIpAMhbRjCo5+sDxO6q8+Lhi4ugffEB7UsN6Vo9m/HcUOcmCiqwx4AriNBrvFocs5koW0pWpTLql+MMCJMlh5lE86oc4/PdUysZgh7afPUalBWTdE0E3TGRm89f27QgDxnPMMH1OFuuSPXrf405gDy8oBh+MnXBEAq/pIRf+DnK6ja/T7aPdOVpb2pfe3y4Zjq8ThnXvjSI68hptQsifGs=
     on:
       tags: true
       condition: $JOB != e2e-guru

CHANGELOG.md

@@ -1,3 +1,24 @@
+<a name="1.22.2"></a>
+## [1.22.1](https://github.com/Rebilly/ReDoc/compare/v1.22.0...v1.22.1) (2018-09-10)
+
+
+### Bug Fixes
+
+* crash when using code-samples ([fb7adb6](https://github.com/Rebilly/ReDoc/commit/fb7adb6))
+* ip addresses not supported as host ([#616](https://github.com/Rebilly/ReDoc/issues/616)) ([3b008a1](https://github.com/Rebilly/ReDoc/commit/3b008a1))
+
+<a name="1.22.1"></a>
+## [1.22.1](https://github.com/Rebilly/ReDoc/compare/v1.22.0...v1.22.1) (2018-09-10)
+
+Broken release (unpublished)
+
+<a name="1.22.0"></a>
+# [1.22.0](https://github.com/Rebilly/ReDoc/compare/v1.21.2...v1.22.0) (2018-05-02)
+
+### Bug Fixes
+
+* pinpoint version of hint.css to 2.3.2 to prevent licensing issue [#478](https://github.com/Rebilly/ReDoc/issues/478), reported by [@rickity-cricket](https://github.com/rickity-cricket)
+
 <a name="1.21.2"></a>
 ## [1.21.2](https://github.com/Rebilly/ReDoc/compare/v1.21.1...v1.21.2) (2018-02-26)
 

README.md

@@ -4,6 +4,9 @@
 <p align="center">
     <b>OpenAPI/Swagger-generated API Reference Documentation</b>
 </p>
+<p align="center">
+  <b> This is README for `1.x` version of ReDoc. `2.x` README is on <a href="https://github.com/Rebilly/ReDoc">the master branch</a></b>
+</p>
 
 [![Build Status](https://travis-ci.org/Rebilly/ReDoc.svg?branch=master)](https://travis-ci.org/Rebilly/ReDoc) [![Coverage Status](https://coveralls.io/repos/Rebilly/ReDoc/badge.svg?branch=master&service=github)](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [![Tested on APIs.guru](http://api.apis.guru/badges/tested_on.svg)](https://APIs.guru) [![dependencies Status](https://david-dm.org/Rebilly/ReDoc/status.svg)](https://david-dm.org/Rebilly/ReDoc) [![devDependencies Status](https://david-dm.org/Rebilly/ReDoc/dev-status.svg)](https://david-dm.org/Rebilly/ReDoc#info=devDependencies) [![Stories in Ready](https://badge.waffle.io/Rebilly/ReDoc.png?label=ready&title=Ready)](https://waffle.io/Rebilly/ReDoc)
 

lib/services/schema-normalizer.service.ts

@@ -229,11 +229,18 @@ export class SchemaDereferencer {
     if ( keysCount > 2 || (keysCount === 2 && !schema.description) ) {
       WarningsService.warn(`Other properties are defined at the same level as $ref at "#${pointer}". ` +
         'They are IGNORED according to the JsonSchema spec');
-      resolved.description = resolved.description || schema.description;
     }
 
     resolved = this.normalizator.normalize(resolved, $ref);
     this._refCouner.exit($ref);
+
+    // schema description should always override $ref description
+    if (schema.description) {
+      // make a copy of resolved object with updated description, do not globally override the description
+      resolved = Object.assign({}, resolved);
+      resolved.description = schema.description;
+    }
+
     return resolved;
   }
 }

lib/utils/spec-manager.ts

@@ -67,8 +67,8 @@ export class SpecManager {
   /* calculate common used values */
   init() {
     let urlParts = this.specUrl ? urlParse(urlResolve(window.location.href, this.specUrl)) : {
-      protocol: undefined,
-      host: undefined
+      protocol: window.location.protocol,
+      host: window.location.host
     };
     let schemes = this._schema.schemes;
     let protocol;

lib/vendor.ts

@@ -1,8 +1,10 @@
 import 'prismjs';
+import 'prismjs/components/prism-clike.js';
 import 'prismjs/components/prism-actionscript.js';
 import 'prismjs/components/prism-c.js';
 import 'prismjs/components/prism-cpp.js';
 import 'prismjs/components/prism-csharp.js';
+import 'prismjs/components/prism-markup-templating.js'; // dep of php
 import 'prismjs/components/prism-php.js';
 import 'prismjs/components/prism-coffeescript.js';
 import 'prismjs/components/prism-go.js';

package.json

@@ -1,7 +1,7 @@
 {
   "name": "redoc",
   "description": "Swagger-generated API Reference Documentation",
-  "version": "1.21.2",
+  "version": "1.22.3",
   "repository": {
     "type": "git",
     "url": "git://github.com/Rebilly/ReDoc"
@@ -125,7 +125,7 @@
   "dependencies": {
     "core-js": "^2.5.1",
     "dropkickjs": "~2.1.10",
-    "hint.css": "^2.3.2",
+    "hint.css": "2.3.2",
     "https-browserify": "^1.0.0",
     "json-pointer": "^0.6.0",
     "json-schema-ref-parser": "^3.3.1",
@@ -137,7 +137,7 @@
     "remarkable": "1.7.1",
     "scrollparent": "^2.0.1",
     "slugify": "^1.2.1",
-    "stream-http": "^2.6.1",
+    "stream-http": "2.7.2",
     "ts-helpers": "^1.1.2",
     "zone.js": "^0.8.17"
   }

tests/e2e/index.html

@@ -14,7 +14,7 @@
     <script>
       window.redocError = null;
       /* init redoc */
-      var url = window.location.search.substr(5) || 'http://rebilly.github.io/ReDoc/swagger.yaml';
+      var url = window.location.search.substr(5) || 'http://redocly.github.io/redoc/swagger.yaml';
       Redoc.init(decodeURIComponent(url), {disableLazySchemas: true, suppressWarnings: true}).then(function() {}, function(err) {
         window.redocError = err;
       });

yarn.lock

@@ -1046,9 +1046,9 @@ clean-css@3.4.x, clean-css@^3.4.9:
     commander "2.8.x"
     source-map "0.4.x"
 
-clipboard@^1.7.1:
-  version "1.7.1"
-  resolved "https://registry.yarnpkg.com/clipboard/-/clipboard-1.7.1.tgz#360d6d6946e99a7a1fef395e42ba92b5e9b5a16b"
+clipboard@^2.0.0:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/clipboard/-/clipboard-2.0.1.tgz#a12481e1c13d8a50f5f036b0560fe5d16d74e46a"
   dependencies:
     good-listener "^1.2.2"
     select "^1.1.2"
@@ -2957,9 +2957,9 @@ he@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/he/-/he-1.1.1.tgz#93410fd21b009735151f8868c2f271f3427e23fd"
 
-hint.css@^2.3.2:
-  version "2.5.0"
-  resolved "https://registry.yarnpkg.com/hint.css/-/hint.css-2.5.0.tgz#38cae3667e42d91dfddbe503100ab34932f6fd65"
+hint.css@2.3.2:
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/hint.css/-/hint.css-2.3.2.tgz#d9c0b604745f4b88e91af2a16e5861540c4c4d9d"
 
 hmac-drbg@^1.0.0:
   version "1.0.1"
@@ -5255,15 +5255,20 @@ preserve@^0.2.0:
   resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"
 
 prismjs@^1.8.1:
-  version "1.10.0"
-  resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.10.0.tgz#77e5187c2ae6b3253fcc313029cf25fe53778721"
+  version "1.15.0"
+  resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.15.0.tgz#8801d332e472091ba8def94976c8877ad60398d9"
   optionalDependencies:
-    clipboard "^1.7.1"
+    clipboard "^2.0.0"
 
 process-nextick-args@~1.0.6:
   version "1.0.7"
   resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-1.0.7.tgz#150e20b756590ad3f91093f25a4f2ad8bff30ba3"
 
+process-nextick-args@~2.0.0:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2"
+  integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==
+
 process@^0.11.10:
   version "0.11.10"
   resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182"
@@ -5492,6 +5497,19 @@ readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.6, readable
     string_decoder "~1.0.3"
     util-deprecate "~1.0.1"
 
+readable-stream@^2.2.6:
+  version "2.3.6"
+  resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.6.tgz#b11c27d88b8ff1fbe070643cf94b0c79ae1b0aaf"
+  integrity sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==
+  dependencies:
+    core-util-is "~1.0.0"
+    inherits "~2.0.3"
+    isarray "~1.0.0"
+    process-nextick-args "~2.0.0"
+    safe-buffer "~5.1.1"
+    string_decoder "~1.1.1"
+    util-deprecate "~1.0.1"
+
 readable-stream@~1.0.2:
   version "1.0.34"
   resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c"
@@ -6405,7 +6423,18 @@ stream-combiner@~0.0.4:
   dependencies:
     duplexer "~0.1.1"
 
-stream-http@^2.6.1, stream-http@^2.7.2:
+stream-http@2.7.2:
+  version "2.7.2"
+  resolved "https://registry.yarnpkg.com/stream-http/-/stream-http-2.7.2.tgz#40a050ec8dc3b53b33d9909415c02c0bf1abfbad"
+  integrity sha512-c0yTD2rbQzXtSsFSVhtpvY/vS6u066PcXOX9kBB3mSO76RiUQzL340uJkGBWnlBg4/HZzqiUXtaVA7wcRcJgEw==
+  dependencies:
+    builtin-status-codes "^3.0.0"
+    inherits "^2.0.1"
+    readable-stream "^2.2.6"
+    to-arraybuffer "^1.0.0"
+    xtend "^4.0.0"
+
+stream-http@^2.7.2:
   version "2.8.0"
   resolved "https://registry.yarnpkg.com/stream-http/-/stream-http-2.8.0.tgz#fd86546dac9b1c91aff8fc5d287b98fafb41bc10"
   dependencies:
@@ -6463,6 +6492,13 @@ string_decoder@~0.10.x:
   version "0.10.31"
   resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-0.10.31.tgz#62e203bc41766c6c28c9fc84301dab1c5310fa94"
 
+string_decoder@~1.1.1:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8"
+  integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==
+  dependencies:
+    safe-buffer "~5.1.0"
+
 stringstream@~0.0.4, stringstream@~0.0.5:
   version "0.0.5"
   resolved "https://registry.yarnpkg.com/stringstream/-/stringstream-0.0.5.tgz#4e484cd4de5a0bbbee18e46307710a8a81621878"