redoc/CHANGELOG.md

2.0.0-alpha.21 (2018-05-28)

Bug Fixes

• add tslib dependency (8e1a5cb)
• cli: escape \u2029 \u2028 characters (5018473), closes #475
• reduce search index size (a1fa4b4)
• replace "oops" with field name 🙈 (6b1e8e7)
• specify caption-side (64801b0), closes #509

Features

• export TypeScript typings (9115be8)
• new theme colors: code and codeBg (f8b793d)
• new theme option: nestingSpacing (782ef77)

2.0.0-alpha.20 (2018-05-14)

Bug Fixes

• fix worker is not defined in lib bundle (6a5513e)

2.0.0-alpha.19 (2018-05-14)

Bug Fixes

• change look of additionalProperties (126c6a6)
• disable chrome tap-highlight on mobile (09cbe88)
• fix @observer on PureComponent warning (afb11d6)
• fix build caused by new babel decorators syntax, fixes #487 (01f575c)
• fix prism lang dependencies, fixes #467 (42cf18e)
• fix spelling in error message (#455) (64119c4)
• limit height of discriminator dropdown, fixes #484 (6d1a9e5)
• path parameters are not correctly override, fixes #481 (2cf4c3c)

Features

• display scope description as markdown, fixes #466 (0d6deff)

2.0.0-alpha.18 (2018-03-23)

Bug Fixes

• fix logo width (384c883)
• modify the peerDependencies to reflect the need for react 16.3 (b29c329)
• scroll to section sooner when SSR + simplify item ids (d1d8042)
• cli: don't wait for content loaded in bundled HTML (d9ee2d0)

2.0.0-alpha.17 (2018-03-21)

Bug Fixes

• css fix + update theme (05403a7)
• cli: allow to set url to the spec in SSR mode (c9c6bc5)
• cli: fix crash (8891f5c)
• cli: fix output option type (c729c6c)
• cli: rename redoc-cli bin (06b5a00)
• fix second-level heading in description (a084532)
• make field type color more dark (closes #439) (d27e61a)

Features

• cli: add --template option (b7afce9)
• cli: add options to specify redoc options (2732c89)
• cli: add title option to bundle (bb8a678)
• add more options to theme (cbce28a)

1.21.2 (2018-02-26)

Bug Fixes

• missing properties when using complex allOf (regression) (6ce9245), closes #422

1.21.1 (2018-02-23)

Bug Fixes

• avoid endless recursion in schema-walker in some cases (309cc23), closes #418 #395
• fix crash when discriminator is used incorrectly (b1d928d)

1.21.0 (2018-02-18)

Bug Fixes

• null example not used in schema samples (420c51a), closes #415

Features

• new option hide-download-button (454e5bd), closes #394

1.20.0 (2018-01-21)

Bug Fixes

• Path parameters are not correctly overriden (c406dc5), closes #400
• Use parentNode instead of parentElement to fix IE11 crash (e8adb60), closes #406

Features

• align parameters to match up (#375) (d083c16)

Deprecations

• Dropped bower support. No more dist files on the releases branch.

2.0.0-alpha.15 (2018-03-16)

Bug Fixes

• fix broken css after installing polished (6018042)

Features

• more advanced theme engine (1df690a)

2.0.0-alpha.14 (2018-03-15)

Bug Fixes

• fix CLI crash + build it on travis (7769ba8)

2.0.0-alpha.13 (2018-03-15)

Bug Fixes

• A couple minor bug fixes (#436) (5dc21af)
• add extra null-check + warning (8757fa5)
• add logo width to the theme (28f2391)
• align logo by center (18ec3ac)
• discriminator dropdown showing incorrect field if sorted (bcf39dc)
• fix crash when referencing non-existing security scheme (1f7fc44)
• fix overflowing content in JSON samples (02c2413)
• fix right-panel blinking when scrolling + css improvements (a78f9ab)
• fix search-indexing for SSR (1428fb5)
• fix the media queries utils so it gets the values from the current theme (#420) (3924d3c)
• fix worker import (4896346)
• make ReactStandalone react on props changes (0cb0af2)
• merge inner properties of allOf (8926dd4)
• one-of dropdown not switching (0f1b6a6)
• referenced header name is empty (13165fb)
• skipReadOnly/skipWritOnly not passing down to nested array (6df8127)
• skipReadOnly/skipWritOnly not passing down to nested OneOf (2462639)
• various search fixes (b797c96)
• writeOnly not respected in response samples (87abdf7)

Features

• add clear icon to searchbox (825162e)
• add hideDownloadButton option (8dbe938)
• add marker (1ff2bd8)
• arrow navigation in search results (fe3245a)
• basis search (6990cd2)
• ReDoc CLI ✨ (390f6c1)
• reqired-first sort order for params (ecf33d2)
• serialize search-index (e94f842)

2.0.0-alpha.12 (2018-02-07)

Bug Fixes

• basic responsiveness (a29c3cc)
• crash in MarkdownRenderer on non-string (dead161)
• discriminator fix (ff3bb24)
• filter out non-existing security schemas + warn (ee822f6)
• fix oneOf title for array (1f3701d)
• fix tbody > tr nesting warning (a3cbb14)
• improve copy tooltip perf (29207cf)
• resolve menu synchronization issue (use proper throttle) (84d1c7b)

Features

• responsive side menu (3aab2d9)

2.0.0-alpha.11 (2018-01-29)

Bug Fixes

• courier misspelling (#409) (96fb7ce)
• crash on 2-level md heading at the beginning (e9f23f7)
• make active tab more clear (4b5df22)
• perfect scroll not working (199f240)
• use array items example (12f79f0), closes #408
• wrap text in code samples (6c71a66)

Features

• port "copy to clipboard" / "expand/collapse all" functionality (5bb0bdf), closes #410

2.0.0-alpha.9 (2018-01-11)

Bug Fixes

• handle scrollYOffset in ScrollService (dcab770)

2.0.0-alpha.8 (2018-01-10)

Bug Fixes

• undo section id + some minor fixes (0253c5d)

2.0.0-alpha.7 (2018-01-10)

Bug Fixes

• add id attr to headers to work before react is loaded if ssr (1743453)
• crate spec as data/base64 link when ssr (33678e6)
• example value is not showed if it is false (9756364)

2.0.0-alpha.6 (2018-01-10)

Bug Fixes

• allOf and deref exit not only named refs (435cccd)
• do not ignore path level parameters (14f8408)
• improve rendering of types (17da7b7)
• move title propagation to the correct place (0b0bc99)
• owerwrite text-align to left (bfee3ed)

Features

• initial display security requirements (50e2a58)

2.0.0-alpha.5 (2017-12-07)

Bug Fixes

• correct pointer for the schema (4ae1574)
• bundle in reftools in lib build (do not crash on prod builds in create-react-app) (57129d3)

2.0.0-alpha.4 (2017-11-24)

Bug Fixes

• add ellipsis for menu items with long words (3421be2)
• crashes on some dereferencing/allOf merging cases (335deb9)
• do not auto-append security-definitions if they are not in the spec (426e5b6)
• don't display operations without tags as tag items in menu (ca81b6d)

2.0.0-alpha.3 (2017-11-23)

Bug Fixes

• crash when $ref is url encoded (bdf6079)
• make oneOf not skip fields defined alongside (8680775)

2.0.0-alpha.2 (2017-11-23)

Bug Fixes

• Fix crash when using type file in OpenAPI 2.0 in some places

2.0.0-alpha.1 (2017-11-23)

Complete rewrite of ReDoc using React so here only major changes are listed. Complete rewrite also means that this rewrite may introduce issues, but they should be resolved before 2.0.0.

Features

• Basic Support for OpenAPI 3
• Usage as a React component

Deprecations

• Fonts are not loaded by ReDoc so you should load them. Default fonts can be loaded as bellow:

<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">

• no more bower releases
• no more GitHub pages-based CDN. Use unpkg.com to access ReDoc releases

Known Regression (will be resolved before leaving alpha stage)

• lazyLoading option not implemented yet
• Copying to clipboard of samples not implemented yet
• Search not implemented yet

1.19.3 (2017-11-16)

Bug Fixes

• html characters not escaped in code blocks (fixes #378) (fef9ec4)

1.19.2 (2017-11-10)

Bug Fixes

• response samples doesn't show only text/plain (fixes #371) (00aea06)

1.19.1 (2017-10-02)

2.0.0-alpha.16 (2018-03-18)

Bug Fixes

• move cli to a separate npm package (95c7585)
• prefer .extend over styled() to make styles more predictable (ed20ac1)

Features

• use new Context API for options (e022349)

1.19.0 (2017-09-21)

Bug Fixes

• Clearly label version compatibility (8d849a6), closes #338
• HEAD http verb support (d8b6e02), closes #342

Features

• add ignoredHeaderParameters option (56d62e5)
• add native-scrollbars option to workaround scrolling perf issues (f2ed92c)

1.18.1 (2017-08-28)

Bug Fixes

• crash if contact is not in the spec (1b9ba0d), closes #332

1.18.0 (2017-08-28)

Bug Fixes

• increase padding top for .api-info-wrapper when left sidebar is hiding to avoid header overlaying by top menu (514fc29)
• add display: inline-block for .openapi-button (86b4db4), closes #321
• add margins around list-items in markdown (b165785)

Features

• generate download link for specs defined by an object (60e8cb4), closes #289
• support text-plain response sample (b84177c), closes #270
• clickable logo that points to specific url (cb3d318), closes #322
• support x-example for parameters (f792273), closes #297

1.17.0 (2017-08-02)

Bug Fixes

• copy code-samples included \n\r characters (cd962fa), closes #296
• enum with single value not shown in non-body params (87d9abd), closes #284
• handle case where items is array in indexer (5e5db72), closes #304
• output dates as ISO 8601 strings in JSON Formatter (#313) (86d8179)
• make padding between h2 sections smaller (2c89536), closes #291
• ready-only for nested objects samples (be41d6d), closes #300

Features

• add hide-loading option (2ebca4b), closes #315
• add special rendering for deprecated operations (#290) (2748aac)
• export angular module (ef5101b)
• support for xml samples in response when there is no schema in response (eb7089b), closes #307

1.16.0 (2017-05-12)

Bug Fixes

• do not show discriminator dropdown if it is empty (7a5d315)
• prevent possible XSS using untrusted-spec option (c0698bb)
• URL changes so fast (131b437), closes #252

Features

• display xml examples if present in response examples (cb106cc)

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