OpenApiSpecGeneratorPlugin omits parameters and response headers from generated specs
Les mainteneurs répondent en général sous 1 jour
Évaluation
Cette issue n'a pas encore été évaluée.
Description
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.
- Langage dominant
- C#
- Étoiles
- 838
- Forks
- 90
- Merge moyen
- 2 j 11 h
- PR mergées (30 j)
- 59
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de dotnet/dev-proxy
-
GetTokenizedUrl fails on parenthesized Graph URL segmentsPeut-être pris @waldekmastykarz l’a pris il y a 4 jours. Ouvertework in progress
dotnet/dev-proxy#2041 · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Support discriminator for oneOf in OpenApiValidationPluginPeut-être pris @waldekmastykarz l’a pris il y a 4 jours. Ouvertework in progress
dotnet/dev-proxy#2040 · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Validate language-model mock output against the schema in OpenApiMockResponsePluginPeut-être pris @waldekmastykarz l’a pris il y a 4 jours. Ouverteon hold
dotnet/dev-proxy#2039 · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Support bring-your-own LLM (hosted OpenAI-compatible / Azure OpenAI) for language model integrationPeut-être pris @waldekmastykarz l’a pris il y a 4 jours. Ouvertework in progress
dotnet/dev-proxy#2034 · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
breaking change on hold
Difficulté 3/5 1-2 jours Accessibilité débutants 65/100
dotnet/dev-proxy#1928 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de dotnet/dev-proxy
Issues similaires
-
bug github_actions
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
endercodezz/BYDLO#336 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
sebastienros/jint#4449 ·
Les mainteneurs répondent en général sous 1 jour
-
clawsweeper:bulk-filed clawsweeper:needs-security-review clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:security issue-rating: 🦞 diamond lobster P2
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
openclaw/openclaw-windows-node#2010 · 2 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
imazen/imageflow-dotnet#72 · 1 commentaire ·