fix(openapi): throw clear error for openapi parameter missing name in yaml config#8297
Open
soyuka wants to merge 1 commit into
Open
fix(openapi): throw clear error for openapi parameter missing name in yaml config#8297soyuka wants to merge 1 commit into
soyuka wants to merge 1 commit into
Conversation
… yaml config YamlResourceExtractor accessed $parameter['name']/['in'] unguarded when building OpenAPI parameters from config, emitting an Undefined array key warning followed by a cryptic TypeError. It now throws an InvalidArgumentException naming the missing required key. name and in are required fields of an OpenAPI parameter object. Fixes api-platform#8013
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
1 participant
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.
Summary
When a YAML/XML-configured operation declares an
openapi.parametersentry without aname(orin),YamlResourceExtractor::buildOpenapi()accessed$parameter['name']/$parameter['in']unguarded. This emitted aWarning: Undefined array key "name"(the original symptom of #8013, surfaced viaapi:openapi:export) followed by a crypticTypeErrorfrom theParameterconstructor.nameandinare required fields of an OpenAPI parameter object. The extractor now throws a clearInvalidArgumentExceptionnaming the missing required key, instead of leaking a PHP warning and producing broken output.The original report used the removed 2.6
collectionOperations/openapi_contextsyntax (that array path is gone fromOpenApiFactory), but the modern config equivalent (openapi.parametersarrays) reaches the same unguarded code in the extractor.Reproduction
Declaring an operation
openapi.parametersentry with nonamekey crashed withUndefined array key "name"+TypeErrorrather than a helpful error.Test plan
testOpenApiParameterWithoutNameThrowsClearException(fails before fix, passes after).YamlExtractorTestpasses; php-cs-fixer + PHPStan clean.Fixes #8013