Skip to content

Support use x-* in ref #1776

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

Merged
DerManoMann merged 1 commit into from
Jul 19, 2025
Merged

Support use x-* in ref #1776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 13 additions & 3 deletions src/Annotations/OpenApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,11 +219,21 @@ private static function resolveRef(string $ref, string $resolved, $container, ar
$unresolved = $slash === false ? $resolved . $subpath : $resolved . $subpath . '/';

if (is_object($container)) {
if (property_exists($container, $property) === false) {
// support use x-* in ref
$xKey = strpos($property, 'x-') === 0 ? substr($property, 2) : null;
if ($xKey) {
if (!is_array($container->x) || !array_key_exists($xKey, $container->x)) {
$xKey = null;
}
}
if (property_exists($container, $property) === false && !$xKey) {
throw new OpenApiException('$ref "' . $ref . '" not found');
}

$nextContainer = $xKey ? $container->x[$xKey] : $container->{$property};

if ($slash === false) {
return $container->{$property};
return $nextContainer;
}
$mapping = [];
foreach ($container::$_nested as $nestedClass => $nested) {
Expand All @@ -232,7 +242,7 @@ private static function resolveRef(string $ref, string $resolved, $container, ar
}
}

return self::resolveRef($ref, $unresolved, $container->{$property}, $mapping);
return self::resolveRef($ref, $unresolved, $nextContainer, $mapping);
} elseif (is_array($container)) {
if (array_key_exists($property, $container)) {
return self::resolveRef($ref, $unresolved, $container[$property], []);
Expand Down
29 changes: 26 additions & 3 deletions tests/RefTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,23 @@ public function testRef(): void
$this->assertInstanceOf(OA\Info::class, $info);

$comment = <<<END
@OA\Get(
@OA\Post(
path="/api/~/endpoint",
@OA\Response(response="default", description="A response")
@OA\Response(
response="default",
description="A response",
@OA\JsonContent(ref="#/components/schemas/String/x-custom-key")
)
)

@OA\Schema(
schema="String",
@OA\Property(property="value", type="string"),
x={
"custom-key": @OA\Schema(
@OA\Property(property="value", type="string"),
)
}
)
END;
$openapi->merge($this->annotationsFromDocBlockParser($comment));
Expand All @@ -32,8 +46,17 @@ public function testRef(): void
$analysis->validate();
// escape / as ~1
// escape ~ as ~0
$response = $openapi->ref('#/paths/~1api~1~0~1endpoint/get/responses/default');
$response = $openapi->ref('#/paths/~1api~1~0~1endpoint/post/responses/default');
$this->assertInstanceOf(OA\Response::class, $response);
$this->assertSame('A response', $response->description);

// ref x value
$schema = $openapi->ref('#/components/schemas/String/x-custom-key');
$this->assertInstanceOf(OA\Schema::class, $schema);

// ref x with deep
$property = $openapi->ref('#/components/schemas/String/x-custom-key/properties/value');
$this->assertInstanceOf(OA\Property::class, $property);
$this->assertSame('string', $property->type);
}
}