foojayio / foojayio/discoapi

Clarify API version lifecycle

Offen
#55 7 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
154
Forks
17
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I just noted that the swagger ui points to version 3.0. Is this already in production? The [README.MD](https://github.com/foojayio/discoapi/blob/main/README.md) refers to 2.0 only.

As a API consumer it would be very helpful to have an lifecycle statement which lists available versions with status and EOL date.

Thx for the great work!

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Vergleiche die in Swagger UI angezeigte Version mit der 2.0-Referenz in README.MD und untersuche anschließend die Repository-Dokumentation zu API-Versionen. Als abgeschlossen gilt die Aufgabe, wenn die Dokumentation jede verfügbare Version, ihren Status und ihr End-of-Life-Datum klar aufführt, einschließlich der Beziehung zwischen den Versionen 2.0 und 3.0.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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