Swagger

v5.3.2

Request parameters are read with Piwik\Request instead of the deprecated Common::getRequestVar, ready for the next Matomo versions.

v5.3.1

Requires Matomo 5.0.0 or higher again (>=5.0.0,<6.0.0-b1), instead of 5.10.0: nothing in the plugin needs Matomo 5.10.
"Try it out" now works when Matomo is installed in a subdirectory: the server URL keeps the installation path, and the Swagger UI assets no longer use root-absolute paths.
Security: Swagger.getOpenApi is restricted to super users again, as in v6. The Swagger page loads the document with the session of the logged in user.
The OpenAPI document contact points to openmost.com and ronan@openmost.com.
Smaller package: only the Swagger UI files that the explorer loads are shipped (bundle, standalone preset and stylesheet), without the unused alternate bundles, demo page and source maps.
README: the plugin description now shows in the Description tab of the Matomo Marketplace.

v5.3.0

Richer OpenAPI document

Tags now carry the module description from each plugin's API class and an externalDocs link to the plugin homepage when available.
Parameter schemas use real PHP types (int → integer, bool → boolean, float → number, array → array) instead of treating every input as a string. Nullable parameters are flagged with nullable: true.
Per-method request body examples are generated from Matomo's own DocumentationGenerator::getExampleUrl(), so "Try it out" comes prefilled with sensible values.
Well-known Matomo parameters get domain-aware schemas: period is an enum (day/week/month/year/range), idSite/idSites get a regex matching integer / comma-separated list / "all", date and segment get human-readable descriptions of their accepted shapes, and language gets a locale pattern.
The 200 response now lists every format Matomo can return (json, xml, csv, tsv, html, rss, original) instead of only application/json, with a description noting that the concrete content type is selected via the format parameter.
info.contact and info.license populated from the plugin manifest.
Internal parameters (names starting with _) are now hidden, matching Matomo's reference doc generator.
Required parameter detection fixed (the previous check always evaluated to false because of an is_object() on a class-name string).

v5.2.5

fix: scope CSP frame-src 'self' and img-src validator.swagger.io to the Swagger pages only. The previous global decoration applied them to every Matomo page and broke the Overlay feature, which iframes cross-origin tracked sites.

v5.2.3

fix: Authorization modal position in iframe view

v5.2.2

update: Swagger admin page title

v5.2.1

fix: CSP issue

v5.2.0

Major Release: Full OpenAPI 3.1.0 Compliance & Dynamic API Discovery

New Features: - Dynamic version detection from Matomo installation - Dynamic protocol detection (HTTP/HTTPS) based on server configuration - Bearer token authentication (replaces deprecated token_auth query parameter) - POST method support for all API endpoints (required for POST-only token restrictions) - Mandatory module and format parameters for all API calls - Clean tag generation without descriptions for better UI experience

Improvements: - 100% dynamic module discovery from installed and activated plugins - Enhanced OpenAPI 3.1.0 specification compliance - Proper parameter definitions with required flags and default values - Support for both application/x-www-form-urlencoded and application/json content types - Method names visible in endpoint paths for better comprehensibility - Lazy plugin registration to avoid container initialization errors - Performance optimization: metadata loaded once instead of per-method

Bug Fixes: - Fixed NoDefaultValue object handling preventing fatal conversion errors - Fixed type checking before get_class() calls - Filtered out translation key placeholders from descriptions - Filtered out literal "string" placeholder values - Set empty string defaults for optional parameters

Breaking Changes: - API calls now use POST method instead of GET - Authentication now uses Bearer token in Authorization header - Tags no longer include plugin descriptions (names only)

Technical Details: - All enhancements maintain backward compatibility with existing API endpoints - No database migrations required - Comprehensive error handling with graceful fallbacks

v5.1.4

update: marketplace cover

v5.1.3

update: marketplace category and cover

v5.1.2

update: Swagger logo

v5.1.1

Publish the plugin

v5.1.0

setup: Plugin base

History

View Plugin Page