|
1 | | -## Why is the OpenAPI specification file not generated? |
| 1 | +## FAQ |
| 2 | + |
| 3 | +__Why is the OpenAPI specification file not generated?__ |
2 | 4 |
|
3 | 5 | 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. |
4 | 6 |
|
5 | 7 | Try the following: |
6 | 8 |
|
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. |
12 | 14 |
|
13 | 15 | 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. |
14 | 16 |
|
15 | 17 | You can manually generate the specification files using the following command: |
16 | 18 |
|
17 | | - |
18 | | -The initial generation process may take some time to complete, depending on the number of installed plugins. |
19 | | - |
20 | | - |
21 | 19 | ```bash |
22 | 20 | core:run-scheduled-tasks "Piwik\Plugins\ApiReference\Tasks.generateConfiguredPluginSpecs" |
23 | 21 | ``` |
24 | 22 |
|
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?__ |
26 | 26 |
|
27 | 27 | Yes. The legacy API reference remains available for compatibility and migration purposes while transitioning to the new API documentation. |
28 | 28 |
|
29 | | -## Why do some request or response schemas appear incomplete? |
| 29 | +__Why do some request or response schemas appear incomplete?__ |
30 | 30 |
|
31 | 31 | 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. |
32 | 32 |
|
33 | 33 | Not all API methods include response examples. Response examples are primarily generated for API methods that retrieve data from Matomo. |
34 | 34 |
|
35 | | -## Does the API Reference plugin replace existing Matomo APIs? |
| 35 | +__Does the API Reference plugin replace existing Matomo APIs?__ |
36 | 36 |
|
37 | 37 | No. The plugin modernises the API documentation experience while remaining compatible with existing Matomo APIs and integrations. |
38 | 38 |
|
|
0 commit comments