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