saveourtool/save-cloud

Document endpoints using OpenAPI annotations

Open

#955 建立於 2022年7月22日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Kotlin (4 fork)github user discovery
backlogdocumentationenhancementgood first issueinfra

倉庫指標

Star
 (38 star)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南

研究方向
在後端 Kotlin 程式碼庫中識別未記錄的端點，並為其添加 OpenAPI @Description 註解。以已有記錄的端點為例，遵循 issue #820 的指南。
技術棧
kotlin
領域
backendapi
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitKotlin
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75