Commit Graph

183 Commits

Author SHA1 Message Date
迷渡
4846259de3
docs: minor syntax highlight fix on the README (#1549) 2021-03-02 09:35:28 +02:00
Oleksiy Kachynskyy
6086c6c89f
docs: remove outdated config option from readme (#1543) 2021-02-22 15:50:33 +02:00
romanhotsiy
755a9095f5
chore: update travis badge url 2021-01-30 23:36:10 +02:00
Karl Scheirer
a5e8e818c8
docs: document theme options (#1438) 2021-01-08 14:05:10 +02:00
jabba-jedi
f0755a804f
docs: fix the Rebilly link 2020-12-10 12:38:12 +02:00
Roman Hotsiy
2a329c1bec
docs: fix menuToggle default value
fixes #1476

[ci skip]
2020-12-01 15:24:20 +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
Karl Scheirer
64b01162dc
docs: add 3 vendor extensions to list (#1457) 2020-11-10 10:21:02 +02:00
Hleb Albau
7ffaf9ff72
docs: add 'maxDisplayedEnumValues' option to docs (#1421) 2020-10-27 10:54:08 +02:00
David Goss
086302bb23
docs: unqualify mobx version for react usage (#1380)
Per https://github.com/Redocly/redoc/issues/1189#issuecomment-606857342 the latest version works now, and the currently-specified version doesn't.
2020-10-13 14:56:53 +03:00
Roman Hotsiy
7af2efe731
feat: new option simpleOneOfTypeLabel 2020-08-04 12:21:58 +03:00
Roman Hotsiy
becc2f5856
fix: depreacate x-code-samples, rename to x-codeSamples for consistency 2020-05-10 22:11:01 +03:00
Roman Hotsiy
afc7a95f13
docs: update usages examples 2020-03-17 16:46:43 +02:00
Roman Hotsiy
a24142b3fa
chore: migrate yarn -> npm 2020-03-17 11:06:03 +02:00
Roman Hotsiy
7608800d0a
feat: new option expandSingleSchemaField 2020-03-16 16:58:28 +02:00
Roman Hotsiy
eaaa99d68e
feat: new option payloadSampleIdx 2019-12-12 19:12:50 +02:00
bwjohnson-ss
7cabd4b90d docs: fix link to x-nullable docs from README (#1135) 2019-12-10 08:03:46 +02:00
Alex
8bfa364010 docs: improve options documentation (#1071)
* Sort by name
* Document `hideSingleRequestSampleTab`
* End option description with `.`
2019-10-16 15:58:02 +03:00
Roman Hotsiy
9f0694c10f
docs: expandDefaultServerVariables 2019-09-30 12:56:09 +03:00
Quinn Blenkinsop
d74e2d6c46 docs: Add core-js as peer dependency in docs (#1018) 2019-08-20 10:12:27 +03:00
Roman Hotsiy
1504ade0e2
chore: add docs 2019-07-29 17:33:22 +03:00
Aleksandr Karo
d3f1c1677c feat: add sampleCollapseLevel option (#937)
* feat: add sampleCollapseLevel option

* fix: rename sampleCollapseLevel option to jsonSampleExpandLevel
Change README.md description

* fix: provide maxCollapseLevel option via argument

* fix: rename normalizer function and some vars
2019-07-29 15:26:16 +03:00
David Beacham
0eb1e66a10 feat: add x-additionalPropertiesName (#622) (#944)
* Add x-additionalPropertiesName (#622)

Supply custom name to be displayed for property name of
`additionalProperties`.

* Include prettier output for Schema.ts
2019-06-18 11:41:48 +03:00
Roman Hotsiy
d78029a04e
chore: move repo to Redocly org 2019-06-04 15:47:22 +03:00
Sander van de Graaf
18590ccc60 docs: Fixed typo (#921)
[ci skip]
2019-05-22 09:37:42 +03:00
Roman Hotsiy
301ca225ff
docs: add note about IE11 support when using as React component
resolves #809
2019-05-13 00:07:43 +03:00
davchen51
649940bfe5 docs: add additional property to theme usage doc (#876) 2019-03-31 11:08:33 +03:00
Alex Scammon
30cbba3f6f docs: Fix the demo specUrl (#778) 2019-01-10 10:03:41 +02:00
Sebastián Ramírez
ab943a8dd5 docs: Add FastAPI to real-life usages in README (#756) 2018-12-24 11:25:31 +02:00
Patrick Elam
4f60ec85aa docs: fixed links to oas spec page (#728) 2018-11-30 10:09:40 +02:00
mknoszlig
4691d78dc0 docs: fix link to Dockerfile. (#710)
[ci skip]
2018-11-14 14:37:14 +02:00
Robert DeRose
5c9f488656 docs: corrected Docker Port in README.md (#691)
The command to launch ReDoc with Docker had the `-p` values reversed.
According to the Docker Docs, it should be `HOST_PORT:CLIENT_PORT`.
The Nginx service is running on port 80 inside the container, 8080 is the 
port exposed on the host.
2018-11-05 16:44:44 +02:00
Petr Flaks
97db54aa2e docs: Add information to README about Docker image & Docker Hub (#676)
closes #657
2018-10-18 18:27:31 +03:00
TATSUNO Yasuhiro
10bca66dce feat: New option onlyRequiredInSamples (#646)
* Add onlyRequiredInSamples option that let user to show only required fields in Request samples.
2018-10-05 16:14:40 +03:00
Roman Hotsiy
56ad8443b7
docs: add note about peerDependencies
closes #662
2018-10-04 11:15:55 +03:00
Roman Hotsiy
b87cf0d8d5
feat: new option sortPropsAlphabetically 2018-10-04 11:10:37 +03:00
Roman Hotsiy
3c8d6b623c
chore: fix lint issue + update readme 2018-10-03 11:02:13 +03:00
Ingo Claro
e9610e92d4 feet: add the option to render vendor extensions (#552)
* add the option to render vendor extensions

* refactor Extensions, move Redoc extension list to utils file

* feat: new option showExtensions (support list of extensions)
2018-10-03 10:02:30 +03:00
Roman Hotsiy
d4ab5adc17
feat: new option disableSearch 2018-07-17 11:07:49 +03:00
Roman Hotsiy
f5c980ab51
docs: update callback and onLoaded docs 2018-06-25 13:56:52 +03:00
Roman Hotsiy
9a34f22aff
docs: describe callback param to Redoc.init
fixes #381
2018-06-01 18:37:36 +03:00
Roman Hotsiy
e06f6e83de
docs: remove 'v1.x' from demo link
[ci skip]
2018-05-15 13:40:53 +03:00
Mason Malone
e10b314ba3 docs: Fix a couple typos and a link in README.md (#480) 2018-05-03 11:46:30 +03:00
Roman Hotsiy
de9638443f
chore: update links in README 2018-03-21 20:30:18 +02:00
Roman Hotsiy
059b8cddec
docs: improve readme
[ci skip]
2018-03-21 17:58:01 +02:00
Roman Hotsiy
ad0a2b9d3e
docs: fix broken links in README
[ci skip]
2018-03-21 17:52:45 +02:00
Roman Hotsiy
0382034ec2
Merge branch 'react-rewrite' 🎉 2018-03-21 17:47:35 +02:00
Roman Hotsiy
3f6e221b4c
docs: add CLI examples 2018-03-20 11:39:53 +02:00
Roman Hotsiy
03cc781b8d
chore: update redoc-cli docs 2018-03-18 17:56:25 +02:00
Roman Hotsiy
b0dd7d5cb1
chore: add bundlesize test + update readme 2018-03-17 19:56:08 +02:00
Roman Hotsiy
3bbd358b24
docs: CLI basic docs 2018-03-15 20:56:11 +02:00
Roman Hotsiy
454e5bd0e9
feat: new option hide-download-button
resolves #394
2018-02-16 12:45:33 +02:00
Cesar Level
a7c3d622bb chore: Added ReDoc new Logo (#413) 💅 2018-01-23 13:45:18 +02:00
Roman Hotsiy
b9665d5f45
chore: drop bower support 🔥 2018-01-21 22:45:26 +02:00
David J. Felix
6b036ac707 chore: Fix demo link (#398) 2017-12-25 15:08:17 +02:00
Roman Hotsiy
a1604c609e
📝 Update readme 2017-11-23 11:57:07 +02:00
Roman Hotsiy
77f2a8b48e
clean up .travis.yml + README.md 2017-11-19 22:17:09 +02:00
Roman Hotsiy
4c3b4aa589
Initial React rewrite 2017-10-12 00:01:37 +03:00
Roman Hotsiy
278e5d7917
v1.19.0 2017-09-21 18:22:24 +03:00
Roman Hotsiy
f2ed92c69e
feat: add native-scrollbars option to workaround scrolling perf issues 2017-09-21 18:04:34 +03:00
Roman Hotsiy
56d62e5ab2
feat: add ignoredHeaderParameters option 2017-09-21 11:36:18 +03:00
Phil Sturgeon
8d849a63da fix: Clearly label version compatibility
closes #338

Great idea from @ThatBrianDude
2017-09-11 22:10:37 +03:00
Roman Hotsiy
dd6dfa1f1a Add links to redoc.ly 🏗
[ci skip]
2017-08-28 12:33:26 +03:00
Roman Hotsiy
c819bd67ea Add new ReDoc logo to README 🖼, kudos to @cesarlevel 2017-08-17 23:35:34 +03:00
Roman Hotsiy
2ebca4bb03
feat: add hide-loading option
closes #315
2017-08-02 15:35:26 +03:00
Blake Erickson
75bb68c9ca Update README.md (#279)
fix discourse URL.
2017-06-01 17:19:19 +03:00
Roman Hotsiy
bbdf1ad991 docs: add a security note 🛡 to README
[skip ci]
2017-05-12 12:51:22 +03:00
Roman Hotsiy
c0698bb215
fix: prevent possible xss using untrusted-spec option 2017-05-12 12:42:24 +03:00
Roman Hotsiy
c08b0a9994
chore: revert "Replace david-dm badge with gemnasium"
[ci-skip]

This reverts commit fed2f378df.
2017-05-05 13:33:19 +03:00
Roman Hotsiy
f7affbfb39
docs: add docs for path-in-middle-panel 2017-04-23 17:42:26 +03:00
Roman Hotsiy
00b304a4be
new: option to disable authentication auto adding 2017-04-19 12:42:09 +03:00
Roman Hotsiy
b9740bfe55
refactor: renamve Method to Operation 2017-03-30 15:18:26 +03:00
Roman Hotsiy
9e0283849a Merge pull request #227 from brendo/support-x-examples-request
Support x-examples vendor extension for requests
2017-03-13 09:15:57 +02:00
Roman Hotsiy
d99f2562ac
feat: support for OpenAPI object as a parameter for init
closes #224
2017-03-09 21:00:45 +02:00
Brendan Abbott
3c569cde6e Support x-examples vendor extension for requests 2017-03-09 20:55:23 +10:00
Roman Hotsiy
258009b1f7
chore: update sample index.html with utf meta (credits @sarus) #213 2017-02-27 18:00:55 +02:00
Roman Hotsiy
c724df48f4
feat: new option required-props-first
closes #191
2017-02-27 13:12:53 +02:00
Roman Hotsiy
fa9b634126
Revert "fix: remove unused hide-hostname option"
This reverts commit 7031176330.
2017-02-26 01:59:18 +02:00
Roman Hotsiy
7031176330
fix: remove unused hide-hostname option
(unused since eba219e)
2017-02-26 01:00:23 +02:00
Roman Hotsiy
a1aefa4123
docs: docs for x-servers 2017-02-26 01:00:08 +02:00
Roman Hotsiy
4d14c01e02
docs: Add real-life usages to README 2017-02-14 12:18:34 +02:00
Roman Hotsiy
a460dfa6ec
Tick next item in roadmap 2017-02-09 15:34:20 +02:00
Roman Hotsiy
fed2f378df
Replace david-dm badge with gemnasium [ci skip] 2017-02-02 10:50:39 +02:00
Roman Hotsiy
60c9ef59bc Update README.md 2017-01-31 12:18:28 +02:00
Roman Hotsiy
c6b1fc8e72
Enhance README 2017-01-31 12:09:46 +02:00
Roman Hotsiy
f902abd5f1
add x-tagGroups docs 2016-12-25 23:47:33 +02:00
Roman Hotsiy
95f2da8b97
add expand-responses option 2016-12-14 14:49:02 +02:00
Roman Hotsiy
06adadef2e Update README.md [skip ci] 2016-12-11 22:57:22 +02:00
Roman Hotsiy
0e8402aa0a Update README.md 2016-12-02 08:00:14 +02:00
Roman Hotsiy
fc46931551
Add lazyRendering option 2016-11-30 13:23:24 +02:00
Roman Hotsiy
878d3191f9 README: Add button link to yeoman-generator 2016-11-29 19:11:39 +02:00
Roman Hotsiy
d1862ecea0
typo fix 2016-11-02 13:59:42 +02:00
Roman Hotsiy
2756b4bebf
Add new badges 2016-11-02 13:57:49 +02:00
Roman Hotsiy
4b6cc2ea79 Merge pull request #132 from bfirsh/docker-development-environment
Add Docker development environment
2016-11-01 23:32:40 +02:00
Ben Firshman
c1de34703a
Add Docker development environment 2016-11-01 11:56:06 -07:00
Ben Firshman
2453ffb11b
Add option to hide hostname in method definition
This allows ReDoc to be used for self-hosted tools where the
hostname may not be known.
2016-11-01 11:44:22 -07:00
Roman Hotsiy
93e7ed04f7
Remove codeclimate 2016-11-01 16:59:06 +02:00
Roman Hotsiy
9955cb8fec
Security definitions docs 2016-10-31 12:32:17 +02:00
Roman Hotsiy
84349a451a
Fix dev servers and scss files (fixes #97) 2016-10-31 11:03:15 +02:00
amanganiello
c1f1944cae fix issue #116 2016-09-22 09:13:29 +02:00