Skip to content

Commit

Permalink
Updating version information, README and docs for v2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
arjun-g committed Nov 13, 2018
1 parent 0ae788e commit a399bd8
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 11 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Swagger Viewer - v2.0.2
# Swagger Viewer - v2.1.0
**Swagger Viewer lets you preview and validate Swagger 2.0 and OpenAPI files as you type in Visual Studio Code.**

It works on swagger files in json and yaml format. Preview and validation happens in real time as you type.
Expand All @@ -19,15 +19,17 @@ THEN

* Preview it in vscode Itself like this

![Swagger Preview](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/2.0.0/docs/swagger-preview.gif)
![Swagger Preview](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/master/docs/swagger-preview.gif)

![Swagger Context Menu](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/2.0.0/docs/swagger-context-menu.png)
![Swagger Context Menu](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/master/docs/swagger-context-menu.png)

### Opening In External browser
## Configurations

![Swagger Settings](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/master/docs/swagger-settings.png)

If you want to preview the changes in external browser change the settings `swaggerViewer.previewInBrowser` to `true`
### Opening In External browser

![Swagger Settings](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/2.0.0/docs/swagger-settings.png)
If you want to preview the changes in external browser change the settings `Preview In Browser` to `true` in `User/Workspace Settings`

THEN
* Run the Command `Preview Swagger`.
Expand All @@ -39,20 +41,29 @@ OR

### Change Default Port

Default port of the preview url can be changed by changing the `swaggerViewer.defaultPort` value in `User/Workspace Settings`
Default port of the preview url can be changed by changing the `Default Port` value in `User/Workspace Settings`

### Show Only File Name

In the preview title the file name along with the full path is displayed by default. It can be changed to show only the file name by changing the `Show Only File Name` to `true` in `User/Workspace Settings`

## Validation (Partial)

Swagger Viewer validates your documents against Swagger 2.0 and OpenAPI specifications. If there are any issues it will be shown as a warning in the problems panel. Right now only one validation error will be shown even if there are multiple issues.

![Swagger Validation](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/2.0.0/docs/swagger-validation.png)
![Swagger Validation](https://cdn.rawgit.com/arjun-g/vs-swagger-viewer/master/docs/swagger-validation.png)

## TODO
* Show all the errors during validation
* Add code complete support based on Swagger 2.0 and OpenAPI specifications

## Releases

**v2.1.0 Changes**
* Replaced the deprecated `vscode.previewHtml` with Webview - [#50](https://github.com/arjun-g/vs-swagger-viewer/issues/50)
* Added configuration option to show only file name in title
* Added support for OpenAPI 3.0.3 validation - By [@ackintosh](https://github.com/ackintosh) [https://github.com/arjun-g/vs-swagger-viewer/pull/49](https://github.com/arjun-g/vs-swagger-viewer/pull/49)

**v2.0.2 Changes**
* Fixed issues with parsing yaml due in yamljs library. Changed to js-yaml library.
* Fixed issue where validation errors are not cleared in yaml file.
Expand Down Expand Up @@ -110,4 +121,5 @@ Swagger Viewer utilizes the following open source projects
* [@tmsns](https://github.com/tmsns)
* [@DW8Reaper](https://github.com/DW8Reaper)
* [@Zlass](https://github.com/Zlass)
* [@Raptor399](https://github.com/Raptor399)
* [@Raptor399](https://github.com/Raptor399)
* [@ackintosh](https://github.com/ackintosh)
Binary file modified docs/swagger-context-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/swagger-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/swagger-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"theme": "dark"
},
"license": "SEE LICENSE IN LICENSE.md",
"version": "2.0.2",
"version": "2.1.0",
"publisher": "Arjun",
"engines": {
"vscode": "^1.23.0"
Expand Down Expand Up @@ -45,7 +45,7 @@
],
"configuration": {
"type": "object",
"title": "Swagger Viewer configuration",
"title": "Swagger Viewer Configuration",
"properties": {
"swaggerViewer.defaultPort": {
"type": "integer",
Expand Down

0 comments on commit a399bd8

Please sign in to comment.