diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d47a356..28706fbf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,25 @@ + +# [1.15.0](https://github.com/Rebilly/ReDoc/compare/v1.14.0...v1.15.0) (2017-05-05) + + +### Bug Fixes + +* menu items not full-width on short item names ([ef1b2bd](https://github.com/Rebilly/ReDoc/commit/ef1b2bd)) +* menu service subscription leak ([bb00dc3](https://github.com/Rebilly/ReDoc/commit/bb00dc3)) +* openapi button: add `download` attribute ([583c571](https://github.com/Rebilly/ReDoc/commit/583c571)) +* sample unavailable when no schema in response object ([1eedbfe](https://github.com/Rebilly/ReDoc/commit/1eedbfe)) +* Slugifying non-ascii headers make duplicate permalinks ([#264](https://github.com/Rebilly/ReDoc/issues/264)) ([6edbbe7](https://github.com/Rebilly/ReDoc/commit/6edbbe7)) +* typo in download button classname (thanks [@dwilding](https://github.com/dwilding)) ([6b363a5](https://github.com/Rebilly/ReDoc/commit/6b363a5)) +* firefox and IE scroll sync after deps update ([ad04636](https://github.com/Rebilly/ReDoc/commit/ad04636)) + + + +### Features + +* add triangle icon for expandable menu items ([e7130d2](https://github.com/Rebilly/ReDoc/commit/e7130d2)) +* clear button (x) in search box ([0341db4](https://github.com/Rebilly/ReDoc/commit/0341db4)) + + # [1.14.0](https://github.com/Rebilly/ReDoc/compare/v1.13.0...v1.14.0) (2017-04-23) diff --git a/README.md b/README.md index bfc29f43..068a26be 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # ReDoc **OpenAPI/Swagger-generated API Reference Documentation** -[![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) [![Dependency Status](https://gemnasium.com/badges/github.com/Rebilly/ReDoc.svg)](https://gemnasium.com/github.com/Rebilly/ReDoc) [![Stories in Ready](https://badge.waffle.io/Rebilly/ReDoc.png?label=ready&title=Ready)](https://waffle.io/Rebilly/ReDoc) +[![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) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/Rebilly/redoc.svg)](http://isitmaintained.com/project/Rebilly/redoc "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/REBILLY/REDOC.svg)](http://isitmaintained.com/project/REBILLY/REDOC "Percentage of issues still open") diff --git a/build/prepare_deploy.js b/build/prepare_deploy.js index 0f20b486..566eae61 100755 --- a/build/prepare_deploy.js +++ b/build/prepare_deploy.js @@ -16,10 +16,10 @@ mkdir('-p', 'dist'); cp('-R', '../dist/*', './dist/'); cd('..'); -var version = 'v' + require(path.join(__dirname, '../package.json')).version + '/'; -var versionDir = path.join(paths.releases, version); +var version = require(path.join(__dirname, '../package.json')).version; +var versionDir = path.join(paths.releases, 'v' + version + '/'); var latestDir = path.join(paths.releases, 'latest/'); -var v1Dir = path.join(paths.releases, 'v1.x.x/'); +var v1Dir = path.join(paths.releases, 'v' + version.split('.')[0] + '.x.x/'); mkdir('-p', versionDir) mkdir('-p', latestDir); mkdir('-p', v1Dir); diff --git a/lib/app.module.ts b/lib/app.module.ts index 5892f23c..37ee2c5a 100644 --- a/lib/app.module.ts +++ b/lib/app.module.ts @@ -1,12 +1,11 @@ import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; -import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { RedocModule } from './redoc.module'; import { Redoc } from './components/index'; @NgModule({ - imports: [ BrowserModule, BrowserAnimationsModule, RedocModule ], + imports: [ BrowserModule, RedocModule ], bootstrap: [ Redoc ], exports: [ Redoc ] }) diff --git a/lib/components/ApiInfo/api-info.html b/lib/components/ApiInfo/api-info.html index 294517b9..d9d5094f 100644 --- a/lib/components/ApiInfo/api-info.html +++ b/lib/components/ApiInfo/api-info.html @@ -1,8 +1,8 @@

{{info.title}} ({{info.version}})

-

+

Download OpenAPI (fka Swagger) specification: - Download + Download

diff --git a/lib/components/Redoc/redoc.ts b/lib/components/Redoc/redoc.ts index e8ed1124..f54f3a1c 100644 --- a/lib/components/Redoc/redoc.ts +++ b/lib/components/Redoc/redoc.ts @@ -78,7 +78,7 @@ export class Redoc extends BaseComponent implements OnInit { //parse options (top level component doesn't support inputs) optionsMgr.parseOptions( this.element ); let scrollParent = detectScollParent( this.element ); - if (scrollParent === DOM.defaultDoc().body) scrollParent = window; + if (scrollParent === (document.scrollingElement || document.documentElement)) scrollParent = window; optionsMgr.options.$scrollParent = scrollParent; this.options = optionsMgr.options; this.lazyTasksService.allSync = !this.options.lazyRendering; diff --git a/lib/components/SchemaSample/schema-sample.ts b/lib/components/SchemaSample/schema-sample.ts index c89a77e6..a774bd91 100644 --- a/lib/components/SchemaSample/schema-sample.ts +++ b/lib/components/SchemaSample/schema-sample.ts @@ -33,7 +33,7 @@ export class SchemaSample extends BaseComponent implements OnInit { init() { this.bindEvents(); - let base:any = {}; + let base:any = this.componentSchema; let sample; // got pointer not directly to the schema but e.g. to the response obj diff --git a/lib/components/Search/redoc-search.html b/lib/components/Search/redoc-search.html index 5c7becf6..aef24371 100644 --- a/lib/components/Search/redoc-search.html +++ b/lib/components/Search/redoc-search.html @@ -1,4 +1,5 @@

+
×
diff --git a/lib/components/Search/redoc-search.scss b/lib/components/Search/redoc-search.scss index 8b25e5c7..601917af 100644 --- a/lib/components/Search/redoc-search.scss +++ b/lib/components/Search/redoc-search.scss @@ -18,12 +18,24 @@ fill: lighten($text-color, 20%); } } + + .clear-button { + position: absolute; + display: inline-block; + width: 13px; + text-align: center; + right: 20px; + height: 28px; + line-height: 28px; + vertical-align: middle; + cursor: pointer; + } } input { width: 100%; box-sizing: border-box; - padding: 5px 5px 5px 20px; + padding: 5px 20px 5px 20px; border: 0; border-bottom: 1px solid darken($side-bar-bg-color, 10%); diff --git a/lib/components/Search/redoc-search.ts b/lib/components/Search/redoc-search.ts index 5cf8b286..96b85ea2 100644 --- a/lib/components/Search/redoc-search.ts +++ b/lib/components/Search/redoc-search.ts @@ -38,6 +38,11 @@ export class RedocSearch implements OnInit { this.search.indexAll(); } + clearSearch() { + this.searchTerm = ''; + this.updateSearch(); + } + update(event:KeyboardEvent, val) { if (event && event.keyCode === 27) { // escape this.searchTerm = ''; diff --git a/lib/components/SideMenu/side-menu-items.html b/lib/components/SideMenu/side-menu-items.html index 74e72a90..8010e404 100644 --- a/lib/components/SideMenu/side-menu-items.html +++ b/lib/components/SideMenu/side-menu-items.html @@ -3,8 +3,11 @@ -