mirror of
https://github.com/Redocly/redoc.git
synced 2024-12-05 06:43:43 +03:00
77 KiB
77 KiB
2.0.0-rc.28 (2020-04-27)
Bug Fixes
- encode URLs in json samples linkify (xss) (62c01da), thanks to @masatokinugawa
2.0.0-rc.27 (2020-04-20)
Features
2.0.0-rc.26 (2020-03-29)
Bug Fixes
2.0.0-rc.25 (2020-03-27)
Bug Fixes
- do not collapse top level on Collapse All in json samples (#1209) (830371b)
- fix passing boolean value to showExtensions options (#1211) (c6eaa02)
- improve names for some theme settings (a0bd27c)
- sort discriminator entries by mapping order (#1216) (ac4f915)
Features
2.0.0-rc.24 (2020-03-17)
Bug Fixes
- Add debounce for 300 ms when searching (#1089) (373f018)
- do not load SearchWorker if disableSearch is
true
(#1191) (af415e8), closes #764 - fix major search performance due to wrong marker element (8c053cc), closes #1109
Features
- new option expandSingleSchemaField (7608800)
2.0.0-rc.23 (2020-02-09)
Bug Fixes
2.0.0-rc.22 (2020-01-15)
Bug Fixes
- do not process oneOf if inherited from parent with discriminator (5248415)
Features
2.0.0-rc.21 (2020-01-10)
Bug Fixes
- empty servers behaviour per OAS spec (ed1db0c), closes #1151
- fix duplicated content in tags when using md headings (a260c84), closes #1150 #1152
- use mobile menu background color value from theme (#1144) (41a9b3c)
2.0.0-rc.20 (2019-12-13)
Bug Fixes
2.0.0-rc.19 (2019-12-13)
Bug Fixes
- change the title of "Security Scheme Type" to match "HTTP Authorization Scheme" (#1126) (289c8e6)
- do not URI-encode parameter values for better readability (6aeb0bf), closes #1138
- fix sortByRequired (stabilise sort) (#1136) (d92434d), closes #1104 #1121 #1061
- h2 padding on mobile (7ed1a7e), closes #1118
- python comment stripped in headings (4a25aae), closes #1116
- remove hardcoded fontFamily for oneOf labels (094ce91), closes #1120
- search-box use theme (1bf490c)
- support discriminator mapping 1-n (6e390f9), closes #1111
- wrap json examples in code tag (#1064) (dc5430e)
Features
- display
multipleOf
constrains (#1065) (3e90133) - enable menuToggle by default (5d81abe)
- new option hideSchemaTitles (11cc4c4)
- new option payloadSampleIdx (eaaa99d)
- cli: Fallback on the spec's title before falling back on… (#1073) (e01eea4)
2.0.0-rc.18 (2019-10-16)
Bug Fixes
- add oneOf buttons vertical space when wrapped to new line (cd9fd61)
- improve mime-type dropdown font (ce885f8)
2.0.0-rc.17 (2019-10-16)
Bug Fixes
- active menu item scroll into view (0a01e9a)
- changed several components style font-family to monospace (#1063) (0c20e64), closes #909
- no quotes for default values in header fields. (#1059) (b5af71d)
- types over-pluralization (#1057) (4494f80), closes #1053
Features
2.0.0-rc.16 (2019-09-30)
Bug Fixes
- fix scrollYOffset when SSR (d09c1c1)
2.0.0-rc.15 (2019-09-30)
Bug Fixes
- auth section appears twice (5aa7784), closes #818
- clicking on group title breaks first tag (4649683), closes #1034
- do not crash on empty scopes (e787d9e), closes #1044
- false-positive recursive detection with allOf at the same level (faa74d6)
- fix scrollYOffset when SSR (21258a5)
- left menu item before group is not highlighted (67e2a8f), closes #1033
- remove excessive whitespace between md sections on small screens (e318fb3), closes #874
- use url-template dependency (#1008) (32a464a), closes #1007
Features
- cli: added support for JSON string value for --options CLI argument (#1047) (2a28130), closes #797
- cli: add
disableGoogleFont
parameter to cli (#1045) (aceb343) - new option expandDefaultServerVariables (#1014) (0360dce)
2.0.0-rc.14 (2019-08-07)
Bug Fixes
- fix escaping JSON string values (58cb20d), closes #999
- revert expanding default server variables (7849f7f)
2.0.0-rc.13 (2019-08-01)
Bug Fixes
- enum list doesn't wrap (bfbb0c1), closes #993
- incorrect serialization of some parameter samples (aba45db), closes #992
- support json serialization for parameter examples (1367380), closes #934
- unify accordion icons for responses section (2afc2e4), closes #975
- update to core.js 3 (9e3375d), closes #997
2.0.0-rc.12 (2019-07-30)
Bug Fixes
- rename ObjectDescription to SchemaDefinition as discussed (4496622)
2.0.0-rc.11 (2019-07-30)
Bug Fixes
- do not add extra slashes to pattern (70d1ee9), closes #983
- dropdown fixes related to object description (0504ad4)
- incorrect serialization of parameter sample with hyphen (f7dd658)
- redoc-cli: Add missing content type header on compressed responses of
/
path
Features
- menu items from tags + md extension for Schema Definition (#681)
- new option
menuToggle
- fold active MenuItem if clicked (#963) - Add option for skipping quotes in enums
enumSkipQuotes
(#968) (afc7e36) - add
sampleCollapseLevel
option (#937) (d3f1c16)
2.0.0-rc.10 (2019-07-08)
Bug Fixes
- broken headings with single quote (51d3b9b), closes #955
- fix fields table overflow if deeply nested with long title (12b7057)
- hide empty example when it is not defined (4bd499f)
- markdown in examples descriptions + minor ui tweaks (f52d9e8)
- organize response examples in dropdown and display description (995e557)
2.0.0-rc.9 (2019-06-27)
Bug Fixes
- fix regression double slashes added to full URL display (f29a4fe)
- IE11, add missing Object.assign polyfill (888f04e)
- serialize parameter example values according to the spec (#917) (3939286)
- styled-component style error in tabs (#946) (c488bbf)
Features
2.0.0-rc.8-1 (2019-05-13)
Bug Fixes
- crash with empty servers with redoc-cli (3d52b39)
2.0.0-rc.8 (2019-05-13)
Bug Fixes
2.0.0-rc.7 (2019-05-13)
Bug Fixes
- crash in node due to broken URL parsing (8df2b97)
2.0.0-rc.6 (2019-05-13)
Bug Fixes
- broken schema tables with long enums (3a74b74)
- deep linking sometimes not working when sent over messengers (2491d97)
2.0.0-rc.5 (2019-05-13)
Bug Fixes
- change fontFamily for EndpointInfo (#866) (851b133)
- clean up field values display (#855) (5c91590)
- discriminator and oneOf title fix (a3d7d7a)
- encode x-www-form-urlencoded examples correctly (65930ad), closes #870
- fix redoc-cli broken dependencies (81a7568)
- IE11 add missing fetch and URL polyfills (d2ce1bd), closes #875
- ignore empty x-tagGroups array (#869) (4366a0d)
- incorrect detected schema title for deeply inherited schemas (7d7b4e3)
- pluralize array of types (fdcac30)
- remove huge space after Authentication section (548fae3), closes #872
- remove query string from server URL (#895) (64453ff)
- remove tabs top margin (5c187f3)
- right panel code samples bg color (de2aed2)
- tidy up non-redoc vendor extension presentation (#847) (b21cd3d)
- update apiKey in to be titleize (#902) (35df477)
- cli: add node-libs-browser to the deps (6c79901), closes #850
Features
- add hideSingleRequestSampleTab option (4550e4d)
- add lineHeight config for headings (#894) (5dd5d6d)
- basic UI labels configuration (b0e660e). Can be used for translations later.
- add logo gutter to the theme (82c0cb1a).
2.0.0-rc.4 (2019-03-15)
Bug Fixes
- move swagger2openapi to deps because of missing transitive deps (ed9b878)
Features
2.0.0-rc.3 (2019-03-15)
Bug Fixes
- add extra deref step for anyOf/oneOf variants (d81b631), closes #810
- duplicate keys in request samples (3ce5bff), closes #815
- escape backslashes in string literals (#823) (70faca1), closes #822
- escape quotes in string values (0473165), closes #882
- pin lunr version in ReDoc (178ff4c), closes #844
- set last section min-height (4dd79cd), closes #820
Features
- support externalValue for examples (2cdfcd2), closes #551 #840
- cli: Add templateOptions param to pass additional data to custom template (#792) (4e8ee03)
2.0.0-rc.2 (2019-01-27)
Bug Fixes
- make padding for md code blocks and code samples consistent (007752d)
- make syntax highlighting for md js code blocks same as for payload samples (d197c0f)
- Only display API version if present (#773) (fb3cb36)
2.0.0-rc.1 (2019-01-17)
Bug Fixes
- allow docker container serving under non-root URLs (#731) (cfb6f0f), closes #730
- make example/defaults badge consistent with code blocks (fa39ce4)
- pattern constrain spacing (c7436f2)
- sidebar navigation issues when scrollYOffset is float number (c04f387), closes #748
2.0.0-rc.0 (2018-11-27)
Bug Fixes
- false-positive recursive detection with oneOf (59eaa8d), closes #723 #585
- fix hideHostname also hiding basePath (b5f3224), closes #677
- fix spacing with nested markdown lists (f2f6909), closes #718
- improve scrolling performance in Chrome with non-wrapped json examples (a69c402)
- nested oneOf button spacing (3673720), closes #719
- onLoaded callback not run on spec error (e77df0c), closes #690
- theme improvements by @stasiukanya (e2d0cd5)
- cli: old peer dependency issue with styled-components (#699) (9e2853c)
Features
- Add feature to specify href for logo explicitly (#645) (87fd7d7)
- add support for markdown in Server Object (155d214)
- Add support for minLength and maxLength constraint humanization (#700) (f40568b), closes #42 /github.com/Rebilly/ReDoc/issues/42#issuecomment-371883853
2.0.0-alpha.41 (2018-10-18)
Bug Fixes
- add null check in dispose method (#675) (6b7c5b7)
- extensionHook not being used (a4a4013), closes #665
- fix issue with broken markdown caused by marked bug (70cf293)
Peer dependencies updates
- ReDoc now requires
styled-components@^4.0.1
to be installed if used as React component
2.0.0-alpha.40 (2018-10-05)
Bug Fixes
- cli: add styled-components to dependencies (2d63fa0)
- allOf inside oneOf overwritten and not rendered (fe3383d), closes #660
- fix panel paddings on small screens (f39fc98)
- minor media print improvements (fbcec82)
- remove extra-padding caused by empty group sections (974bc7d)
- server overriding didn't work on Path Item object (355764d), closes #656
Features
- new option
onlyRequiredInSamples
(#646) (10bca66) - new option
sortPropsAlphabetically
(b87cf0d) - new theme options
spacing.sectionHorizontal
andspacing.sectionVertical
(505463f) - turn off code-blocks wrapping (enable using
theme.typography.code.wrap: true
) (393681b), closes #658
2.0.0-alpha.39 (2018-09-14)
Bug Fixes
Features
2.0.0-alpha.38 (2018-08-24)
Bug Fixes
2.0.0-alpha.37 (2018-08-22)
Bug Fixes
- do not inherit title in allOf (720e282), closes #601
- fix crash on empty media object (fb21212), closes #608
- make http badges font-based instead of inline png (5d84bd4)
- use correct parent section for security definition (f903406)
2.0.0-alpha.36 (2018-08-11)
Bug Fixes
- broken rendering of code blocks with language in markdown (8218a26)
- broken rendering of headings with regexp characters (e660517)
2.0.0-alpha.35 (2018-08-09)
Bug Fixes
- crash on any backticks code block without lang specified (58ae668)
- fix auth requirements font size (d13fe13)
2.0.0-alpha.34 (2018-08-08)
Bug Fixes
- add some spacing between operation description and parameters (597688e)
- description is not rendered if doesn't contain markdown headings (90ed717), closes #591
- download button downloads index.html instead of spec with CLI (334f904), closes #594
- fix Authentication section is not rendered (2ecc8bc), closes #590
- fix linebreaks in multiparagraph field descriptions (8fb9cd6)
- preserve md heading level in description (23559fb)
- render additionalProperties set to true (#597) (f70ac08), closes #596
- schemes without type: object are not expandable (97e1620), closes #599
Features
- Add x-logo alt text support (#584) (568ce74), closes #546
- support label for x-code-samples (00bd966), closes #586
2.0.0-alpha.33 (2018-07-31)
Bug Fixes
- long endpoint url overflow (d99e918)
- allow word-break in code strings in md (15dfe44)
- show examples for response headers (ba22b1e)
2.0.0-alpha.32 (2018-07-26)
Bug Fixes
- cli: add mobx to dependencies (75ced44)
- fix resolving issue by upgrading to json-schema-ref-parser@5.1.1 (0045958), closes #541
- remove break-all from code samples (d74578d)
- wrong display when combining multiple auth requirements (f96c481), closes #577
2.0.0-alpha.31 (2018-07-23)
Bug Fixes
- server url contains spec name if not specified in the spec (b41b181)
Features
2.0.0-alpha.30 (2018-07-19)
Bug Fixes
Features
- theme reshape and new options (58bddc8)
2.0.0-alpha.29 (2018-07-18)
Bug Fixes
- cli: cli output crashes if script closing tag is in the spec (76906eb), closes #563
- different output of cli bundle and redoc (89aa754), closes #547
- fix broken link in CLI help (bab3e7d), closes #559
- fix Download button url when spec as object was provided (c35925a), closes #462 #540
- fix non-scalar query/path/header params are not expandable (dcca44a), closes #561
- properly host oneOf inside allOf (7e5b6d9), closes #507 #528
- regression - broken urls for operations without operationId (c0c44bc)
- use original tag name when slugified one is not valid (#553) (8817d9c)
Features
- new option disableSearch (d4ab5ad)
2.0.0-alpha.28 (2018-06-29)
Bug Fixes
- inline markdown regression (e1c9e19)
2.0.0-alpha.27 (2018-06-29)
Bug Fixes
- change default font weight to 400 (11947ed)
- do not uppercase menu items by default (0d45cc2)
- fix link colors in json samples (aaaa899)
Features
- display Value instead of Enum for one-item enum (78fa312)
- experimental temporary support for tags in md (06ef51c)
- theme hooks experimental hooks (55bd853)
2.0.0-alpha.26 (2018-06-28)
Bug Fixes
- change default font weight to 400 (11947ed)
- do not uppercase menu items by default (0d45cc2)
- fix link colors in json samples (aaaa899)
Features
- display Value instead of Enum for one-item enum (78fa312)
- experimental temporary support for tags in md (06ef51c)
2.0.0-alpha.24 (2018-06-01)
Bug Fixes
- temporary downgrade marked as it introduced breaking changes and a few bugs (902f97a)
2.0.0-alpha.23 (2018-05-31)
Bug Fixes
- cli: make positional arguments required and handle errors in serve and bundle manually (#518) (370d08a)
- fix typings on npm (d957ad7)
- fix vertical line misaligned in firefox (bde08f1), closes #503
- mergeAllOf takes items into account (#511) (47b2177)
2.0.0-alpha.22 (2018-05-29)
Bug Fixes
- cli: create directories when a path is specified in the --output option (#513) (ac7372b), closes #512
- cli: return 1 as exit code if an error happens in the cli (#516) (720c304)
- fix font-weight inconsistency (6ea2b7b), closes #506
- HEAD http verb support in menu badges (2eb1952), closes #493
- more descriptive message for wrong discriminator use (3c6de2c), closes #505
Features
- add new experimental option unstable_ignoreMimeParameters (d162bab)
- support x-discriminator for OpenAPI 2 (aaff311), closes #496
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
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
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
Features
1.20.0 (2018-01-21)
Bug Fixes
- Path parameters are not correctly overridden (c406dc5), closes #400
- Use parentNode instead of parentElement to fix IE11 crash (e8adb60), closes #406
Features
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
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)
- overwrite 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
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 below:
<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
1.19.2 (2017-11-10)
Bug Fixes
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
overstyled()
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
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
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
1.12.0 (2017-04-19)
Bug Fixes
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 improvements
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