Skip to content

๐Ÿ“š Docs: Scalar API Reference ์„ค๋ช… ์ˆ˜์ •#150

Merged
WhiteBin-bin merged 1 commit into
DoDo-Project:developfrom
WhiteBin-bin:docs/149
Jun 4, 2026
Merged

๐Ÿ“š Docs: Scalar API Reference ์„ค๋ช… ์ˆ˜์ •#150
WhiteBin-bin merged 1 commit into
DoDo-Project:developfrom
WhiteBin-bin:docs/149

Conversation

@WhiteBin-bin
Copy link
Copy Markdown
Contributor

๐Ÿ“„ ์ž‘์—… ๋‚ด์šฉ (Description)

์ด๋ฒˆ PR์—์„œ ๋ณ€๊ฒฝ๋˜๊ฑฐ๋‚˜ ์ถ”๊ฐ€๋œ ์ฃผ์š” ์ž‘์—…์„ ๊ฐ„๋‹จํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”.

  • ๋ฐ˜๋ ค๋™๋ฌผ ๋ชฉ๋ก ๋ฐ ๊ฐ€์กฑ ์‹ ์ฒญ ๊ด€๋ จ ๋ชฉ๋ก API์˜ sort ๋ฌธ์„œ๋ฅผ ์‹ค์ œ ๊ตฌํ˜„ ๊ธฐ์ค€์œผ๋กœ ์ •๋ฆฌ
  • ์ž˜๋ชป๋œ ์ •๋ ฌ ์˜ˆ์‹œ๊ฐ’(regDate, createdDate, requestedAt ๋“ฑ) ์ œ๊ฑฐ
  • registrationCreatedAt, registrationUpdatedAt, registrationStatus ๊ธฐ์ค€์œผ๋กœ ์„ค๋ช… ํ†ต์ผ
  • ์‹ ์ฒญ์ˆœ, ์ฒ˜๋ฆฌ์ˆœ, ์ƒํƒœ์ˆœ์— ๋Œ€ํ•œ ์‚ฌ์šฉ์ž ๊ด€์  ์„ค๋ช… ๋ฐ˜์˜

๐Ÿ”— ๊ด€๋ จ ์ด์Šˆ (Related Issues)

์ž‘์—…ํ•œ ์ด์Šˆ ๋ฒˆํ˜ธ๋ฅผ ์•„๋ž˜ ํ˜•์‹์œผ๋กœ PULL REQUEST BODY์— ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.
(PR ๋จธ์ง€ ์‹œ ํ•ด๋‹น ์ด์Šˆ๊ฐ€ ์ž๋™์œผ๋กœ ์ข…๋ฃŒ๋ฉ๋‹ˆ๋‹ค.)


โœ… ์ฒดํฌ๋ฆฌ์ŠคํŠธ (Checklist)

PR์„ ๋ณด๋‚ด๊ธฐ ์ „ ์•„๋ž˜ ํ•ญ๋ชฉ๋“ค์„ ๋ชจ๋‘ ํ™•์ธํ•ด์ฃผ์„ธ์š”.

  • PR ์ œ๋ชฉ์€ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜์„ ๋”ฐ๋ž์Šต๋‹ˆ๋‹ค.
  • ๊ด€๋ จ ์ด์Šˆ๋ฅผ ์—ฐ๊ฒฐํ–ˆ์Šต๋‹ˆ๋‹ค.
  • ์Šค์Šค๋กœ ์ฝ”๋“œ๋ฅผ ๊ฒ€ํ† ํ•˜๊ณ  ๋ถˆํ•„์š”ํ•œ ์ฝ”๋“œ๋ฅผ ์ œ๊ฑฐํ–ˆ์Šต๋‹ˆ๋‹ค.
  • ์ฝ”๋“œ ์Šคํƒ€์ผ์ด ํ”„๋กœ์ ํŠธ ๊ทœ์น™๊ณผ ์ผ์น˜ํ•ฉ๋‹ˆ๋‹ค. (Style)
  • ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๋ฅผ ์ถ”๊ฐ€ํ–ˆ๊ฑฐ๋‚˜, ๊ธฐ์กด ํ…Œ์ŠคํŠธ๊ฐ€ ๋ชจ๋‘ ํ†ต๊ณผํ–ˆ์Šต๋‹ˆ๋‹ค. (Test)

๐Ÿ“ธ ์Šคํฌ๋ฆฐ์ƒท (Screenshots)

์ž‘์—… ๋‚ด์šฉ๊ณผ ๊ด€๋ จ๋œ ์Šคํฌ๋ฆฐ์ƒท์ด ์žˆ๋‹ค๋ฉด ์ฒจ๋ถ€ํ•ด์ฃผ์„ธ์š”. (UI ๋ณ€๊ฒฝ์ด ์žˆ๋Š” ๊ฒฝ์šฐ)

