diff --git a/CHANGELOG.md b/CHANGELOG.md index 4845152c..4a2ffa84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ # Changelog # This package follows standard semvar, `..`. No breaking changes will be introduced to existing `` versions. +## 2.0 +* `show-server-selection` has now be inverted to be `hide-server-selection` this brings it in line with how html boolean attributes are supposed to work. If you set this value to false previously, now you can hide the section using the new property. +* `allow-authentication` has now be inverted to be `hide-authentication` this brings it in line with how html boolean attributes are supposed to work. If you set this value to false previously, now you can hide the section using the new property. + ## 1.1 ## * Support dynamic curl creation. * Support inline image displays. diff --git a/README.md b/README.md index 303038d0..4b1d982c 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ Web Component Custom Element for Open-API spec viewing, with automatic integrati ## Documentation +* [Migrating from v1 to v2 of openapi-explorer](./CHANGELOG.md#2.0) - Review the breaking changes * [Property and variables documentation](./docs/documentation.md) * [Examples (Vue, React, JS, and more)](./docs/examples.md) * Generate the open specification document necessary for this library - by using an editor or by following the [Open API Specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) diff --git a/docs/documentation.md b/docs/documentation.md index a15e06a3..379f5616 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -16,8 +16,8 @@ * `schema-expand-level` - [9999] Expands the display of schemas and models to this depth. Set to `1` to display only the first level properties. ### Hide/Show Sections -* `show-authentication` - Show the authentication section -* `show-server-selection` - Show server selection section +* `hide-authentication` - Hide the authentication section +* `hide-server-selection` - Hide server selection section * `hide-components` - Hide the OpenAPI specification components from being displayed ### Custom configuration diff --git a/mocks/index.html b/mocks/index.html index 6e0d2993..f7cc3904 100644 --- a/mocks/index.html +++ b/mocks/index.html @@ -39,7 +39,14 @@ --> - + + +