lenra-io/docs

[Task] Add the Lenra app OpenAPI reference to the documentation website

Offen

#74 geöffnet am 23.01.2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)CSS (0 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (5 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

What should be done

Add the Lenra app OpenAPI reference to the documentation website

Create a new page with a link to the swagger editor (https://editor-next.swagger.io/) and the API URL from the latest release of the API project: https://github.com/lenra-io/api/releases

Is this task linked with any other ?

Blocked by https://github.com/lenra-io/api/issues/7

Contributor Guide

Research-Richtung
Ermitteln Sie die neueste Release URL von der Lenra API Releases Seite und erstellen Sie eine neue Dokumentationsseite, die auf den Swagger Editor mit dieser URL verweist.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80