Include dev API in docs
Aperta
Nessuno ha ancora preso questa issue.
cloud/server
- Lingua principale
- Vue
- Stelle
- 15
- Fork
- 22
- Merge medio
- 5g 11h
- PR unite (30g)
- 9
Descrizione
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
Guida per i contributori
Apri la guida per i contributori
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.
Direzione di ricerca
La issue identifica la REST API pubblica e una definizione Swagger, ma non indica file né punti di ingresso. Inizia individuando la specifica dell’API e i punti di integrazione del sito di documentazione; il lavoro è completato quando l’API pubblica è documentata in una forma facile da usare per gli integratori personalizzati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- openapi
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100