Skip to content

IBX-9058: Complete REST API #161

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
merged 7 commits into from
Apr 17, 2025
Merged

IBX-9058: Complete REST API #161

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f7425e1
User*Controller: Fix typo
adriendupuis Mar 18, 2025
096383f
views_schemas.yml: Add LocationQuery
adriendupuis Mar 18, 2025
343c8b0
OpenApiFactory.php: Fix JSON examples
adriendupuis Mar 18, 2025
508c8c4
Merge branch 'main' into complete-rest-api-ref
adamwojs Mar 26, 2025
f06441c
OpenApiFactory: Fix PHPStan
adriendupuis Mar 27, 2025
6f52b7f
Update src/bundle/ApiPlatform/OpenApiFactory.php
adriendupuis Mar 31, 2025
969acba
Update src/bundle/ApiPlatform/OpenApiFactory.php
adriendupuis Mar 31, 2025
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
7 changes: 5 additions & 2 deletions src/bundle/ApiPlatform/OpenApiFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,11 @@ private function processOperationResponses(Operation $operation): Operation

$exampleFilePath = $this->kernel->locateResource($responseContent['x-ibexa-example-file']);
$exampleFileContent = file_get_contents($exampleFilePath);

$newContent[$mediaType]['example'] = $exampleFileContent;
if ('json' === array_slice(explode('.', pathinfo($exampleFilePath, PATHINFO_FILENAME)), -1, 1)[0]) {
$newContent[$mediaType]['example'] = json_decode($exampleFileContent ?: '', true);
} else {
$newContent[$mediaType]['example'] = $exampleFileContent;
}
unset($newContent[$mediaType]['x-ibexa-example-file']);
}

Expand Down
3 changes: 3 additions & 0 deletions src/bundle/Resources/api_platform/schemas/views_schemas.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ schemas:
performCount:
description: If true, search engine should perform count even if that means extra lookup.
type: boolean
LocationQuery:
description: This class is used to perform a Location query.
$ref: "#/components/schemas/Query"
Criterion:
description: Criterion implementations.
type: object
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Server/Controller/User/UserListController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
],
],
Response::HTTP_NOT_FOUND => [
'description' => 'If there are no visibile Users matching the filter.',
'description' => 'If there are no visible Users matching the filter.',
],
],
),
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Server/Controller/User/UserVerifyController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
'description' => 'OK - verifies if there are Users matching the given filter.',
],
Response::HTTP_NOT_FOUND => [
'description' => 'Error - there are no visibile Users matching the filter.',
'description' => 'Error - there are no visible Users matching the filter.',
],
],
),
Expand Down
Loading