Skip to content

Commit cf1e332

Browse files
authored
Fix faq (#50)
* fix faq formatting * update version
1 parent 451f774 commit cf1e332

3 files changed

Lines changed: 17 additions & 14 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
## Changelog
2+
5.0.2 - 25/05/2026
3+
- Updated FAQ
4+
25
5.0.1 - 25/05/2026
36
- Added fix for endpoints that don't return valid API responses
47

docs/faq.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
## Why is the OpenAPI specification file not generated?
1+
## FAQ
2+
3+
__Why is the OpenAPI specification file not generated?__
24

35
This can happen if the API Reference plugin is disabled, the Matomo cache has not been cleared, or the API specification generation process encountered an error.
46

57
Try the following:
68

7-
- Ensure the API Reference plugin is installed and activated.
8-
- Clear the Matomo cache.
9-
- Check your server logs for PHP or permission errors.
10-
- Verify that the Matomo instance can write generated files to the configured directory.
11-
- Ensure all required plugins and dependencies are enabled.
9+
* Ensure the API Reference plugin is installed and activated.
10+
* Clear the Matomo cache.
11+
* Check your server logs for PHP or permission errors.
12+
* Verify that the Matomo instance can write generated files to the configured directory.
13+
* Ensure all required plugins and dependencies are enabled.
1214

1315
The specification files are generated daily using a scheduled Matomo task. To check when this task is scheduled to run next, use the TasksTimetable plugin.
1416

1517
You can manually generate the specification files using the following command:
1618

17-
18-
The initial generation process may take some time to complete, depending on the number of installed plugins.
19-
20-
2119
```bash
2220
core:run-scheduled-tasks "Piwik\Plugins\ApiReference\Tasks.generateConfiguredPluginSpecs"
2321
```
2422

25-
## Can I still see the legacy API reference page?
23+
The initial generation process may take some time to complete, depending on the number of installed plugins.
24+
25+
__Can I still see the legacy API reference page?__
2626

2727
Yes. The legacy API reference remains available for compatibility and migration purposes while transitioning to the new API documentation.
2828

29-
## Why do some request or response schemas appear incomplete?
29+
__Why do some request or response schemas appear incomplete?__
3030

3131
The API Reference plugin generates request and response examples using data available in your Matomo instance. As a result, some response examples may appear incomplete if there is limited or no matching data available for a specific API request.
3232

3333
Not all API methods include response examples. Response examples are primarily generated for API methods that retrieve data from Matomo.
3434

35-
## Does the API Reference plugin replace existing Matomo APIs?
35+
__Does the API Reference plugin replace existing Matomo APIs?__
3636

3737
No. The plugin modernises the API documentation experience while remaining compatible with existing Matomo APIs and integrations.
3838

plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ApiReference",
33
"description": "Modern interactive API documentation for Matomo based on OpenAPI (Swagger). Explore endpoints, parameters, and responses directly in your browser. ",
4-
"version": "5.0.1",
4+
"version": "5.0.2",
55
"theme": false,
66
"keywords": [
77
"API",

0 commit comments

Comments
 (0)