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

Repository metrics

Stars
 (21,513 stars)
PR merge metrics
 (Avg merge 8d 11h) (106 merged PRs in 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.

Contributor guide

Research direction
Explore Matomo's existing API endpoints and create an OpenAPI specification file (e.g., openapi.json) that describes the available endpoints, parameters, and responses. Look at how other PHP projects generate OpenAPI specs.
Tech stack
php
Domain
backend
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHPOpenAPI/SwaggerREST API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60