Before After

๐Ÿ’ฌ ๊ธฐํƒ€ ์‚ฌํ•ญ (Etc)

๋ฆฌ๋ทฐ์–ด์—๊ฒŒ ์ „๋‹ฌํ•˜๊ณ  ์‹ถ์€ ์ถ”๊ฐ€ ์ •๋ณด๊ฐ€ ์žˆ๋‹ค๋ฉด ์ž์œ ๋กญ๊ฒŒ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

sort๊ฐ€ ์–ด๋–ค ํ•„๋“œ ๊ธฐ์ค€์œผ๋กœ ๊ฐ€๋Šฅํ•œ์ง€ ์•ˆ ์ ์–ด๋†”์„œ ๊ธ‰ํ•˜๊ฒŒ ์ˆ˜์ •ํ•ด๋†จ์Šต๋‹ˆ๋‹ค.

@WhiteBin-bin WhiteBin-bin requested a review from limhb708 June 4, 2026 04:51
@WhiteBin-bin WhiteBin-bin self-assigned this Jun 4, 2026
@WhiteBin-bin WhiteBin-bin added ๐Ÿ“š Docs ํ”„๋กœ์ ํŠธ ๋ฌธ์„œ ์ˆ˜์ • ๋ฐ ์ถ”๊ฐ€ ๐Ÿฏ ๋ฐฑํ˜„๋นˆ ๋ฐฑํ˜„๋นˆ ํŒŒํŠธ labels Jun 4, 2026
@github-project-automation github-project-automation Bot moved this to ๐Ÿ“ ํ•  ์ผ in ์นธ๋ฐ˜ ๋ณด๋“œ Jun 4, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the API documentation in PetController.java to specify the correct sort parameters (registrationCreatedAt, registrationUpdatedAt, and registrationStatus). The reviewer recommended removing registrationStatus from the allowed sort fields for the getPetList, getAllPendingUsers, and getMyPendingApplications endpoints, as these lists are already filtered by a single status, making sorting by status redundant and potentially confusing for API consumers.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread src/main/java/com/dodo/backend/pet/controller/PetController.java Outdated
Comment thread src/main/java/com/dodo/backend/pet/controller/PetController.java Outdated
Comment thread src/main/java/com/dodo/backend/pet/controller/PetController.java Outdated
- ๋ฐ˜๋ ค๋™๋ฌผ ๋ชฉ๋ก ๋ฐ ๊ฐ€์กฑ ์‹ ์ฒญ ๊ด€๋ จ ๋ชฉ๋ก API์˜ sort ๋ฌธ์„œ๋ฅผ ์‹ค์ œ ๊ตฌํ˜„ ๊ธฐ์ค€์œผ๋กœ ์ •๋ฆฌ
- ์ž˜๋ชป๋œ ์ •๋ ฌ ์˜ˆ์‹œ๊ฐ’(`regDate`, `createdDate`, `requestedAt` ๋“ฑ) ์ œ๊ฑฐ
- `registrationCreatedAt`, `registrationUpdatedAt`, `registrationStatus` ๊ธฐ์ค€์œผ๋กœ ์„ค๋ช… ํ†ต์ผ
- ์‹ ์ฒญ์ˆœ, ์ฒ˜๋ฆฌ์ˆœ, ์ƒํƒœ์ˆœ์— ๋Œ€ํ•œ ์‚ฌ์šฉ์ž ๊ด€์  ์„ค๋ช… ๋ฐ˜์˜

Closes DoDo-Project#149
@WhiteBin-bin WhiteBin-bin merged commit 2f3d23f into DoDo-Project:develop Jun 4, 2026
1 check passed
@WhiteBin-bin WhiteBin-bin deleted the docs/149 branch June 4, 2026 04:59
@github-project-automation github-project-automation Bot moved this from ๐Ÿ“ ํ•  ์ผ to โ˜‘๏ธ ์™„๋ฃŒ in ์นธ๋ฐ˜ ๋ณด๋“œ Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

๐Ÿฏ ๋ฐฑํ˜„๋นˆ ๋ฐฑํ˜„๋นˆ ํŒŒํŠธ ๐Ÿ“š Docs ํ”„๋กœ์ ํŠธ ๋ฌธ์„œ ์ˆ˜์ • ๋ฐ ์ถ”๊ฐ€

Projects

Status: โ˜‘๏ธ ์™„๋ฃŒ

Development

Successfully merging this pull request may close these issues.

[Docs] Scalar API Reference ์‹ค์ œ ์ •๋ ฌ ํ•„๋“œ ๊ธฐ์ค€์œผ๋กœ ์ˆ˜์ •

1 participant