matomo-org/matomo

Create a config file for Open API and/or Swagger

Open

#20.255 aberto em 23 de jan. de 2023

Ver no 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.

Guia do colaborador

Pilha de tecnologia
phprest api
Domain
backendapidocumentation
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
OpenAPI specification knowledgeMatomo API familiarityPHP basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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).