fix: exempt x-domain-error-domain schemas from inline enum validation#73
Open
arlindaxhemailii wants to merge 1 commit into
Open
fix: exempt x-domain-error-domain schemas from inline enum validation#73arlindaxhemailii wants to merge 1 commit into
arlindaxhemailii wants to merge 1 commit into
Conversation
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.
Problem
Domain error response schemas generated by
@ApiDomainErrorResponseintentionally contain inline enum properties:These enums are used as a discriminator (
status) and as the domain error identity (code).The inline enum validator currently processes all response schemas, including domain error schemas marked with
x-domain-error-domain. As a result, these intentional inline enums producenot-allowed-inline-enumvalidation errors, causingopenapi-codegen check(and thereforecheck:ci) to fail.Fix
Skip inline enum extraction/validation for schemas marked with
x-domain-error-domain.This extension is emitted only by
@ApiDomainErrorResponse, making the guard precise and scoped to domain error schemas.Domain error code extraction remains unaffected, as it reads
code.enumdirectly from the raw schema object and does not depend on the enum extraction pipeline.Side Effects
StatusEnumSchemaandCodeEnumSchemaare no longer generated for domain error response schemas.Launch400ErrorResponseSchema.statusis generated asz.enum(["error"])instead of referencingStatusEnumSchema.Tests
x-domain-error-domainpresent) do not producenot-allowed-inline-enumvalidation errors.z.enum(["error"])and does not reference removed enum schemas.