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 (2.847 forks)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

Métricas do repositório

Stars
 (21.513 stars)
Métricas de merge de PR
 (Mesclagem média 8d 11h) (106 fundiu PRs em 30d)

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

Direção de pesquisa
Explore os endpoints de API existentes do Matomo e crie um arquivo de especificação OpenAPI (ex.: openapi.json) que descreva os endpoints, parâmetros e respostas disponíveis. Veja como outros projetos PHP geram especificações OpenAPI.
Pilha de tecnologia
php
Domain
backend
Tipo Issue
Funcionalidade
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PHPOpenAPI/SwaggerREST API
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60