matomo-org / matomo-org/plugin-ApiReference
Complex array shapes are not working in SwaggerUI
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 0
- Forks
- 1
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 5
Description
Because matomo doesn't use a JSON body for requests, these endpoints do not have native support inside Swagger. Since they have required fields that are complex json arrays.
HeatmapSessionRecording.addHeatmap
HeatmapSessionRecording.updateHeatmap
AbTesting.addExperiment
AbTesting.updateExperiment
ScheduledReports.addReport
ScheduledReports.updateReport
Funnels.saveNonGoalFunnel
Funnels.testUrlMatchesSteps
PrivacyManager.deleteDataSubjects
PrivacyManager.exportDataSubjects
HeatmapSessionRecording.addHeatmap
HeatmapSessionRecording.updateHeatmap
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the listed HeatmapSessionRecording, AbTesting, ScheduledReports, Funnels, and PrivacyManager endpoints in SwaggerUI and trace how their request fields are generated. Done means the required complex array fields are represented and usable for each listed endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, php
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100