redoc 2.0.0-rc.0 → 2.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
# [2.0.0-rc.1](https://github.com/Rebilly/ReDoc/compare/v2.0.0-rc.0...v2.0.0-rc.1) (2019-01-17)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* allow docker container serving under non-root URLs ([#731](https://github.com/Rebilly/ReDoc/issues/731)) ([cfb6f0f](https://github.com/Rebilly/ReDoc/commit/cfb6f0f)), closes [#730](https://github.com/Rebilly/ReDoc/issues/730)
|
|
7
|
+
* make example/defaults badge consistent with code blocks ([fa39ce4](https://github.com/Rebilly/ReDoc/commit/fa39ce4))
|
|
8
|
+
* pattern constrain spacing ([c7436f2](https://github.com/Rebilly/ReDoc/commit/c7436f2))
|
|
9
|
+
* sidebar navigation issues when scrollYOffset is float number ([c04f387](https://github.com/Rebilly/ReDoc/commit/c04f387)), closes [#748](https://github.com/Rebilly/ReDoc/issues/748)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
1
13
|
# [2.0.0-rc.0](https://github.com/Rebilly/ReDoc/compare/v2.0.0-alpha.41...v2.0.0-rc.0) (2018-11-27)
|
|
2
14
|
|
|
3
15
|
|
package/README.md
CHANGED
|
@@ -70,6 +70,7 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based **CDN**:
|
|
|
70
70
|
- [Shopify Draft Orders](https://help.shopify.com/api/draft-orders)
|
|
71
71
|
- [Discourse](http://docs.discourse.org)
|
|
72
72
|
- [APIs.guru](https://apis.guru/api-doc/)
|
|
73
|
+
- [FastAPI](https://github.com/tiangolo/fastapi)
|
|
73
74
|
|
|
74
75
|
## Deployment
|
|
75
76
|
|
|
@@ -161,7 +162,7 @@ Also you can pass options:
|
|
|
161
162
|
|
|
162
163
|
```js
|
|
163
164
|
<RedocStandalone
|
|
164
|
-
specUrl="http://rebilly.github.io/RebillyAPI/
|
|
165
|
+
specUrl="http://rebilly.github.io/RebillyAPI/openapi.json"
|
|
165
166
|
options={{
|
|
166
167
|
nativeScrollbars: true,
|
|
167
168
|
theme: { colors: { main: '#dd5522' } },
|
|
@@ -175,7 +176,7 @@ You can also specify `onLoaded` callback which will be called each time Redoc ha
|
|
|
175
176
|
|
|
176
177
|
```js
|
|
177
178
|
<RedocStandalone
|
|
178
|
-
specUrl="http://rebilly.github.io/RebillyAPI/
|
|
179
|
+
specUrl="http://rebilly.github.io/RebillyAPI/openapi.json"
|
|
179
180
|
onLoaded={error => {
|
|
180
181
|
if (!error) {
|
|
181
182
|
console.log('Yay!');
|
|
@@ -205,7 +206,7 @@ Also you may rewrite some predefined environment variables defined in [Dockerfil
|
|
|
205
206
|
You can inject Security Definitions widget into any place of your specification `description`. Check out details [here](docs/security-definitions-injection.md).
|
|
206
207
|
|
|
207
208
|
### Swagger vendor extensions
|
|
208
|
-
ReDoc makes use of the following [vendor extensions](
|
|
209
|
+
ReDoc makes use of the following [vendor extensions](https://swagger.io/specification/#specificationExtensions):
|
|
209
210
|
* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo
|
|
210
211
|
* [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for handling out common things like Pagination, Rate-Limits, etc
|
|
211
212
|
* [`x-code-samples`](docs/redoc-vendor-extensions.md#x-code-samples) - specify operation code samples
|