saveourtool/save-cloud

Document endpoints using OpenAPI annotations

Open

#955 opened on Jul 22, 2022

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

Repository metrics

Stars
 (38 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Identify undocumented endpoints in the backend Kotlin codebase and add OpenAPI @Description annotations to them. Use existing documented endpoints as examples and follow the guidelines from issue #820.
Tech stack
kotlin
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitKotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75