You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10Lines changed: 10 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@
6
6
7
7
**This is the new version of swagger-ui, 3.x. Want to learn more? Check out our [FAQ](http://swagger.io/new-ui-faq/).**
8
8
9
+
As a brand new version, written from the ground up, there are some known issues and unimplemented features. Check out the [Known Issues](#known-issues) section for more details.
10
+
9
11
For the older version of swagger-ui, refer to the [*2.x branch*](https://github.com/swagger-api/swagger-ui/tree/2.x).
10
12
11
13
## Compatibility
@@ -41,6 +43,14 @@ If you just want to see your specs, open `public/index.html` in your browser dir
41
43
42
44
If you'd like to make modifications to the codebase, run the dev server with: `npm run dev`.
43
45
46
+
### Known Issues
47
+
48
+
To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were no implemented in previous versions.
49
+
50
+
- Currently, the only configuration options available are the `url` and `spec`.
51
+
- The JSON Form Editor is not implemented.
52
+
- Shebang URL support for operations is missing.
53
+
- Support for `collectionFormat` is partial.
44
54
45
55
##### Browser support
46
56
Swagger UI works in the latest versions of Chrome, Safari, Firefox, Edge and IE11.
0 commit comments