Added endpoint to retrieve static single swagger file, #PG-4593#22
Merged
Conversation
AltamashShaikh
previously approved these changes
Mar 6, 2026
Contributor
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
Left 1 comment around format and permission rest looks good to me.
Contributor
Author
|
@AltamashShaikh Format should be fixed now, I checked developer doc examples and they used the anonymous user which has view access |
| * @return array<string, mixed> The decoded OpenAPI specification payload. | ||
| * @throws \Exception If the file is missing, unreadable, or contains invalid JSON. | ||
| */ | ||
| public function getMatomoOpenApiSpec(): array |
Contributor
There was a problem hiding this comment.
Suggested change
| public function getMatomoOpenApiSpec(): array | |
| public function getMatomoOpenApiSpec(string $format = 'json'): array |
| Piwik::checkUserHasSomeViewAccess(); | ||
|
|
||
| $request = Request::fromRequest(); | ||
| $format = strtolower($request->getStringParameter('format', 'json')); |
Contributor
There was a problem hiding this comment.
@lachiebol You can have format as a function parameter and Dependency injection, will ensure that it passes that parameter.
Contributor
Author
There was a problem hiding this comment.
Much cleaner, good to know :)
Contributor
Author
|
Just realised yours had default param which is probably better |
AltamashShaikh
previously approved these changes
Mar 6, 2026
Contributor
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
Left optional comments
AltamashShaikh
approved these changes
Mar 6, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Test with /index.php?module=API&method=OpenApiDocs.getMatomoOpenApiSpec&format=JSON
Issue No
Steps to Replicate the Issue
Checklist