api 명세 문서 내 path variable 설명 추가

[Hwangseoeun]

😉 연관 이슈

Resolves #244

🧑‍💻 수행 작업

• api 명세 문서 내 path variable 설명 추가

📢 참고 사항

X

Summary by CodeRabbit

• 문서화
  • API 문서에 일일 투두 ID 경로 매개변수에 대한 상세한 설명과 예제를 추가하여 개발자 경험을 개선했습니다.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

REST Docs 문서화를 위해 MemberActivityControllerV1DocsTest에서 두 개의 API 엔드포인트에 todoId 경로 파라미터 설정을 추가했습니다. 경로 파라미터 문서화에는 파라미터 설명, 제약 조건 및 예제 값이 포함됩니다.

Changes

Cohort / File(s)	요약
REST Docs 경로 파라미터 문서화 src/test/java/site/dogether/docs/memberactivity/v1/MemberActivityControllerV1DocsTest.java	getMyGroupCertificationsV1 엔드포인트에서 todoId 경로 파라미터 문서화 추가 (설명: "데일리 투두 id", 예제값: 1)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• 사용자의 인증 목록 전체 조회 API 구현 #245: 메인 PR의 pathParameter "todoId" 문서화 추가는 해당 PR의 /api/v1/my/activity/todos/{todoId}/group-certifications 엔드포인트 추가 및 문서화와 직접적으로 연관됨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Linked Issues check	❓ Inconclusive	PR 변경사항이 연결된 이슈 #244의 목표와 부분적으로 관련되어 있으나, 이슈의 주요 요구사항인 '페이징 없는 인증목록 API V1 신규 개발'을 완전히 충족하지 않습니다.	이슈 #244가 완료되었는지 또는 현재 PR이 해당 이슈의 일부 작업인지 명확히 해야 합니다.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	PR 제목은 변경사항의 주요 내용인 API 명세 문서 내 path variable 설명 추가를 명확하게 설명합니다.
Description check	✅ Passed	PR 설명은 템플릿 구조를 따르고 있으며, 연관 이슈, 수행 작업, 참고 사항 섹션이 모두 작성되어 있습니다.
Out of Scope Changes check	✅ Passed	변경사항이 API 명세 문서의 path variable 설명 추가로, 연결된 이슈 범위 내에 있습니다.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/test/java/site/dogether/docs/memberactivity/v1/MemberActivityControllerV1DocsTest.java (1)

446-449: todoId 경로 파라미터 문서화 추가는 적절합니다. 다만 예시 타입을 Long으로 맞추는 걸 권장합니다.

현재 pathVariableExample(1)이라 id 타입이 Long인 경우(대부분의 PK) 문서/스니펫 예시가 애매해질 수 있어 1L로 맞추는 편이 깔끔합니다. (요청 빌더의 {todoId} 값도 동일하게 맞추면 더 일관적)

제안 diff

-                pathParameters(
+                pathParameters(
                     parameterWithName("todoId")
                         .description("데일리 투두 id")
-                        .attributes(constraints("존재하는 데일리 투두 id만 입력 가능"), pathVariableExample(1))),
+                        .attributes(constraints("존재하는 데일리 투두 id만 입력 가능"), pathVariableExample(1L))),

📜 Review details

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad1ba02 and 64c7e60.

📒 Files selected for processing (1)

• src/test/java/site/dogether/docs/memberactivity/v1/MemberActivityControllerV1DocsTest.java