Skip to content

Commit 8d849a6

Browse files
philsturgeonRomanHotsiy
authored andcommitted
fix: Clearly label version compatibility
closes #338 Great idea from @ThatBrianDude
1 parent e39bdc2 commit 8d849a6

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
## Features
2020
- Extremely easy deployment
21-
- The widest OpenAPI features support (yes, it supports even `discriminator`) <br>
21+
- The widest OpenAPI v2.0 features support (yes, it supports even `discriminator`) <br>
2222
![](docs/images/discriminator-demo.gif)
2323
- Neat **interactive** documentation for nested objects <br>
2424
![](docs/images/nested-demo.gif)
@@ -32,6 +32,7 @@
3232
- Multiple ReDoc instances on single page ([example](demo/examples/multiple-apis/index.html))
3333

3434
## Roadmap
35+
- [ ] [OpenAPI v3.0 support](https://github.com/Rebilly/ReDoc/issues/312)
3536
- [x] ~~performance optimizations~~
3637
- [x] ~~better navigation (menu improvements + search)~~
3738
- [ ] ability to simple branding/styling
@@ -44,6 +45,12 @@ We host the latest and all the previous ReDoc releases on GitHub Pages-based **C
4445
- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
4546
- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js this file is updated with each release of ReDoc and may introduce breaking changes. **Not recommended to use in production.** Use particular release or `v1.x.x`.
4647

48+
## Version Guidance
49+
| ReDoc Release | OpenAPI Specification |
50+
|:--------------|:----------------------|
51+
| 1.18.x | 2.0 |
52+
| 1.17.x | 2.0 |
53+
4754
## Some Real-life usages
4855
- [Rebilly](https://rebilly.github.io/RebillyAPI)
4956
- [Docker Engine](https://docs.docker.com/engine/api/v1.25/)

0 commit comments

Comments
 (0)