LabConnect-RCOS / LabConnect-RCOS/LabConnect-Backend

Autogenerated documentation

Offen
#89 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
2
Forks
5
Ø Merge
9 Std. 17 Min.
Gemergte PRs (30 T.)
5

Beschreibung

Setup and use https://0b01001001.github.io/spectree/ for schemas and connect it to swagger UI to render the docs

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Prüfe zuerst die verlinkte spectree-Dokumentation und die Flask-API-Einstiegspunkte des Repositorys; das Issue nennt keine spezifischen Dateien oder vorhandenen Schema-Speicherorte. Erledigt ist die Aufgabe, wenn die API-Schemas mit Swagger UI verbunden sind und die generierte Dokumentation gerendert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
flask, python
Bereich
api, backend, documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.