Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ 반려동물 수정/삭제 API 및 사용자 설정 이름 반환 API #121

Merged
merged 5 commits into from
Mar 2, 2024

Conversation

psychology50
Copy link
Member

@psychology50 psychology50 commented Mar 2, 2024

작업 이유

  • 반려동물 수정/삭제 기능 구현
  • 사용자가 설정한 기존 이름 반환

작업 사항

1️⃣ 기존 반려동물 API url 변경 (/users/{user_id} 제거)

  • 반려동물 등록: /api/v2/users/{user_id}/pets/api/v2/pets
  • 반려동물 요약 정보: /api/v2/users/{user_id}/pets/summary/api/v2/pets/summary
  • 관리 중인 반려동물 정보: /api/v2/users/{user_id}/pets/api/v2/pets

2️⃣ 반려동물 요약 정보 리스트 조회 시, imageUrl null 반환 변경

  • 제가 여기서 반려동물 프로필 이미지가 없으면 null을 반환하고 있더라구요. 수정해뒀습니다.

3️⃣ 사용자 설정 이름 반환

  • 요청: GET /api/v2/accounts/{user_id}/name
    • 요청자는 로그인된 유저여야 합니다.
    • user_id: 조회하려는 user의 pk
    • 1번 유저가 3번 유저 정보를 조회하고 싶으면 user_id는 3이 됩니다.
  • 응답
    {
        "status": "success",
        "data": {
            "name": "사용자 설정 이름(별명X)"
        }
    }

4️⃣ 반려동물 정보 조회 (수정 뷰 전용)

  • 요청: GET /api/v2/pets/{pet_id}
    • 요청자는 반려동물의 마스터 권한을 가지고 있어야 합니다.
  • 응답
    {
        "status": "success",
        "data": {
            "pet": {
                "id": 9,
                "petName": "",
                "petProfileImage": "",
                "gender": "MALE", # MALE or FEMALE
                "neutered": false,
                "birthdate": "yyyy-MM-dd",
                "species": "",
                "feed": ""
            }
        }
    }

🟡 예시 응답


5️⃣ 반려동물 정보 수정

  • 요청: PUT /api/v2/pets/{pet_id}

    • 요청자는 반려동물의 마스터 권한을 가지고 있어야 합니다.
    • feedprofileImg은 없으면 null을 허용합니다. (없으면 필드를 아예 제외하거나 null 송신. 빈 문자열 보내지 말 것)
    • 그 외 모든 필드는 null 및 빈 문자열을 허용하지 않습니다.
    • 입력 문자열 제한은 회의록에 나온 그대로입니다. (but, 아직 적용이 덜 되어 있습니다..)
    {
        "petName": "반려동물 이름",
        "species": "반려동물 종",
        "gender": "성별(MALE/FEMALE)",
        "neutralization": true, # true or false
        "birthdate": "yyyy-MM-dd",
        "profileImg": null, # 혹은 아예 필드 생략. 있으면 url
        "feed": "사료"
    }
  • 반려동물 생성과 완전 동일한 요청 포맷이라 어렵지 않으실 거예요.

🟡 예시 응답


6️⃣ 반려동물 삭제

  • 요청: DELETE /api/v2/pets/{pet_id}
    • 반려동물과 관련된 모든 정보를 제거합니다. (케어, 일정, 기록, 매니저)
    • 반려동물 프로필 사진과 기록에 등록했던 모든 사진도 Object Storage에서 제거합니다.
    • 반려동물과 관련하여 push notification을 받은 정보들은 제거하지 않습니다. (알림 로그 유지)

⚠️ 수정될 부분

알고는 있어야 하나, api 스펙이 변경된다고 해서 따로 대응할 작업은 없을 겁니다.

  • 관리자 초대 데이터 관리 방법이 바뀌어야 하는 관계로 아직은 초대 정보가 삭제되지 않습니다.

이슈 연결

close #105

@psychology50 psychology50 added the enhancement New feature or request label Mar 2, 2024
Copy link
Contributor

@heejinnn heejinnn left a comment

Choose a reason for hiding this comment

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

요청한거 다 해주셨군요~ 감사합니다

@heejinnn heejinnn merged commit 41475f9 into develop Mar 2, 2024
3 checks passed
@heejinnn heejinnn deleted the feat/39 branch March 2, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ 반려동물 수정/삭제
2 participants