matomo-org/matomo

Create a config file for Open API and/or Swagger

Open

#20,255 opened on Jan 23, 2023

View on GitHub
 (12 comments) (2 reactions) (0 assignees)PHP (21,513 stars) (2,847 forks)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

Description

Users who are testing their API with Postman or setting up security or other tasks sometimes ask for a definition file for our APIs.

Contributor guide

Tech stack
phprest api
Domain
backendapidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
OpenAPI specification knowledgeMatomo API familiarityPHP basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the existing Matomo API endpoints defined in the codebase (likely in /plugins/API). Look for any existing Swagger documentation or automate generation using tools like swagger php. Create an OpenAPI config file that describes the available API methods and their parameters. Consider linking with Postman import functionality. Check comments in the issue for any preferences on format (OpenAPI vs Swagger).