redoc/CHANGELOG.md

1.15.0 (2017-05-05)

Bug Fixes

• menu items not full-width on short item names (ef1b2bd)
• menu service subscription leak (bb00dc3)
• openapi button: add download attribute (583c571)
• sample unavailable when no schema in response object (1eedbfe)
• Slugifying non-ascii headers make duplicate permalinks (#264) (6edbbe7)
• typo in download button classname (thanks @dwilding) (6b363a5)
• firefox and IE scroll sync after deps update (ad04636)

Features

• add triangle icon for expandable menu items (e7130d2)
• clear button (x) in search box (0341db4)

1.14.0 (2017-04-23)

Bug Fixes

• don't show download button if initialized with an object (476d6c4)
• endpoint link doesn't expand when click on arrow (9248cc2)
• markdown block text color 💅 (0f6f035), closes #255
• ReDoc removes path if site is using history API (c77e1a2), closes #257
• remove trailing slash from url when use x-servers (2760a34)
• subscription leak in side-menu (838f233)

Features

• add GH-like anchors to h1 and h2 headings in md (bb3667d)
• add perfect-scrollbar for side menu (cdeee67)
• emphasize path with primary color in servers dropdown (388b3d4)
• new option path-in-middle-panel (74a3193)
• SideMenu to support items template as a parameter (8a49fb3)

1.13.0 (2017-04-19)

Bug Fixes

• fix issue with loading https spec (585b9cf), closes #243 (by Khoa Tran)
• UL missing css (303b49e), closes #248
• don't show contact info if it is empty object (6077cc6)
• code block formatting in markdown list (a9cad19), closes #242

Features

• HTTP verbs badges in side menu (92eec25), closes #61
• HTTP verbs badges in search results (61fd426)
• new option no-auto-auth to disable authentication section auto adding (00b304a)

1.12.1 (2017-04-19)

Bug Fixes

• fix: use replace state instead of pushState (4f4e748), closes #244

1.12.0 (2017-04-19)

Bug Fixes

• add safeguard for undefined (aaac434), closes #236
• view errors were not reported (6aa3a7d)

Features

• Support x-examples vendor extension for requests (by @brendo)

Other

• Updated to Angular 4, bundle is a bit smaller now

1.11.0 (2017-03-09)

Bug Fixes

• do not hang when swagger doesn't contain any paths (e4f5388), closes #216 #201
• optimize and support inherited discriminator (64e5741)
• redoc hangs when indexing recursive discriminator-based definitions (1e96f88)
• wrong warnings for $ref not single (193f4bf), closes #221
• x-extendedDiscriminator not working (4899f3e), closes #217

Features

• copy pretty-printed JSON (e99d66d), closes #219
• support for OpenAPI object as a parameter for init (d99f256), closes #224

1.10.2 (2017-03-01)

Bug Fixes

• clear page fragment when scroll to the beginning
• update docs for x-tagGroup, add warning #215
• show warning for non-used in tagGroup tags

1.10.1 (2017-02-27)

Bug Fixes

• improve x-servers dropdown animation performance (69c7d98)

1.10.0 (2017-02-27)

Bug Fixes

• Revert: remove unused hide-hostname option (7031176)

Features

• new option required-props-first (c724df4), closes #191
• update fragment while scrolling and on menu clicks (66c06b3), closes #138 #202

1.9.0 (2017-02-25)

Bug Fixes

• do not crash if version is not string (accd016), closes #208
• long paths break EndpointLink ui (8472045)
• remove unused hide-hostname option (7031176)

Features

• Add support for x-servers (fd49082)
• Color of "default" Response depends on other successful responses are specified (9d0dd25), closes #197
• improved type string with minLength == maxLength (e76bcc3), closes #212
• show type string with minLength 1 as "non-empty" (d175a4d), closes #192

1.8.1 (2017-02-23)

Bug Fixes

• Fix toggle icon width on IE, closes #198
• Add safe guards array without items, closes #199
• Fix extra slash if basePath is not present (a5c03ab), closes #201
• response samples - render description as markdown (4acfc11), closes #190
• take snapshot of schema to not overwrite inlined references (77bc3c4), closes #203
• use items description if not present on top level (23e7847)

Features

• autoscroll menu (b43a87d)

1.8.0 (2017-02-03)

Features/Improvements

• In-page search 🎉 []#51](https://github.com/Rebilly/ReDoc/issues/51)
• Render externalDocs #103
• Undeprecate x-traitTag

Bug fixes

• Tags with x-traitTag: true are now greyed out in ReDoc output bug #194
• CSS: request body model-tree wrapping problem #185
• Strange request to example.com causing CSP error #178
• Fix latest empty menu-items not getting active #194
• Fixed crash when level-2 heading goes before level-1 in description #179 (by @jsmartfo)

1.7.0 (2017-01-06)

Features/Improvements

• Add support for grouping items in menu via x-tagGroups
• Support inherited discriminator (only one at the moment)
• Add support for second-level headings from Markdown docs (by @jaingaurav)

Bug fixes

• Fix response list for shared schemas (fixes #177)
• Fix right panel overlaps site-footer

1.6.4 (2016-12-28)

Bug fixes

• Fix crash on MS Edge (fixes #166)
• Uncomment animation after upgrade to the latest ng2 (resolves #162)

1.6.3 (2016-12-19)

Bug fixes

• Disable side-menu animation (workaround for #162)
• Use markdown for response description (fixes #158)
• Fix leaks (fixes #167)
• Update webpack and stick to ts@2.0.9 (fixes #169, #168)

Features/Improvements

• add expand-responses option - specify which responses are expand by default (#165).

1.6.2 (2016-12-11)

Bug fixes

• Use markdown in responses description (#158)

Features/Improvements

• x-displayName for tags - by @bfirsh (PR #152)

1.6.1 (2016-12-02)

Bug fixes

• Fix only the first instance of schema was rendered (#150)
• Regression: fix side panel overlaps footer
• Fix menu was not initialized for specs without tags

Features/Improvements

• Don't show error screen for runtimes after render finished
• Updated dependencies (angular to the latest version + dev deps)

1.6.0 (2016-11-30)

Bug fixes

• Update webpack to the latest beta (#143)
• Fix read-only fields appear in request samples (#142)
• A few more minor UI improvemnts

Features/Improvements

• Major performance optimization with new option lazy-rendering

To enable use <redoc> tag parameter: <redoc spec-url="..." lazy-rendering></redoc>. In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the demo for the example.

• Enable cors-proxy for demo
• README: Add button link to yeoman-generator

1.5.2 (2016-11-28)

Bug fixes

• Fix crashing on array without items (#104)
• Fix allOf within array items (#136)
• Fix reference resolution from external files (#96)
• Fix object to become an array (#146)

Features/Improvements

• Add support for Swagger collectionFormat
• Wrap API version in span with class (#145)
• Update openapi-sampler to 0.3.3

1.5.1 (2016-10-31)

Bug fixes

• Fix content scrolling on language switch (#130)

Features/Improvements

• Support for Swagger pattern property (#42)
• Add option to hide hostname in method definition (by @bfirsh)
• Add Docker development environment (by @bfirsh)

1.5.0 (2016-10-31)

Bug fixes

• Fix side menu items wrong sync with description headers

Features/Improvements

• Support for Security Definitions
• Update angular2 to the 2.1.2

Deprecations

• Deprecate x-traitTag

Code refactoring

• Separate RedocModule from AppModule
• Get rid of angular facade/lang dependencies
• Error handler refactor

1.4.1 (2016-10-18)

Bug fixes

• Emit helpers for module build

1.4.0 (2016-10-14)

Bug fixes

• Fix destroy/reinit
• Fix minimum/maximum zero not rendered (#123)

Features/Improvements

• Do spec load after bootstrap
• Build and publish angular2 module (#126)

1.3.3 (2016-09-28)

Features/Improvements

• Implemented x-extendedDiscriminator to workaround name clashes in big specs
• Add engines to package.json (#83)
• Fix npm start on windows (#119, #118)
• Update webpack to latest beta
• Update angular to 2.0.1
• Update local dev steps
• Update openapi-sampler lib (#111)

1.3.2 (2016-09-13)

Bug fixes

• Fix broken tabs styling for response samples
• Fix v1.x.x deployment

1.3.1 (2016-09-13)

Bug fixes

• Makes basePath optional (by @LeFnord)
• Fixed little typo (by @adamd)
• Typo s/IGNORRED/IGNORED (by @MikeRalphson)
• Fixed indentation (by @bennyn)
• Fix default hostname (#108)
• Fix default value for falsy values is not displayed (#109)
• Fix schema collapse after change discriminator

Features/Improvements

• Update to latest Angular RC.6
• Smaller bundle size by removing esprima dep from bundle
• Updated dependencies

1.3.0 (2016-08-31)

Bug fixes

• Fix code samples are not shown for operations without body param (#93)
• Fixed side menu overlapped site footer (#75)
• Fix broken order in discriminator dropdown

Features/Improvements

• Support "x-nullable" property by @kedashoe (#92)

1.2.0 (2016-08-30)

Bug fixes

• Fix sticky sidebar top sticking (#75)
• Fix array inside objects if referenced directly (#84)
• Add banner to the bundle file (#89)
• Fix broken additionalProperties
• Fix version render issue (extra "v" letter)

Features/Improvements

• Change the way discriminator is rendered
• Created CDN major release 1.x.x (#87)
• Smaller bundle size (371KB gzipped)
• Better start-up time due to AoT

Code refactoring

• Moved build-system to Webpack
• Moved to latest Typescript + get rid of typings
• Upgrade to the latest Angular2 RC.5

1.1.2 (2016-08-21)

Bug fixes

• Revert "Fix markdown newlines to be GFM" (#82)
• Move license and contact info above description

1.1.1 (2016-08-21)

Bug fixes

• Fix markdown newlines to be GFM (#82)
• Fix markdown code blocks in api description

1.1.0 (2016-08-12)

Bug fixes

• Fix API description width on mobile
• Render valid JSON in samples (quoted object keys)

Features/Improvements

• Add Tuple support (arrays with separate schema for each value) (#69)
• Add special representation for enum with one value (#70)
• Change < * > notation to < anything >

1.0.1 (2016-08-01)

Bug fixes

• Use api host if schema host is undefined