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
+25-49
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@
21
21
22
22
This repository publishes three different NPM modules:
23
23
24
-
*[swagger-ui](https://www.npmjs.com/package/swagger-ui) is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc.).
24
+
*[swagger-ui](https://www.npmjs.com/package/swagger-ui) is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc).
25
25
*[swagger-ui-dist](https://www.npmjs.com/package/swagger-ui-dist) is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies.
26
26
*[swagger-ui-react](https://www.npmjs.com/package/swagger-ui-react) is Swagger UI packaged as a React component for use in React applications.
27
27
@@ -33,62 +33,44 @@ If you are looking for plain ol' HTML/JS/CSS, [download the latest release](http
33
33
## Compatibility
34
34
The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:
35
35
36
-
| Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes |
SwaggerUI uses [Scarf](https://scarf.sh/) to collect [anonymized installation analytics](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-what-information-does-scarf-js-send-about-me). These analytics help support the maintainers of this library and ONLY run during installation. To [opt out](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics), you can set the `scarfSettings.enabled` field to `false` in your project's `package.json`:
51
-
52
-
```
53
-
// package.json
54
-
{
55
-
// ...
56
-
"scarfSettings": {
57
-
"enabled": false
58
-
}
59
-
// ...
60
-
}
61
-
```
62
-
63
-
Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` as part of the environment that installs your npm packages, e.g., `SCARF_ANALYTICS=false npm install`.
36
+
Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes
Integration tests can be run locally with `npm run e2e` - be sure you aren't running a dev server when testing!
94
76
@@ -108,9 +90,3 @@ To help with the migration, here are the currently known issues with 3.X. This l
108
90
## Security contact
109
91
110
92
Please disclose any security-related issues or vulnerabilities by emailing [[email protected]](mailto:[email protected]), instead of using the public issue tracker.
111
-
112
-
## License
113
-
114
-
SwaggerUI is licensed under [Apache 2.0 license](https://github.com/swagger-api/swagger-ui/blob/master/LICENSE).
115
-
SwaggerUI comes with an explicit [NOTICE](https://github.com/swagger-api/swagger-ui/blob/master/NOTICE) file
116
-
containing additional legal notices and information.
0 commit comments