Skip to content

Constants as openapi const union type #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
apasquini95 wants to merge 9 commits into from
Closed

Constants as openapi const union type #1095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c99810f
Added const schema type to literals also when in union with other types
apasquini95 Feb 16, 2026
facfd60
Fixed failing tests
apasquini95 Feb 16, 2026
1f54de0
Fix styling
apasquini95 Feb 16, 2026
7127247
Changed literals union type null handling
apasquini95 Feb 17, 2026
de7a8d6
Fix styling
apasquini95 Feb 17, 2026
2d55bc1
Fixed failing tests
apasquini95 Feb 17, 2026
62169ab
Merge branch 'constants-as-openapi-const-union-type' of github.com:ap…
apasquini95 Feb 17, 2026
f97d04b
Fix styling
apasquini95 Feb 17, 2026
75a1830
Fixed failing tests
apasquini95 Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions src/Support/Generator/TypeTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,21 +203,29 @@ public function transform(Type $type): OpenApiType
$items = array_map($this->transform(...), $otherTypes->values()->toArray()); // @phpstan-ignore argument.type
$literalSchemas = [];

if ($stringLiterals->count()) {
$items[] = $literalSchemas[] = (new StringType)->enum(
$stringLiterals->map->value->unique()->values()->toArray() // @phpstan-ignore property.notFound
);
if ($stringLiteralsCount = $stringLiterals->count()) {
if ($stringLiteralsCount > 1) {
$items[] = $literalSchemas[] = (new StringType)->enum(
$stringLiterals->map->value->unique()->values()->toArray() // @phpstan-ignore property.notFound
);
} else {
$items[] = (new StringType)->const($stringLiterals->first()->value);
}
}

if ($integerLiterals->count()) {
$items[] = $literalSchemas[] = (new IntegerType)->enum(
$integerLiterals->map->value->unique()->values()->toArray() // @phpstan-ignore property.notFound
);
if ($integerLiteralsCount = $integerLiterals->count()) {
if ($integerLiteralsCount > 1) {
$items[] = $literalSchemas[] = (new IntegerType)->enum(
$integerLiterals->map->value->unique()->values()->toArray() // @phpstan-ignore property.notFound
);
} else {
$items[] = (new IntegerType)->const($integerLiterals->first()->value);
}
}

// In case $otherTypes consist just of null and there is string or integer literals, make type nullable
$otherTypesIsNullable = count($otherTypes) === 1 && collect($otherTypes)->contains(fn ($t) => $t instanceof \Dedoc\Scramble\Support\Type\NullType);
if ($otherTypesIsNullable && ($stringLiterals->count() || $integerLiterals->count())) {
if ($otherTypesIsNullable && count($literalSchemas)) {
$items = array_map(fn ($s) => $s->nullable(true), $literalSchemas);
}

Expand Down
8 changes: 4 additions & 4 deletions tests/InferExtensions/JsonResourceExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ function JsonResourceExtensionTest_analyze(Infer $infer, OpenApiContext $context
'anyOf' => [
[
'type' => 'string',
'enum' => ['foo'],
'const' => 'foo',
],
[
'type' => 'integer',
'enum' => [42],
'const' => 42,
],
],
],
Expand Down Expand Up @@ -103,8 +103,8 @@ public function toArray(Request $request)
'properties' => [
'property' => [
'anyOf' => [
['type' => 'string', 'enum' => ['foo']],
['type' => 'integer', 'enum' => [123]],
['type' => 'string', 'const' => 'foo'],
['type' => 'integer', 'const' => 123],
],
],
],
Expand Down
10 changes: 2 additions & 8 deletions tests/ValidationRulesDocumentingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,10 +475,7 @@ function validationRulesToDocumentationWithDeep($rulesToParameters)

expect($params[0]->toArray()['schema'])->toBe([
'type' => 'string',
'enum' => [
'draft',
'archived',
],
'enum' => ['draft', 'archived'],
]);
});

Expand All @@ -491,10 +488,7 @@ function validationRulesToDocumentationWithDeep($rulesToParameters)

expect($params[0]->toArray()['schema'])->toBe([
'type' => 'string',
'enum' => [
'published',
'archived',
],
'enum' => ['published', 'archived'],
]);
});
}
Expand Down