saveourtool/save-cloud

Document endpoints using OpenAPI annotations

Open

#955 aberto em 22 de jul. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (4 forks)github user discovery
backlogdocumentationenhancementgood first issueinfra

Métricas do repositório

Stars
 (38 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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.

Guia do colaborador

Direção de pesquisa
Identifique endpoints não documentados no backend Kotlin e adicione anotações OpenAPI @Description a eles. Use endpoints já documentados como exemplos e siga as diretrizes da issue #820.
Pilha de tecnologia
kotlin
Domain
backendapi
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitKotlin
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75