2.2.0 (2024-10-16)
2.1.5 (2024-06-10)
2.1.4 (2024-04-25)
- add deprecated css to clickable property name (#2526) (b0d03d0)
- use h2/h3 for headings instead of h1/h2 for better seo (#2514) (2b72dc0)
- security vulnerability (#2445) (1f11f5)
2.1.3 (2023-10-24)
- default value as object in request body (#2437) (b36a6e2)
- display string pattern in array items (#2438) (8ddeb6d)
- hideRequestPayloadSample (#2436) (bf96061)
- more cases for react18 and cli integration (#2416) (26674e7)
2.1.2 (2023-09-11)
- react18 cli integration (#2404) (76edc15)
- style RefreshToken URL as
in the authorization section (1d61001)
2.1.1 (2023-08-17)
- hotfix, crash after 2.1 release (0ab3428)
2.1.0 (2023-08-10)
- call onLoaded if specs are not found (#2182) (0753bbe)
- default value for array query parameter (#2186) (3d410b6)
- demo: Get CORS proxy to work in Chrome on Windows (#2220) (1597bae)
- error with immutable object spec (#2179) (53c4f36)
- improve accessible label by using the property name (#2224) (12be1bc)
- move role to list item to meet ARIA spec (#2228) (b8f7da6)
- remove GenericObject shim (#2177) (127ef26)
- renames 'FieldContstraints' to 'FieldConstraints' (#2352) (7e05202)
- schema oneOf title with const (#2350) (4386867)
- types/open-api: import type (#2213) (33be51a)
- add deprecation label to redoc-cli (#2172) (2ae7e08)
- add option to hide the example code when using the
SchemaDefinition component (#2157) (168189b)
- add support of react 18 (#2369) (054f604)
- add x-tags (#2355) (0bb21c8)
- enable keyboard navigation (#2361) (d21af58)
- indicate whether request body is required or optional (#2175) (d3ad792)
2.0.0 (2022-09-12)
2.0.0-rc.77 (2022-09-06)
- add hard limit on deref depth to prevent crashes (ddde105)
- do not use discriminator when specific schema was referenced in oneOf or anyOf (#2153) (6ac1e1e)
- hoistOneOf missing refs stack and improve allOf for same $ref (bb325d0)
- latest docker cli tag (#2140) (8dc03eb)
- markdown parent name (#2062) (da9ed0b)
2.0.0-rc.76 (2022-08-18)
- "API Docs By Redocly" overlapping last element in sidebar (#2132) (c60c6f5)
- encoding issue in CDN responses (#2130) (7816902)
- Optional authentication not rendered properly (#2117) (#2134) (efd5e09)
2.0.0-rc.75 (2022-08-10)
- duplication of title (#2119) (40ebfd2)
- handle error if security scopes is invalid (#2113) (428fd69)
- publishing docker image to github packages (#2115) (250f6d1)
- Redocly logo (#2109) (a35bb3f)
- search and navigate error (cfd810f)
- sibling for openapi 3.1 (#2112) (0b1a790)
2.0.0-rc.74 (2022-07-28)
2.0.0-rc.73 (2022-07-28)
- add label API docs by Redocly (#2099) (dcdab83)
- add the latest tag for the CLI docker image (#2087) (80ecd0f)
- correct URLs of OperationModel servers for static site generation (#2081) (b1afd08)
- enum duplication values when schema uses a specific combination of oneOf and allOf(#2088) (e411847)
- highlight text syntax (#2069) (4fc6aa0)
- merge reference for openapi 3.1 (#2063) (87541e4)
- nested patternProperties (#2073) (9920991)
- operation url in static page (#2093) (98eec19)
- property with nested allOf (#2083) (7cc0500)
- recursion for boolean items (#2097) (a5804db)
- resolve dependency conflict in installing (#2060) (e26c8b2)
- restore old variant security injections (#2075) (1a1bc26)
- rewrite recursive checks (#2072) (2970f95)
- Scrolling keeps rewriting url after a Redoc element was removed #2051 (#2085) (0045be0)
- mis-nesting of aria roles on sidebar navigation (#2050) (7ca10da)
- 404 on the documentation page (#2092) (17bb08)
2.0.0-rc.72 (2022-06-02)
- handled style change in ServerUrl and ServersOverlay dynamically (#1989) (a366de4)
- nested items with refs (#2035) (51127aa)
2.0.0-rc.71 (2022-05-31)
- add hideSecuritySection option allowing to disable the Security panel (#2027) (49cc11d)
- add Redoc to Redocly CDN (#2026) (77104d6)
- add support prefix items (27a9dba)
- remove auth section (#2022) (a863302)
- show minProperties maxProperties (#2015) (82712c5)
2.0.0-rc.70 (2022-05-17)
- display patternProperties (#2008) (660cc85)
- support conditional operators (#1939) (291b62a)
- theme add links textDecoration options (#1599) (ba06485)
2.0.0-rc.69 (2022-05-12)
- add download file option (#1699) (b601c9a)
- add option to display verb in webhooks (#1994) (311d2ce)
- support .redocly.yaml for options for redoc-cli (#1981) (1f417d6)
2.0.0-rc.68 (2022-05-10)
- examples in json schema object(5b9aa27)
- handle error when definition load fails (#1979) (508ebd5)
- large text in examples value (#1974) (60bc603)
- not show scopes if keys empty or not exist (#1975) (4e793f0)
- remove dropdown-aria and use native select (#1954) (186f5a9)
- make Redoc lib compatible with Webpack 5 (#1982) (867861)
- implement configurable minimum characer length to init search (#1402) (0fa08fa)
- support OAS 3.1 unevaluatedProperties (#1978) (0755ac6)
- publish dockerhub (#1971) (7e01a0)
2.0.0-rc.67 (2022-04-28)
- Expand/Collapse all buttons disappears for flat structures (#1424) (2ca8e08)
- improve markdown render with CRLF (#1953) (aba2d1a)
- issue with navigation when operationId contains backslash or quotes (#1513) (8f7e56c)
- prefix operation ids with parent id (#1245) (fd8917e)
- add optional BASE_PATH to Docker config (#1378) (90f71c0)
- theme add sidebar activeBackgroundColor and activeTextColor (#1600) (6716b08)
2.0.0-rc.66 (2022-03-30)
- add handle local files for serve command (#1810) (117071e)
- move comma out of code block in SecurityRequirement.tsx (#1924) (ab3e8a8)
- rename bandle command and add deprecate notice (#1935) (eb096b6)
- add support for displaying operationId in the sidebar (#1927) (09786f2)
- add nonce support (#1566) (c75ac9c)
- h2 set color form theme.colors.text.primary (#1491) (25be93)
2.0.0-rc.65 (2022-03-15)
- auth link scroll for Firerox (#1922) (fe67e9c)
- improve customization fab (#1891) (635f379)
- sanitize array of items (#1920) (059bd80)
- use x-displayName in securityDefinitions (#1444) (ac6fb4)
- deprecated badge on one of any of buttons (#1930) (f60b47)
2.0.0-rc.64 (2022-02-24)
- bump json-pointer version to avoid CVE-2021-23820 (#1910) (777efdd)
- external ref in schema definition (#1894) (57cdd9f)
2.0.0-rc.63 (2022-01-27)
- scroll in sidebar (b5b0d61)
2.0.0-rc.62 (2022-01-26)
- fix field expand does not work (#1875)
2.0.0-rc.61 (2022-01-26)
- fix crash in redoc-cli after migrating to esbuild (#1872)
2.0.0-rc.60 (2022-01-25)
- add schema expansion level (#1868) (250d53a)
- attachHeadingsDescriptions match headings incorrectly (#1845) (ea8573d)
- definition name util (#1865) (95a7347)
- No maxLength label is displayed for arrays of items #1701 (#1765) (6c7685e)
- Response objects couldn't open (#1867) (18f943d)
- writeOnly params displaying in webhook (#1866) (5694913)
- #1251: Add file selector to demo application (#1859) (b74dcde), closes #1251 #1251 #1251
- redoc-cli add host option (#1598) (fb104e6)
- support examples in object schema (#1832) (c986f0e)
2.0.0-rc.59 (2021-12-09)
- fix scroll in example dropdown (#1803) (bc2d9a7)
- x-examples for request body param does not display #1743 (#1826) (aaa3b32)
2.0.0-rc.58 (2021-11-29)
- add browser build for webpack 5 (#1796) (0e43ad3)
- Default boolean property value not rendered #1779 (#1781) (734080c)
- exclusiveMin/Max shows incorect range (#1799) (b604bd8)
- mobile view in docker image (#1795) (ad652b9)
2.0.0-rc.57 (2021-10-11)
- fix deref logic for oas3.1 (#1767) (4fb9c83)
- improve publish action scripts (#1729) (952c05c)
- No match scenario in search (#1667) (352a851)
- OpenAPI 3.1: Missing description when $ref used #1727 (fe6909e)
- OpenAPI 3.1: Missing description when $ref used #1727 (35f7787)
- Redoc spelling (c87600d)
- Schema for events incorrectly omits readOnly and includes writeOnly (#1720 #1540) (a8e0c29)
- scrolling to the first item (#1753) (bccd213)
- The number of items in the array in the array is incorrect #1762 (#1763) (3b8d644)
- add q/kdb+ syntax highlighting (#1605) (43451ba)
- new option generatedPayloadSamplesMaxDepth (#1642) (bd9390a)
2.0.0-rc.56 (2021-08-11)
- handle empty object in security array (#1678) (9e1ea70)
- hideLoading options in redoc standalone (#1709) (6a52a16)
- improve openapi 3.1 (#1700) (cd2d6f7)
- show contentEncoding on fields
- crash with OpenAPI 3.1 type as array of strings in requestBody
- nullable label not shown
- nullable object's fields were missing (#1721) (ddf297b)
- add github action to build docker images and push to ghcr.io on release (#1614) (919a5f0)
- add yaml highlight (#1684) (d724440)
- added localization for some labels (#1675) (ec50858)
2.0.0-rc.55 (2021-07-01)
- added git folder sync config (a69f0fb)
2.0.0-rc.54 (2021-06-09)
- added missing semicolon to styling (#1578) (dfc4cf1)
- parse json theme string for standalone tag (#1492) (d7a0a4d)
- right absolute path for load and bundle definition (#1579) (ab2d57a)
- use operation path if operation summary/description is not provided (#1596) (4b072be), closes #1270
2.0.0-rc.51 (2021-04-08)
- use openapi-core to bundle definition instead of json-schema-ref-parser (5033946),
closes: #1506, #1478
- add disable-google-font parameter to serve command in cli (c7bbef5), closes #1501
2.0.0-rc.50 (2021-02-15)
- add includes polyfill (3ba622f), closes #1530
- background-color in search results (#1531) (d288165)
- false-positive recursive tag case when using oneOf + allOf (#1534) (8270481)
2.0.0-rc.49 (2021-01-30)
- crash on multiple examples on parameter object (0dce880), closes #1485
- fix SourceCodeWithCopy component to be non-pure (040ce72)
- pass boolean and number values as a string in highlight function (#1512) (c874a59)
2.0.0-rc.48 (2020-11-30)
- add new option hideSchemaPattern (#1475) (bb4594e)
- support multiple examples for parameters (#1470) (d12e410)
2.0.0-rc.46 (2020-11-05)
- fix arrow color in responses (#1452) (6bedcf9)
- remove duplicated slash if hideHostname option enabled (#1448) (4729fc3)
- use shrinkwrap for cli package (#1446) (4567534)
2.0.0-rc.45 (2020-10-27)
- fix the name of OpenID Connect security scheme (#1425) (c11f679)
- increase colors contrast to make them more accessible (#1433) (e2de5b0)
- add field constraint indicator for uniqueItems (#1423) (c0ae9de), closes #1353
- new extensions hook PropertyDetailsCell + wrap property name into span (0703f73)
2.0.0-rc.44 (2020-10-16)
- new extensions hook PropertyDetailsCell + wrap property name into span (0fae030)
2.0.0-rc.43 (2020-10-13)
2.0.0-rc.42 (2020-10-13)
- hide dropdown input on IE 11 (#1403) (6632d84)
- make samples accessible by keyboard (#1401) (146b38c)
- make schema layout more responsive on small screen (#1411) (84ab95d)
2.0.0-rc.41 (2020-09-24)
- display response code at the top after adding a line break (#1374) (c801b87)
- fix displaying response title (#1376) (f3e8ab4)
- fix displaying top-level object without any properties (a5468fb)
- show long pattern and add toggle button (#1375) (a6b41aa)
2.0.0-rc.40 (2020-08-24)
- invalid discriminator dropdown behavior with enum (be07197)
2.0.0-rc.39 (2020-08-22)
- fix broken dropdowns with SSR by using forked react-dropdown-aria (c322639)
- make callbacks expandable by keyboard (#1354) (46eee7b)
2.0.0-rc.38 (2020-08-20)
- do not crash for invalid parameter.in value (addf895), closes #1340
- scale sideMenu labels according to computed font size (#1356) (fed9a06)
2.0.0-rc.37 (2020-08-14)
2.0.0-rc.36 (2020-08-04)
- highlight json keys using different color (#1287) (c9596d4)
- make elements accessible by keyboard navigation tools (#1339) (2ce7189)
- new option simpleOneOfTypeLabel (7af2efe)
2.0.0-rc.35 (2020-07-24)
2.0.0-rc.34 (2020-07-24)
Same as rc.33 by mistake
2.0.0-rc.33 (2020-07-21)
- default style and explode for params (633d712), closes #1016
- fix contrast ratio for response titles (47c6319)
- fix expand variable for vars with hyphens or dots (0904b3f), closes #926
- make dropdowns accessible by keyboard (e8a0d10)
- make endpoint dropdown accessible (3d25005)
- make properties focusable (05fd754)
- make response sections focusable (442014c)
- make sample controls focusable (006031c)
- update focus styling (30a27c1)
- add maxDisplayedEnumValues config and buttons for show/hide enums (#1322) (a2b018d)
- array size info based on min max Items properties (#1308) (644e96a)
- new option sortEnumValuesAlphabetically (#1321) (a96a11a)
2.0.0-rc.32 (2020-07-21)
Same as rc.31 by mistake
2.0.0-rc.31 (2020-06-25)
- do not display long regexps (#1295) (2ede22c)
- prevent body scrolling when user scrolls side menu (#1300) (865a56a)
2.0.0-rc.30 (2020-05-25)
- add security headers to Docker nginx config (#1244) (4512436)
- keep 3-column layout on 13-inch mbp (8d1d4c8)
- proper search-index dispose (9dd129d)
2.0.0-rc.29 (2020-05-10)
- depreacate x-code-samples, rename to x-codeSamples for consistency (becc2f5)
- do not crash on incompatible allOf, console.warn instead (6e607b9), closes #1156
- download button opens in new tab instead of downloading (b59faad), closes #1247
- fix broken md headings with ampersand (8460659), closes #1173
2.0.0-rc.28 (2020-04-27)
- encode URLs in json samples linkify (xss) (62c01da), thanks to @masatokinugawa
2.0.0-rc.27 (2020-04-20)
2.0.0-rc.26 (2020-03-29)
2.0.0-rc.25 (2020-03-27)
- 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)
2.0.0-rc.24 (2020-03-17)
- 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
- new option expandSingleSchemaField (7608800)
2.0.0-rc.23 (2020-02-09)
2.0.0-rc.22 (2020-01-15)
- do not process oneOf if inherited from parent with discriminator (5248415)
2.0.0-rc.21 (2020-01-10)
- empty servers behavior 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)
2.0.0-rc.19 (2019-12-13)
- 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)
- 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)
- 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)
- 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
2.0.0-rc.16 (2019-09-30)
- fix scrollYOffset when SSR (d09c1c1)
2.0.0-rc.15 (2019-09-30)
- 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
- 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)
- fix escaping JSON string values (58cb20d), closes #999
- revert expanding default server variables (7849f7f)
2.0.0-rc.13 (2019-08-01)
- 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)
- rename ObjectDescription to SchemaDefinition as discussed (4496622)
2.0.0-rc.11 (2019-07-30)
- 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
- 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)
- 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)
- 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)
2.0.0-rc.8-1 (2019-05-13)
- crash with empty servers with redoc-cli (3d52b39)
2.0.0-rc.8 (2019-05-13)
2.0.0-rc.7 (2019-05-13)
- crash in node due to broken URL parsing (8df2b97)
2.0.0-rc.6 (2019-05-13)
- 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)
- 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
- 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)
- move swagger2openapi to deps because of missing transitive deps (ed9b878)
2.0.0-rc.3 (2019-03-15)
- 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
- 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)
- 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)
- 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)
- 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)
- 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)
- 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)
- ReDoc now requires
styled-components@^4.0.1 to be installed if used as React component
2.0.0-alpha.40 (2018-10-05)
- 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
- new option
onlyRequiredInSamples (#646) (10bca66)
- new option
sortPropsAlphabetically (b87cf0d)
- new theme options
spacing.sectionHorizontal and spacing.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)
2.0.0-alpha.38 (2018-08-24)
2.0.0-alpha.37 (2018-08-22)
- 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)
- 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)
- crash on any backticks code block without lang specified (58ae668)
- fix auth requirements font size (d13fe13)
2.0.0-alpha.34 (2018-08-08)
- 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
- 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)
- 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)
- cli: add mobx to dependencies (75ced44)
- fix resolving issue by upgrading to [email protected] (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)
- server url contains spec name if not specified in the spec (b41b181)
2.0.0-alpha.30 (2018-07-19)
- theme reshape and new options (58bddc8)
2.0.0-alpha.29 (2018-07-18)
- 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)
- new option disableSearch (d4ab5ad)
2.0.0-alpha.28 (2018-06-29)
- inline markdown regression (e1c9e19)
2.0.0-alpha.27 (2018-06-29)
- change default font weight to 400 (11947ed)
- do not uppercase menu items by default (0d45cc2)
- fix link colors in json samples (aaaa899)
- 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)
- change default font weight to 400 (11947ed)
- do not uppercase menu items by default (0d45cc2)
- fix link colors in json samples (aaaa899)
- 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)
- temporary downgrade marked as it introduced breaking changes and a few bugs (902f97a)
2.0.0-alpha.23 (2018-05-31)
- 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)
- 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
- add new experimental option unstable_ignoreMimeParameters (d162bab)
- support x-discriminator for OpenAPI 2 (aaff311), closes #496
2.0.0-alpha.21 (2018-05-28)
- 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
- export TypeScript typings (9115be8)
- new theme colors: code and codeBg (f8b793d)
- new theme option: nestingSpacing (782ef77)
2.0.0-alpha.20 (2018-05-14)
- fix worker is not defined in lib bundle (6a5513e)
2.0.0-alpha.19 (2018-05-14)
- 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)
2.0.0-alpha.18 (2018-03-23)
- 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)
- 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)
- 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)
1.21.1 (2018-02-23)
- 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)
1.20.0 (2018-01-21)
- Path parameters are not correctly overridden (c406dc5), closes #400
- Use parentNode instead of parentElement to fix IE11 crash (e8adb60), closes #406
- Dropped bower support. No more dist files on the
releases branch.
2.0.0-alpha.15 (2018-03-16)
- fix broken css after installing polished (6018042)
- more advanced theme engine (1df690a)
2.0.0-alpha.14 (2018-03-15)
- fix CLI crash + build it on travis (7769ba8)
2.0.0-alpha.13 (2018-03-15)
- 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)
- 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)
- 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)
- responsive side menu (3aab2d9)
2.0.0-alpha.11 (2018-01-29)
- 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)
2.0.0-alpha.9 (2018-01-11)
- handle scrollYOffset in ScrollService (dcab770)
2.0.0-alpha.8 (2018-01-10)
- undo section id + some minor fixes (0253c5d)
2.0.0-alpha.7 (2018-01-10)
- 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)
- 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)
- initial display security requirements (50e2a58)
2.0.0-alpha.5 (2017-12-07)
- 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)
- 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)
- Fix crash when using type
file in OpenAPI 2.0 in some places
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.
- Basic Support for OpenAPI 3
- Usage as a React component
- 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
lazyLoading option not implemented yet- Copying to clipboard of samples not implemented yet
- Search not implemented yet
1.19.3 (2017-11-16)
1.19.2 (2017-11-10)
1.19.1 (2017-10-02)
2.0.0-alpha.16 (2018-03-18)
- move cli to a separate npm package (95c7585)
- prefer
.extend over styled() to make styles more predictable (ed20ac1)
- use new Context API for options (e022349)
1.19.0 (2017-09-21)
- Clearly label version compatibility (8d849a6), closes #338
- HEAD http verb support (d8b6e02), closes #342
- add ignoredHeaderParameters option (56d62e5)
- add native-scrollbars option to workaround scrolling perf issues (f2ed92c)
1.18.1 (2017-08-28)
1.18.0 (2017-08-28)
- 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)
- 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)
- 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
- 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)
- 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
- display xml examples if present in response examples (cb106cc)
1.15.0 (2017-05-05)
- 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)
1.14.0 (2017-04-23)
- 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)
- 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)
- 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
- 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)
- Support x-examples vendor extension for requests (by @brendo)
- Updated to Angular 4, bundle is a bit smaller now
- 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
- copy pretty-printed JSON (e99d66d), closes #219
- support for OpenAPI object as a parameter for
init (d99f256), closes #224
- clear page fragment when scroll to the beginning
- update docs for x-tagGroup, add warning #215
- show warning for non-used in tagGroup tags
- improve x-servers dropdown animation performance (69c7d98)
- Revert: remove unused hide-hostname option (7031176)
- new option
required-props-first (c724df4), closes #191
- update fragment while scrolling and on menu clicks (66c06b3), closes #138 #202
- do not crash if version is not string (accd016), closes #208
- long paths break EndpointLink ui (8472045)
- remove unused hide-hostname option (7031176)
- 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
- 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)
- autoscroll menu (b43a87d)
- 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)
- 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)
- Fix response list for shared schemas (fixes #177)
- Fix right panel overlaps site-footer
- Fix crash on MS Edge (fixes #166)
- Uncomment animation after upgrade to the latest ng2 (resolves #162)
- Disable side-menu animation (workaround for #162)
- Use markdown for response description (fixes #158)
- Fix leaks (fixes #167)
- Update webpack and stick to [email protected] (fixes #169, #168)
- add
expand-responses option - specify which responses are expand by default (#165).
- Use markdown in responses description (#158)
- x-displayName for tags - by @bfirsh (PR #152)
- 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
- Don't show error screen for runtimes after render finished
- Updated dependencies (angular to the latest version + dev deps)
- Update webpack to the latest beta (#143)
- Fix read-only fields appear in request samples (#142)
- A few more minor UI 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
- 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)
- Add support for Swagger
collectionFormat
- Wrap API version in span with class (#145)
- Update openapi-sampler to 0.3.3
- Fix content scrolling on language switch (#130)
- Support for Swagger
pattern property (#42)
- Add option to hide hostname in method definition (by @bfirsh)
- Add Docker development environment (by @bfirsh)
- Fix side menu items wrong sync with description headers
- Support for Security Definitions
- Update angular2 to the 2.1.2
- Deprecate
x-traitTag
- Separate RedocModule from AppModule
- Get rid of angular facade/lang dependencies
- Error handler refactor
- Emit helpers for module build
- Fix destroy/reinit
- Fix minimum/maximum zero not rendered (#123)
- Do spec load after bootstrap
- Build and publish angular2 module (#126)
- 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)
- Fix broken tabs styling for response samples
- Fix v1.x.x deployment
- 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
- Update to latest Angular RC.6
- Smaller bundle size by removing esprima dep from bundle
- Updated dependencies
- 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
- Support "x-nullable" property by @kedashoe (#92)
- 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)
- 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
- Moved build-system to Webpack
- Moved to latest Typescript + get rid of typings
- Upgrade to the latest Angular2 RC.5
- Revert "Fix markdown newlines to be GFM" (#82)
- Move license and contact info above description
- Fix markdown newlines to be GFM (#82)
- Fix markdown code blocks in api description
- Fix API description width on mobile
- Render valid JSON in samples (quoted object keys)
- Add Tuple support (arrays with separate schema for each value) (#69)
- Add special representation for enum with one value (#70)
- Change
< * > notation to < anything >
- Use api host if schema host is undefined