Use OpenAPI standard for API documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Inizia esaminando il Openmost/Matomo 5.0.0 starter su SwaggerHub e confrontalo con la documentazione esistente per gli sviluppatori del repository. Chiarisci la superficie dell’API e gli schemi dei parametri complessi che devono essere rappresentati. Il lavoro è completato quando viene generato un documento YAML o JSON OpenAPI manutenibile e mantenuto aggiornato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Hi,
Is it possible for you to generate and maintain an OpenAPI documentation ? (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
- Lingua principale
- PHP
- Stelle
- 58
- Fork
- 88
- Merge medio
- 32m
- PR unite (30g)
- 1
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di matomo-org/developer-documentation
-
Documentation enhancement
Difficoltà 1/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 55/100
matomo-org/developer-documentation#806 · 2 commenti ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 45/100
matomo-org/developer-documentation#784 · 1 commento ·
Tutte le issue di matomo-org/developer-documentation
Issue simili
-
PHP workflow streaming requests buffer the full SSE responseForse già presa @Winoren l’ha presa oggi. Apertareview: medium
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
langgenius/dify#44270 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
bug customer-reported
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
MagnaCapax/PMSS#1085 ·
I maintainer di solito rispondono entro 5 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
nunomaduro/collision#375 ·
-
enhancement good first issue hacktoberfest help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
thetheago/laravel-seeder-versioning#19 ·
I maintainer di solito rispondono entro 1 giorno