Extends OpenAPISpecGeneratorPlugin to include default values for parameters#1323
Merged
waldekmastykarz merged 7 commits intoJul 14, 2025
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Extends the OpenAPI spec generator plugin to allow configuring which query parameters to include in the spec and automatically set their default values.
- Adds a new
includeParametersarray option to the plugin’s JSON schema. - Introduces
IncludeParametersin the plugin configuration class with a default empty collection. - Updates parameter processing logic to mark included parameters as required and assign their default values.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| schemas/v1.0.0/openapispecgeneratorplugin.schema.json | Introduces the includeParameters property to the JSON schema |
| DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs | Adds IncludeParameters config field and logic for defaults |
Comments suppressed due to low confidence (1)
DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs:346
- The new default-value logic (
SetParameterDefault) and inclusion behavior lack unit tests. Add tests to verify that parameters listed inIncludeParametersare marked required and have theirSchema.Defaultset correctly.
private static void SetParameterDefault(OpenApiParameter parameter, object? value)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
waldekmastykarz
previously approved these changes
Jul 14, 2025
waldekmastykarz
approved these changes
Jul 14, 2025
Collaborator
waldekmastykarz
left a comment
There was a problem hiding this comment.
Works like a charm. Nothing to add 👏
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#1110