matomo-org / matomo-org/developer-documentation

Use OpenAPI standard for API documentation

Open
#787 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
58
Forks
88
Avg merge
6d 3h
Merged PRs (30d)
13

Description

Hi,

Is it possible for you to generate and maintain an [OpenAPI documentation](https://www.openapis.org/) ? (YAML or JSON single file)
I try to make a starter, but parameters objet type is complex and never documented in official documentation.

Here is the starter : https://app.swaggerhub.com/apis-docs/Openmost/Matomo/5.0.0

Regards,
Ronan HELLO

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Openmost/Matomo 5.0.0 starter on SwaggerHub and compare it with the repository’s existing developer documentation. Clarify the API surface and complex parameter schemas that must be represented. Done means a maintainable OpenAPI YAML or JSON document is generated and kept current.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.