OpenApiSpecGeneratorPlugin omits parameters and response headers from generated specs

Abierto
#2,032 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@waldekmastykarz ya está trabajando en esto.

Desde el 31/10/2026.

  • #2033 de @waldekmastykarz — abierto

Evaluación

Este issue todavía no se ha evaluado.

Descripción

bug work in progress
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
  1. Enable OpenApiSpecGeneratorPlugin and watch an API.
  2. Record requests that use query string parameters, custom request headers and parametrized paths (for example /users/123?$select=name), and whose responses include headers.
  3. 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.

Lenguaje dominante
C#
Estrellas
838
Forks
90
Merge medio
2 d 11 h
PR fusionados (30 d)
59

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dotnet/dev-proxy

Todos los issues de dotnet/dev-proxy

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.