Skip to content
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

Jump to bottom

feat: better path sorting for openapi UIs #6583

Merged
merged 6 commits into from
Sep 7, 2024
Merged

feat: better path sorting for openapi UIs #6583

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
06bb7a2
feat: better path sorting for openapi UIs
mrossard Sep 5, 2024
295bee4
fix: cs fixer
mrossard Sep 5, 2024
1cf1033
fix: move the paths sorting logic to the normalizer
mrossard Sep 5, 2024
9747b51
fix: cs fixer
mrossard Sep 5, 2024
f6a80ac
fix: refactoring for readability
mrossard Sep 5, 2024
dca8cff
fix: missing the tags for patch
mrossard Sep 6, 2024
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
30 changes: 29 additions & 1 deletion src/OpenApi/Model/Paths.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,33 @@ final class Paths
public function addPath(string $path, PathItem $pathItem): void
{
$this->paths[$path] = $pathItem;
}

private function comparePathsByKey($keyA, $keyB): int
{
$a = $this->paths[$keyA];
$b = $this->paths[$keyB];

ksort($this->paths);
$tagsA = [
...($a->getGet()?->getTags() ?? []),
...($a->getPost()?->getTags() ?? []),
...($a->getPut()?->getTags() ?? []),
...($a->getDelete()?->getTags() ?? []),
];
sort($tagsA);

$tagsB = [
...($b->getGet()?->getTags() ?? []),
...($b->getPost()?->getTags() ?? []),
...($b->getPut()?->getTags() ?? []),
...($b->getDelete()?->getTags() ?? []),
];
sort($tagsB);

return match (true) {
current($tagsA) === current($tagsB) => $keyA <=> $keyB,
default => current($tagsA) <=> current($tagsB),
};
}

public function getPath(string $path): ?PathItem
Expand All @@ -31,6 +56,9 @@ public function getPath(string $path): ?PathItem

public function getPaths(): array
{
// sort paths by tags, then by path for each tag
uksort($this->paths, $this->comparePathsByKey(...));

mrossard marked this conversation as resolved.
Show resolved Hide resolved
return $this->paths;
}
}
Loading