Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-12-03 22:03:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
2,527 Commits 13 Branches 225 Tags 87 MiB
d1b54be4c5
Commit Graph

681 Commits

Author SHA1 Message Date
Alex Varchuk
1e4ea03d4a
fix: merge allOf in correct order (#2020) 2022-05-26 14:54:03 +03:00
Anastasiia Derymarko
82712c5b40
feat: show minProperties maxProperties (#2015) 2022-05-20 11:57:04 +03:00
Alex Varchuk
291b62a206
feat: support conditional operators (#1939) 
* fix: merge type and enum in allOf for 3.1

* chore: add example for OpenApi 3.1

* fix: correct merge constraints in allOf
 2022-05-17 10:56:28 +03:00
Loïc Fürhoff
ba06485ece
feat: theme add links textDecoration options (#1599) 
Co-authored-by: Anastasiia Derymarko <anastasiia@redocly.com>
Co-authored-by: Loïc Fürhoff <loic.furhoff@pix4d.com>
 2022-05-16 11:49:22 +03:00
Andrew Tatomyr
660cc857bc
feat: display patternProperties (#2008) 2022-05-13 13:53:03 +02:00
Andrew Tatomyr
d2cdaa1221
fix: wrong base url format causing error when constructing new URL (#1996) 
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com>
Co-authored-by: Anastasiia Derymarko <anastasiia@redocly.com>
 2022-05-12 12:05:22 +03:00
Alex Varchuk
311d2ce64d
feat: add option to display verb in webhooks (#1994) 
* chore: cli test run ts files
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
 2022-05-11 19:13:50 +03:00
Zach Whaley
b601c9ae9e
feat: Add download file option (#1699) 
Co-authored-by: Zach Whaley <zachbwhaley@gmail.com>
Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
Co-authored-by: anastasiia-developer <anastasiia@redocly.com>
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
 2022-05-10 20:09:01 +03:00
Alex Varchuk
5b9aa27af0 fix: examples in json schemas 2022-05-10 16:41:05 +03:00
Alex Varchuk
e7a6d38a56 chore: add isArray helper function 2022-05-10 16:41:05 +03:00
Alex Varchuk
f0cf5fe149 chore: fix dropdown style 2022-05-10 16:41:05 +03:00
Andrew Tatomyr
8678615a0e
chore: make Redoc lib compatible with Webpack 5 (#1982) 2022-05-10 13:50:50 +02:00
AlexVarchuk
508ebd58a3
fix: handle error when definition load fails (#1979) 2022-05-05 15:49:08 +03:00
AlexVarchuk
186f5a98bd
fix: remove dropdown-aria and use native select (#1954) 2022-05-05 13:17:45 +03:00
Anastasiia Derymarko
0755ac6f04
feat: Support OAS 3.1 unevaluatedProperties (#1978) 2022-05-05 12:04:43 +03:00
Anastasiia Derymarko
60bc603e9b
fix: large text in examples value (#1974) 2022-05-03 13:03:36 +03:00
AlexVarchuk
4e793f07a8
fix: not show scopes if keys empty or not exist (#1975) 2022-05-03 11:25:46 +03:00
Chintan Radia
0fa08faab1
feat: implement configurable minimum characer length to init search (#1402) 
Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com>
 2022-05-03 10:48:08 +03:00
AlexVarchuk
aba2d1ad2d
fix: improve markdown render with CRLF (#1953) 2022-04-27 11:19:07 +03:00
AvroraPolnareff
2ca8e081ba
fix: Expand/Collapse all buttons disappears for flat structures (#1424) 
Co-authored-by: AvroraPolnareff <araintheskywith@gmail.com>
Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
Co-authored-by: anastasiia-developer <anastasiia@redocly.com>
 2022-04-26 13:36:14 +03:00
Oprysk Vyacheslav
8240404a55
chore: codeowners 2022-04-18 23:46:08 +03:00
Andrey Lomakin
8f7e56c747
fix: issue with navigation when operationId contains backslash or quotes (#1513) 
Co-authored-by: Andrey Lomakin <lom16133@gmail.com>
Co-authored-by: Anastasiia Derymarko <anastasiia@redocly.com>
Co-authored-by: Andriy Zaleskyy <andriy.zaleskyy@redocly.com>
 2022-04-15 16:53:36 +03:00
Ben Blowers
fd8917e5c1
fix: prefix operation ids with parent id (#1245) 
Co-authored-by: ben.blowers <ben.blowers@imanage.com>
Co-authored-by: anastasiia-developer <anastasiia@redocly.com>
 2022-04-12 12:19:15 +03:00
Anastasiia
1e80dd69a3
fix: update snapshot (#1956) 2022-04-11 10:40:30 +03:00
Loïc Fürhoff
6716b08e88
feat: theme add sidebar activeBackgroundColor and activeTextColor (#1600) 2022-04-07 16:51:52 +03:00
Sergey Dubovyk
de67df102a
chore: change side menu message (#1390) 2022-03-24 22:46:03 +08:00
AlexVarchuk
7dd76292e0
chore: update snapshots for unit tests (#1942) 2022-03-24 08:53:19 +02:00
Quentin D
c75ac9cf70
feat: nonce support (#1566) 
Signed-off-by: Quentin Devos <4972091+Okhoshi@users.noreply.github.com>
Co-authored-by: AlexVarchuk <olexandr.varchuk@gmail.com>
 2022-03-23 18:02:30 +02:00
Ajeet Shah
25be934bb1
H2: Set color form theme.colors.text.primary (#1491) 
* H2: Set color form theme.colors.primary.main

* feat: change heading color configuration from `primary.main` to `text.primary`

Co-authored-by: Oprysk <vyacheslav@redocly.com>
 2022-03-23 17:54:11 +02:00
Ryc O'Chet
09786f2a5a
feat: Add support for displaying operationId in the sidebar (#1927) 
* feat: Add support for displaying id in the sidebar

* fix: previous commit `feat: Add support for displaying id in the sidebar`

Co-authored-by: Oprysk <vyacheslav@redocly.com>
 2022-03-23 12:39:26 +02:00
Josh
ab3e8a8f80
fix: move comma out of code block in SecurityRequirement.tsx (#1924) 2022-03-23 12:12:30 +02:00
Eli$
ac6fb458a4
use x-displayName in securityDefinitions (#1444) 
Co-authored-by: elis-k <53352199+elis-k@users.noreply.github.com>
Co-authored-by: AlexVarchuk <olexandr.varchuk@gmail.com>
 2022-03-15 15:47:22 +02:00
Anastasiia
f60b475833
Fix: deprecated badge on one of any of buttons (#1930) 2022-03-15 13:22:22 +02:00
AlexVarchuk
fe67e9c332
fix: auth link scroll for Firerox (#1922) 2022-03-14 17:49:08 +02:00
AlexVarchuk
059bd8000e
fix: sanitize array of items (#1920) 2022-03-14 17:39:55 +02:00
AlexVarchuk
635f379eb0
fix: improve customization fab (#1891) 2022-03-14 15:36:50 +02:00
AlexVarchuk
57cdd9f6da
fix: external ref in schema definition (#1894) 2022-02-04 15:21:46 +02:00
Alex Varchuk
b5b0d61b35 fix: scroll in sidebar 2022-01-27 15:41:58 +02:00
Roman Hotsiy
957f1a61be
Fix expanded (#1877) 
* fix: fields not expanding after esbuild migration

* chore: fix local dev

* update snapshot

Co-authored-by: Oprysk <vyacheslav@redocly.com>
 2022-01-26 11:56:08 +02:00
AlexVarchuk
250d53a59f
fix: add schema expansion level (#1868) 
* feat: add schemaExpansionLevel
 2022-01-25 16:43:14 +02:00
Oprysk Vyacheslav
35418b1569
chore: migrate from babel to esbuild loader (#1848) 
* chore: migrate from babel to esbuild loader

* fix cypress tests
 2022-01-25 15:50:28 +02:00
Depickere Sven
18f943d2b5
fix: Response objects couldn't open (#1867) 
* This was undefined on response toggle

* Add test cases for opening response object
 2022-01-24 11:14:31 +02:00
Oprysk Vyacheslav
5694913e71
fix: writeOnly params displaying in webhook (#1866) 2022-01-20 18:36:40 +02:00
Oprysk Vyacheslav
95a7347931
fix: definition name util (#1865) 
* fix: definition name util

* update snapshot
 2022-01-20 00:01:30 +02:00
Oprysk Vyacheslav
3e47932754
chore: bump marked version (#1863) 2022-01-17 14:18:16 +02:00
Andriy Zaleskyy
6c7685e5fa
fix: No maxLength label is displayed for arrays of items #1701 (#1765) 
* fix: No maxLength label is displayed for arrays of items #1701

* Revert "fix: No maxLength label is displayed for arrays of items #1701"

This reverts commit 543ecc4d39.

* fix: No maxLength label is displayed for arrays of items #1701

* change array items display

* fix alignment

* remove theme font from labels

* update snapshot

Co-authored-by: Oprysk <vyacheslav@redocly.com>
 2022-01-05 17:11:05 +02:00
Oprysk Vyacheslav
2474b76d0d
chore: update snapshots (#1846) 2021-12-31 14:11:12 +02:00
TJT
ea8573dbd7
fix: attachHeadingsDescriptions match headings incorrectly (#1845) 
* fix: attachHeadingsDescriptions match headings incorrectly

* fix: match new line instead of `$` in MarkdownRenderer.attachHeadingsDescriptions

Co-authored-by: TJT <tjt@maimemo.com>
 2021-12-31 13:00:09 +02:00
flouthoc
831b207715
MenuBuilder: Add support for sortOperationsAlphabetically and sortTagsAlphabetically (#1843) 
* operations: Add support for sortOperationsAlphabetically

Already documented but is currently `NO-OP` and not implemented
`sortOperationsAlphabetically`.

Allows sorting operations in sidebar menu according to their `name`
configured which is by default `summary` from Swaggerspec

TLDR:
Following commit adds support for `sortOperationsAlphabetically` already
documented but not implemented here: https://redoc.ly/docs/api-reference-docs/guides/migration-guide-2-0/#automated-sorting

Signed-off-by: flouthoc <flouthoc.git@gmail.com>

* feat: move sort by prop to utils functions

* feat: add ability to sort tags

Co-authored-by: Oprysk <vyacheslav@redocly.com>
 2021-12-30 14:31:00 +02:00
Oprysk Vyacheslav
c986f0ef1a
feat: support examples in object schema (#1832) 
* feat: support examples in object schema

* revert pure components used with observer

* rename option

* update test
 2021-12-29 12:22:57 +02:00
Oprysk
6c41e95aa0 chore: fix broken test & components refactoring 2021-12-14 11:10:39 +02:00
Oprysk
a42d29d5c9 chore: bump marked version 2021-12-14 11:10:39 +02:00
Shelby Sanders
f82eb53ccf
Added support for showExtensions and $ref for Responses (#1406) 
* Corrected responses to support $ref

* Add showExtentions for Responses

* Add showExtentions support for Responses

* Update src/services/__tests__/models/Response.test.ts

Co-authored-by: Giles Wells <giles@mediagearhead.com>

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
Co-authored-by: Giles Wells <giles@mediagearhead.com>
 2021-12-09 19:43:47 +02:00
Oprysk Vyacheslav
aaa3b3280c
fix: x-examples for request body param does not display #1743 (#1826) 
* fix: x-examples for request body param does not display #1743

* lint

* fix ts
 2021-12-09 15:27:49 +02:00
Aarni Koskela
3028d3d7ac
Fix Chrome scrolling by using alternate scrollIntoViewIfNeeded (#1823) 
* Break out scrollIntoViewIfNeeded into freely usable function

* Always use alternate implementation of scrollIntoViewIfNeeded

Refs #1714

Refs #1742
 2021-12-09 12:51:02 +02:00
AlexVarchuk
bc2d9a7d9c
fix: fix scroll in example dropdown (#1803) 2021-12-09 11:04:17 +02:00
Junghyun Colin Kim
2e4663b3b7
Use an option usePathInSidebar (#1805) 
* Use an option usePathInSidebar

If this option is enabled, it displays a path in the sidebar instead of
summary.

Usage:

```js
                <RedocStandalone
                spec={props.spec}
                options={{
                    scrollYOffset:'.navbar',
                    nativeScrollbars: true,
                    usePathInSidebar:true
                }}
```

* Rename usePathInSidebar to sideNavStyle

* Rename sidebarName to sidebarLabel

* Use ternary operator

* Use enums instead of raw string
 2021-12-08 15:53:14 +02:00
AlexVarchuk
0e43ad3102
fix: add browser build for webpack 5 (#1796) 2021-11-29 14:27:06 +02:00
Oprysk Vyacheslav
b604bd8da8
fix: exclusiveMin/Max shows incorect range (#1799) 
* fix: exclusiveMin/Max shows incorect range

* cover all number range cases & add unit tests

* add more tests

* fix maximum value

* simplify humanizeNumberRange function

* simplify exclusive checks

* Update src/utils/openapi.ts

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

* update test coverage

* linting

* revert weird prettier changes

* add md files to prettier ignore

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
 2021-11-24 16:47:24 +02:00
Oprysk Vyacheslav
4fb5f914fa
chore: run prettier & add husky pre-commit hook (#1800) 2021-11-24 16:11:45 +02:00
Andriy Zaleskyy
734080c354
fix: Default boolean property value not rendered #1779 (#1781) 2021-10-27 16:55:20 +03:00
raghavi92
352a851857
fix: No match scenario in search (#1667) 
Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com>
 2021-10-11 17:34:20 +03:00
Gabriel Simon Gianotti
8e75f9929b
chore: remove commented out code (#1768) 2021-10-11 17:30:59 +03:00
Roman Hotsiy
4fb9c83525
fix: fix deref logic for oas3.1 (#1767) 2021-10-11 15:02:08 +03:00
Andriy Zaleskyy
3b8d6441bd
fix: The number of items in the array in the array is incorrect #1762 (#1763) 2021-10-11 13:05:50 +03:00
kylenarocroc
43451ba4cd
feat: add q/kdb+ syntax highlighting (#1605) 2021-10-11 12:50:09 +03:00
Roman Marshevskyy
fe6909ed80 fix: OpenAPI 3.1: Missing description when $ref used #1727 2021-10-11 11:51:17 +03:00
Roman Marshevskyy
35f77878de fix: OpenAPI 3.1: Missing description when $ref used #1727 2021-10-11 10:53:28 +03:00
AlexVarchuk
bccd21394e
fix: scrolling to the first item (#1753) 2021-09-27 12:21:59 +03:00
Mark Theisen
bd9390a5bf
feat: new option generatedPayloadSamplesMaxDepth (#1642) 2021-09-14 13:08:50 +03:00
Andriy Zaleskyy
a8e0c29685
fix: Schema for events incorrectly omits readOnly and includes writeOnly (#1720 #1540) 2021-08-31 15:39:55 +03:00
AlexVarchuk
ddf297b112
fix: nullable object's fields were missing (#1721) 2021-08-11 12:59:31 +03:00
AlexVarchuk
6a52a16d5b
fix: hideLoading options in redoc standalone (#1709) 2021-08-03 13:37:01 +03:00
AlexVarchuk
cd2d6f76e8
fix: improve openapi 3.1 (#1700) 2021-08-03 13:36:06 +03:00
Valdir Mendes
9e1ea703e5
fix: handle empty object in security array (#1678) 2021-07-30 11:18:13 +03:00
Roman Hotsiy
d724440085
feat: add yaml highlight (#1684) 
* feat: add yaml highlight

* chore: upgrade prism version
 2021-07-09 17:04:53 +03:00
ILya Volchenkov
ec50858ec4
feat: added localization for some labels (#1675) 2021-07-09 10:33:36 +03:00
romanhotsiy
b41a8b4ac7
fix: fix accidentally removed onLoaded 
fixes #1656
 2021-07-01 12:37:42 +03:00
romanhotsiy
3df72fb99f
fix: broken linkify 
fixes #1655
 2021-07-01 12:34:50 +03:00
Roman Hotsiy
f4ea368f78
feat: merge refs oas 3.1 (#1640) 2021-06-09 15:43:52 +03:00
Roman Hotsiy
c09cf9dbbe
chore: modernize build pipeline (#1635) 2021-06-09 14:57:36 +03:00
Roman Hotsiy
92387bc653
chore: upgrade dependencies (#1634) 2021-06-02 15:53:36 +03:00
AlexVarchuk
823be24b31
feat: add basic support openApi 3.1 (#1622) 2021-05-31 19:23:05 +03:00
Yevhenii Hyzyla
4b072be8d1
fix: use operation path if operation summary/description is not provided (#1596) 
resolves #1270
 2021-04-29 23:34:43 +03:00
langhabel
d7a0a4da17
fix: parse json theme string for standalone tag (#1492) 2021-04-15 10:47:40 +03:00
Olivier Beaulieu
dfc4cf1caa
fix: added missing semicolon to styling (#1578) 2021-04-12 19:24:15 +03:00
Andriy Leliv
5a9154ab1d
chore: unit tests to check loading and bundling api definitions with openapi-core (#1568) 2021-04-08 18:45:55 +03:00
Andriy Leliv
503394655d
chore: use openapi-core to bundle definition instead of json-schema-ref-parser (#1500) 
* chore: use openapi-core to bundle definition instead of json-schema-ref-parser
* chore: update: root and demo webpack configs
* chore: refactor loadAndBundleSpec
* chore: update vesions: openapi-core, redoc
* chore: rolled back webpack.config(s) to previous version
* chore: changed the way of creating core Config for bundling definition
* fix: disable eslint react/display-name
* fix: update nodejs version to 12 in travis config
* chore: optimize verification: browser or server
* chore: add fetch only for browser
* Update src/utils/loadAndBundleSpec.ts
* chore: isBrowser verification improvment
Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
 2021-04-08 15:49:15 +03:00
romanhotsiy
3ba622f3ab
fix: add includes polyfill 
fixes #1530
 2021-02-15 14:51:25 +02:00
Roman Hotsiy
8270481e9f
fix: false-positive recursive tag case when using oneOf + allOf (#1534) 2021-02-15 14:50:35 +02:00
Anton Kozachuk
d288165a4e
fix: background-color in search results (#1531) 
* fix: background-color in search results

* Delete some changes
 2021-02-15 14:14:54 +02:00
Anton Kozachuk
c874a5942c
fix: pass boolean and number values as a string in highlight function (#1512) 2021-01-30 14:19:18 +02:00
romanhotsiy
0dce880dce
fix: crash on multiple examples on parameter object 
fixes #1485
 2021-01-28 11:21:25 +02:00
romanhotsiy
040ce72a8a
fix: fix SourceCodeWithCopy component to be non-pure 2020-12-11 11:14:01 +02:00
Anna Stasiuk
8c559bcbcd
fix: add missed labels to elements (#1445) 2020-11-30 12:51:27 +02:00
Anna Stasiuk
bb4594ee58
feat: add new option hideSchemaPattern (#1475) 
* feat: add new option hideSchemaPattern
* chore: add hideSchemaPattern option to readme
 2020-11-30 11:54:46 +02:00
Roman Hotsiy
d12e410d99
feat: support multiple examples for parameters (#1470) 2020-11-23 14:00:17 +02:00
romanhotsiy
d09e744d15
fix: limit autogen json samples depth to 10 2020-11-17 11:26:04 +02:00
Anna Stasiuk
702fea0f41
feat: add tabTextColor option for responses (#1451) 2020-11-05 15:23:05 +02:00
Anna Stasiuk
6bedcf94b2
fix: fix arrow color in responses (#1452) 2020-11-05 15:22:42 +02:00