Skip to content

Commit fd723aa

Browse files
authored
Update readme and changelog (#78)
* Update readme and changelog * Update CHANGELOG.md with snippets and status bar changes
1 parent 0c80c42 commit fd723aa

File tree

2 files changed

+74
-20
lines changed

2 files changed

+74
-20
lines changed

CHANGELOG.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,41 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.3.0] - 2024-04-25
9+
10+
### Added:
11+
12+
- Config diagnostic: Schema check support for beta installations
13+
- Dev Proxy detection: Support for beta installations
14+
- Setting: Version Preference setting determines which version toolkit should use when installed side-by-side
15+
- Snippet: `devproxy-plugin-api-center-onboarding` - ApiCenterOnboardingPlugin instance
16+
- Snippet: `devproxy-plugin-api-center-onboarding-config` - ApiCenterOnboardingPlugin config section
17+
- Snippet: `devproxy-plugin-api-center-production-version` - ApiCenterProductionVersionPlugin instance
18+
- Snippet: `devproxy-plugin-api-center-production-version-config` - ApiCenterProductionVersionPlugin config section
19+
- Snippet: `devproxy-plugin-entra-mock-response` - EntraMockResponsePlugin instance
20+
- Snippet: `devproxy-plugin-entra-mock-response-config` - EntraMockResponsePlugin config section
21+
- Snippet: `devproxy-plugin-mock-request` - MockRequestPlugin instance
22+
- Snippet: `devproxy-plugin-mock-request-config` - MockRequestPlugin config section
23+
- Code Lens: `ApiCenterOnboardingPlugin`
24+
- Code Lens: `ApiCenterProductionVersionPlugin`
25+
- Code Lens: `EntraMockResponsePlugin`
26+
- Code Lens: `MockRequestPlugin`
27+
28+
### Changed:
29+
30+
- Snippets: All snippets that reference schemas updated to use `v0.17.1` schema
31+
- Snippets: Removed trailing comma from config section snippets
32+
- Status bar: Replaced sync icon with loading icon
33+
- Readme: Snippets table updated
34+
- Dev Proxy detection: Improved latest version check logic, uses `devproxy outdated -s` command
35+
36+
### Fixed:
37+
38+
- Fixed broken link on `OpenApiSpecGeneratorPlugin` code lens
39+
40+
### Removed:
41+
42+
- Config diagnostic: Check for empty `urlsToWatch`
943

1044
## [0.2.0] - 2024-02-15
1145

README.md

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,49 @@
11
# Dev Proxy Toolkit
22

3-
[Dev Proxy](https://aka.ms/devproxy) is a command line tool that helps you simulate behaviors and errors of cloud APIs.
3+
[Dev Proxy](https://aka.ms/devproxy) is an API simulator that helps you effortlessly test your app beyond the happy path.
44

55
The Dev Proxy Toolkit extension for Visual Studio Code makes it easy to create and update configuration files.
66

7+
> **IMPORTANT**
8+
>
9+
> Dev Proxy Toolkit is designed to be used with the latest version of Dev Proxy, v0.17.1. If you are using an earlier build some features may not work as intended.
10+
>
11+
712
## Features
813

14+
The following sections describe the features that the extension contributes to Visual Studio Code when installed
15+
16+
### Diagnostics
17+
18+
- Check for missing `configSection` property in plugin instance for plugins that require configuration
19+
- Check for missing `configSection` when defined in plugin instance
20+
- Check that schema matches installed version of Dev Proxy
21+
22+
### Code Actions
23+
24+
- Update schema to match installed version of Dev Proxy
25+
26+
### Code Lenses
27+
28+
- Plugin documentation link
29+
30+
### Notifications
31+
32+
- Not installed
33+
- New version detection
34+
35+
### Status Bar
36+
37+
- Display installed Dev Proxy version
38+
- Display waring when Dev Proxy is not latest version
39+
- Display tick if Dev Proxy is latest version (check based on `newVersionNotification` config setting)
40+
- Display radio tower when Dev Proxy is running
41+
- Display error is Dev Proxy is not installed
42+
43+
### Settings
44+
45+
- `devproxytoolkit.versionPreference` - Determines the version to use when Dev Proxy and Dev Proxy Beta are installed side by side. Can be `stable` (default) or `beta`.
46+
947
### Snippets
1048

1149
| Prefix | Description |
@@ -66,21 +104,3 @@ The Dev Proxy Toolkit extension for Visual Studio Code makes it easy to create a
66104
| `devproxy-plugin-rate-limiting-file` | Dev Proxy rate limiting file |
67105
| `devproxy-plugin-rate-limiting-file-schema` | Dev Proxy rate limiting file schema |
68106
| `devproxy-plugin-retry-after` | RetryAfterPlugin instance |
69-
70-
### Diagnostics
71-
72-
The following diagnostic checks are performed:
73-
74-
- Check for empty `urlsToWatch`
75-
- Check for missing `configSection` property in plugin instance for plugins that require configuration
76-
- Check for missing `configSection` when defined in plugin instance
77-
- Check that schema matches installed version of Dev Proxy
78-
- Code action to update schema to correct version
79-
80-
### Dev Proxy detection
81-
82-
The following checks are performed:
83-
84-
- Check if Dev Proxy is installed
85-
- Check if Dev Proxy is the latest version
86-
- Check if Dev Proxy is running

0 commit comments

Comments
 (0)