Skip to content

OpenApiSpecGeneratorPlugin omits parameters and response headers from generated specs #2032

Open

Description

@waldekmastykarz

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions