OpenApiSpecGeneratorPlugin omits parameters and response headers from generated specs
维护者通常 1 天内回复
评估
这个 Issue 还没有评估数据。
描述
Description
OpenApiSpecGeneratorPlugin never emits query, header or path parameters, or response headers, in generated OpenAPI specs.
Since the move to Microsoft.OpenApi 3.x, collection properties such as OpenApiOperation.Parameters, OpenApiPathItem.Parameters and OpenApiResponse.Headers are null by default. The plugin adds to them with null-conditional calls, so every addition is a silent no-op:
DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs:321:operation.Parameters?.Add(...)(query string parameters):359:operation.Parameters?.Add(parameter)(request header parameters):430:openApiResponse.Headers?.Add(...)(response headers):558:operation.Parameters?.Add(parameter)(parametrized path segments):723:pathItem.Parameters?.Add(...)(path parameters)
OpenApiOperation (line 249) and OpenApiResponse (line 386) are created without initializing these collections.
Found while working on #1147.
Expected behaviour
Generated specs list the query, header and path parameters, and the response headers, observed in recorded traffic.
Actual behaviour
Operations have no parameters and responses have no headers.
Steps to reproduce
- Enable
OpenApiSpecGeneratorPluginand watch an API. - Record requests that use query string parameters, custom request headers and parametrized paths (for example
/users/123?$select=name), and whose responses include headers. - Stop recording and open the generated spec. Parameters and response headers are missing.
Dev Proxy Version
4.0.0 (main @ ae30e27)
Operating system (environment)
N/A (all)
Shell
N/A
Configuration file
N/A
Additional Info
Fix: initialize the collections (for example Parameters = [], Headers = new Dictionary<string, IOpenApiHeader>()) or use ??= before adding. Add tests that cover parameters and response headers in generated specs.
- 主要语言
- C#
- 星标
- 838
- 派生
- 90
- 平均合并
- 2 天 11 小时
- 30 天内合并 PR
- 59
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
dotnet/dev-proxy 的其他 Issue
-
GetTokenizedUrl fails on parenthesized Graph URL segments可能已有人在做 @waldekmastykarz 于 3 天前认领。 未关闭work in progress
dotnet/dev-proxy#2041 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Support discriminator for oneOf in OpenApiValidationPlugin可能已有人在做 @waldekmastykarz 于 3 天前认领。 未关闭work in progress
dotnet/dev-proxy#2040 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Validate language-model mock output against the schema in OpenApiMockResponsePlugin可能已有人在做 @waldekmastykarz 于 3 天前认领。 未关闭on hold
dotnet/dev-proxy#2039 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Support bring-your-own LLM (hosted OpenAI-compatible / Azure OpenAI) for language model integration可能已有人在做 @waldekmastykarz 于 3 天前认领。 未关闭work in progress
dotnet/dev-proxy#2034 · 已指派 1 人 ·
维护者通常 1 天内回复
-
breaking change on hold
难度 3/5 1-2 天 新手友好度 65/100
dotnet/dev-proxy#1928 · 1 条评论 ·
维护者通常 1 天内回复
相似的 Issue
-
VB -> C#
难度 2/5 1-3 小时 新手友好度 72/100
icsharpcode/CodeConverter#1301 ·
维护者通常 3 天内回复
-
PettingZoo wrappers send only the first action component to every action dimension可能已有人在做 @RaphaelFakhri 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 73/100
Unity-Technologies/ml-agents#6341 ·
维护者通常 1 天内回复
-
Area: World-Readiness
难度 1/5 1 小时以内 新手友好度 90/100
microsoft/calculator#2522 ·
-
needs-triage
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 2 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 64/100