saveourtool/save-cloud

Document endpoints using OpenAPI annotations

Open

#955 geöffnet am 22. Juli 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Kotlin (4 Forks)github user discovery
backlogdocumentationenhancementgood first issueinfra

Repository-Metriken

Stars
 (38 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

In backend only small part of endpoints is documented with OpenAPI/Swagger annotations. We should fix this and convert existing KDocs into @Description (as mentioned in #820, we can suppress Diktat alerts on symbols annotated with certain Swagger annotations).

This is essential for better user experience when developing integrations with save-cloud REST API.

Contributor Guide

Research-Richtung
Identifizieren Sie nicht dokumentierte Endpunkte im Backend Kotlin Code und fügen Sie OpenAPI @Description Anmerkungen hinzu. Verwenden Sie vorhandene dokumentierte Endpunkte als Beispiele und folgen Sie den Richtlinien aus Issue #820.
Tech Stack
kotlin
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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
GitKotlin
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75