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時間
- マージ済み PR（30日）
- 59
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信
dotnet/dev-proxy の issue をすべて見る
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 78/100
QuantConnect/Documentation#2838 ·
メンテナーはふだん 1 日以内に返信
-
"Create your app": .sln/.slnx step and Solution Explorer instructions don't match current C# Dev Kitオープンarea-tutorials needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
dotnet/website-feedback#1844 ·
-
Needs: Attention :wave: v5 v5-preview5
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Azure/azure-functions-core-tools#5852 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
OrchardCMS/OrchardCore#20194 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
Gothic-Unity-Project/Gothic-Unity#487 ·
メンテナーはふだん 1 日以内に返信