Include dev API in docs
Offen
Dieses Issue hat noch niemand übernommen.
cloud/server
- Vorherrschende Sprache
- Vue
- Sterne
- 15
- Forks
- 22
- Ø Merge
- 5 T. 11 Std.
- Gemergte PRs (30 T.)
- 9
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Das Issue identifiziert die öffentliche REST API und eine Swagger-Definition, nennt aber keine Dateien oder Einstiegspunkte. Beginne damit, die API-Spezifikation und die Integrationspunkte der Dokumentationsseite zu finden; als erledigt gilt die Aufgabe, wenn die öffentliche API in einer Form dokumentiert ist, die von benutzerdefinierten Integratoren leicht verwendet werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100