Description
There is a breaking change in v1.0.0 release for describing patch operations. When generating a TypeSpec file from API requests using the TypeSpecGeneratorPlugin, the PATCH operations generated display a warning and require an update.
Expected behaviour
Generated TypeSpec file should be valid with no warnings.
Actual behaviour
Steps to reproduce
- Start Dev Proxy with configuration and start recording
- Issue PATCH request, for example...
PATCH https://jsonplaceholder.typicode.com/posts/1
Content-Type: application/json
{
"title": "foo"
}
- Stop Dev Proxy
- Inspect generated TypeSpec file
Dev Proxy Version
v0.27.0
Operating system (environment)
macOS
Shell
zsh
Configuration file
{
"$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/rc.schema.json",
"plugins": [
{
"name": "TypeSpecGeneratorPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
"configSection": "typeSpecGeneratorPlugin"
}
],
"typeSpecGeneratorPlugin": {
"$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/typespecgeneratorplugin.schema.json",
"ignoreResponseTypes": false
},
"urlsToWatch": [
"https://jsonplaceholder.typicode.com/*"
],
"logLevel": "information",
"newVersionNotification": "stable",
"showSkipMessages": true
}Additional Info
TypeSpec 1.0 Release: https://typespec.io/docs/release-notes/release-2025-05-06/
To use JSON Merge-Patch to update resources, replace the body property with an instance of MergePatchUpdate as follows:
op patchPost(@path postId: integer, @body post: MergePatchUpdate<Post>): PostResponse;
Description
There is a breaking change in v1.0.0 release for describing patch operations. When generating a TypeSpec file from API requests using the TypeSpecGeneratorPlugin, the PATCH operations generated display a warning and require an update.
Expected behaviour
Generated TypeSpec file should be valid with no warnings.
Actual behaviour
Steps to reproduce
Dev Proxy Version
v0.27.0
Operating system (environment)
macOS
Shell
zsh
Configuration file
{ "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/rc.schema.json", "plugins": [ { "name": "TypeSpecGeneratorPlugin", "enabled": true, "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll", "configSection": "typeSpecGeneratorPlugin" } ], "typeSpecGeneratorPlugin": { "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/typespecgeneratorplugin.schema.json", "ignoreResponseTypes": false }, "urlsToWatch": [ "https://jsonplaceholder.typicode.com/*" ], "logLevel": "information", "newVersionNotification": "stable", "showSkipMessages": true }Additional Info
TypeSpec 1.0 Release: https://typespec.io/docs/release-notes/release-2025-05-06/
To use JSON Merge-Patch to update resources, replace the body property with an instance of
MergePatchUpdateas follows: