fix(openapi): Prevent allowReserved and allowEmptyValue being returned on a path parameter #7220
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
robjenman
commented
Jun 16, 2025
robjenman
commented
| Q | A |
|---|---|
| Branch? | main |
| Tickets | Closes #7212 |
…d on a path parameter
soyuka
approved these changes
Jun 26, 2025
| @@ -17,7 +17,7 @@ final class Parameter | |||
| { | |||
| use ExtensionTrait; | |||
|
|
|||
| public function __construct(private string $name, private string $in, private string $description = '', private bool $required = false, private bool $deprecated = false, private ?bool $allowEmptyValue = null, private array $schema = [], private ?string $style = null, private bool $explode = false, private ?bool $allowReserved = null, private $example = null, private ?\ArrayObject $examples = null, private ?\ArrayObject $content = null) | |||
| public function __construct(private string $name, private string $in, private string $description = '', private bool $required = false, private bool $deprecated = false, private bool $allowEmptyValue = false, private array $schema = [], private ?string $style = null, private bool $explode = false, private bool $allowReserved = false, private $example = null, private ?\ArrayObject $examples = null, private ?\ArrayObject $content = null) | |||
There was a problem hiding this comment.
keep the default values to null so that they're not shown during serialization
| @@ -55,12 +55,12 @@ public function getDeprecated(): bool | |||
|
|
|||
| public function canAllowEmptyValue(): ?bool | |||
| { | |||
| return $this->allowEmptyValue; | |||
| return 'query' === $this->in ? $this->allowEmptyValue : null; | |||
There was a problem hiding this comment.
actually in the constructor if it's not a path parameter we set $this->allowEmptyValue don't change in the getters/setters
| } | ||
|
|
||
| public function getAllowEmptyValue(): ?bool | ||
| { | ||
| return $this->allowEmptyValue; | ||
| return 'query' === $this->in ? $this->allowEmptyValue : null; |
There was a problem hiding this comment.
can be removed if set in the cosntructor
| @@ -85,12 +85,12 @@ public function getExplode(): bool | |||
|
|
|||
| public function canAllowReserved(): ?bool | |||
| { | |||
| return $this->allowReserved; | |||
| return 'query' === $this->in ? $this->allowReserved : null; | |||
| @@ -151,7 +151,9 @@ public function withDeprecated(bool $deprecated): self | |||
| public function withAllowEmptyValue(bool $allowEmptyValue): self | |||
| { | |||
| $clone = clone $this; | |||
| $clone->allowEmptyValue = $allowEmptyValue; | |||
| if ('query' === $clone->in) { | |||
| $clone->allowEmptyValue = $allowEmptyValue; | |||
| @@ -183,7 +185,9 @@ public function withExplode(bool $explode): self | |||
| public function withAllowReserved(bool $allowReserved): self | |||
| { | |||
| $clone = clone $this; | |||
| $clone->allowReserved = $allowReserved; | |||
| if ('query' === $clone->in) { | |||
| $clone->allowReserved = $allowReserved; | |||
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.