matomo-org/matomo

Create a config file for Open API and/or Swagger

Open

#20 255 ouverte le 23 janv. 2023

Voir sur GitHub
 (12 commentaires) (2 réactions) (0 assignés)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.

Guide contributeur

Stack technique
phprest api
Domaine
backendapidocumentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
OpenAPI specification knowledgeMatomo API familiarityPHP basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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).