saveourtool/save-cloud

Document endpoints using OpenAPI annotations

Open

#955 aperta il 22 lug 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Kotlin (4 fork)github user discovery
backlogdocumentationenhancementgood first issueinfra

Metriche repository

Star
 (38 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica gli endpoint non documentati nel backend Kotlin e aggiungi annotazioni OpenAPI @Description. Usa gli endpoint già documentati come esempio e segui le linee guida dell'issue #820.
Tech stack
kotlin
Dominio
backendapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitKotlin
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75