Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates OpenAPI schema generation so enums serialized as strings (e.g., via JsonStringEnumConverter) get an explicit "type": "string" instead of leaving type unset, aligning generated specs with expected OpenAPI schema shape.
Changes:
- Set
type: "string"on enum schemas when anenumarray is present buttypeis missing. - Update the parameter schema test to assert
JsonSchemaType.Stringfor enum parameters using string enum conversion.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/OpenApi/src/Services/Schemas/OpenApiSchemaService.cs | Adds enum-specific schema fix-up during STJ schema export transform. |
| src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs | Updates enum-with-converter test assertion to expect type to be string. |
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.
Specify "type" for enums in OpenAPI
Description
When encountering an enum in schema, we set the type to "string" instead of leaving it as null.
Fixes #61303