Skip to content

Commit 15e29d7

Browse files
committed
Updated marketplace information
1 parent aa1b8e9 commit 15e29d7

3 files changed

Lines changed: 42 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
## Description
44

5+
The API Reference plugin generates an OpenAPI (Swagger) specification from Matomo API definitions and supported plugin metadata.
6+
57
As APIs and plugins expose additional metadata, developers can browse available API endpoints, explore request parameters and response formats, and test API requests directly from the documentation interface.
68

79
### Features include:
810

911
* Interactive Swagger/OpenAPI-based API documentation
10-
* Searchable API methods and endpoints
1112
* Request and response schema documentation
1213
* Parameter descriptions and example requests
1314
* Improved navigation and API discoverability

docs/faq.md

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

plugin.json

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

0 commit comments

Comments
 (0)