saveourtool/save-cloud

Document endpoints using OpenAPI annotations

Open

#955 opened on 2022年7月22日

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)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitKotlin
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75