Merge pull request #399 from team-yello/develop

Staging 배포

.gitignore

@@ -41,9 +41,12 @@ out/
 application.yml
 application-dev.yml
 application-apple.yml
+application-local.yml
 firebase*.json
 *client_secret*.json
 
 ### monitoring ###
 monitoring/prometheus/volume
 monitoring/grafana
+
+src/main/resources/application-local.yml

src/docs/asciidoc/check-user-v2.adoc

@@ -0,0 +1,41 @@
+== 내 정보 조회하기 V2
+
+=== 요청
+
+include::{snippets}/api/v2/user/http-request.adoc[]
+
+=== 응답
+
+include::{snippets}/api/v2/user/http-response.adoc[]
+
+*필드 타입*
+
+- "userId": Long
+- "name": String
+- "yelloId": String
+- "gender": "M" | "F"
+- "email": String
+- "profileImageUrl": String
+- "social": "KAKAO" | "APPLE"
+- "uuid": String(10)
+- "deviceToken": String
+- "group": String
+- "groupType": "UNIVERSITY" | "HIGH_SCHOOL" | "MIDDLE_SCHOOL" | "SOPT"
+- "groupName": String
+- "subGroupName": String
+- "groupAdmissionYear": Integer
+- "recommendCount": Long
+- "ticketCount": Integer
+- "point": Integer
+- "subscribe": "normal" | "active" | "canceled"
+
+=== Note
+
+- 내 정보 조회하기 V1가 제공했던 단편적인 정보를 보완하기 위해 설계된 API입니다.
+- `Authroization` 헤더로 제공된 JWT Token에 담긴 유저의 정보가 응답으로 주어집니다.
+- 유저 정보가 필요하면 해당 API를 사용하세요!
+
+=== CHANGELOG
+
+- 2024.01.07 첫 릴리즈
+- 2024.01.09 필드 타입 추가

src/docs/asciidoc/check-user.adoc

@@ -1,4 +1,4 @@
-== 내 정보 조회하기
+== 내 정보 조회하기 V1
 
 === 요청
 

src/docs/asciidoc/edit-user.adoc

@@ -0,0 +1,60 @@
+== 유저 프로필 수정 (명세)
+
+=== 요청
+
+[http,json]
+----
+POST /api/v1/user HTTP/1.1
+Authorization: Bearer your-access-token
+Content-Type: application/json
+
+{
+    "name": "name1",
+    "yelloId": "yelloId1",
+    "gender": "M",
+    "email": "[email protected]",
+    "profileImageUrl": "test image",
+    "groupId": 30000,
+    "groupAdmissionYear" : 20
+}
+----
+
+*필드 타입*
+
+- "name": String
+- "yelloId": String
+- "gender": "M" | "F"
+- "email": String
+- "profileImageUrl": String
+- "groupId": Long
+* 대학교 검색 또는 고등학교 검색 API를 이용하여 유저가 선택한 groupId를 입력해주세요.
+* 해당 groupId에 해당하는 group이 고등학교면, 해당 유저는 고등학생 / 대학교면 대학생이 됩니다.
+- "groupAdmissionYear": Integer
+* 대학생이면 학번 / 고등학생이면 '반(class)'를 넣어주세요.
+
+=== 응답
+
+[http,json]
+----
+HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "유저 프로필 조회에 성공하였습니다."
+}
+----
+
+*필드 타입*
+
+=== NOTE
+
+- 포인트 / 구독정보 / 로그인 정보와 같이 user-pure하지 않은 정보는 수정할 수 없도록 설계하였습니다.
+* 해당 정보 수정API는 도메인 별로 만들 예정입니다.
+
+=== CHANGELOG
+
+- 2024.01.09 명세 작성

src/docs/asciidoc/find-friend-votes.adoc

@@ -1,4 +1,4 @@
-== 친구 투표 전체 조회
+== 친구 투표 전체 조회 (업데이트)
 
 === 요청
 
@@ -8,6 +8,43 @@ include::{snippets}/api/v1/vote/findAllFriendVotes/http-request.adoc[]
 
 include::{snippets}/api/v1/vote/findAllFriendVotes/request-parameters.adoc[]
 
+*업데이트 예정*
+- "type": "send" | null
+
+|===
+|`+type+`|조회할 쪽지 종류
+|===
+
 === 응답
 
 include::{snippets}/api/v1/vote/findAllFriendVotes/http-response.adoc[]
+
+*필드 타입*
+
+- "totalCount": Integer
+- "friendVotes": *FriendVote*[]
+- *FriendVote*
+* "id": Long
+* "receiverName": String
+* "senderGender": "MALE" | "FEMALE"
+* "receiverProfileImage": String
+* "vote": *Vote*
+* "isHintUsed": Boolean
+* "createdAt": "{0}초 전" | "{0}분 전" | "{0}시간 전" | "{0}일 전"
+- *Vote*
+* "nameHead": String
+* "nameFoot": String
+* "keywordHead": String
+* "keyword": String
+* "keywordFoot": String
+
+=== NOTE
+
+- 모든 종류의 쪽지를 조회할 때 `/api/v1/vote/friend?page=0` 으로 요청해주세요
+* `type=` 을 명시하지 마세요
+- 내가 보낸 쪽지를 조회할 때 `/api/v1/vote/friend?page=0&type=send` 으로 요청해주세요
+- `senderGender` 필드가 다른 API와 일관되지 못한점 미안해요
+
+=== CHANGELOG
+
+- 2024.01.09 `type` 명세 업데이트

src/docs/asciidoc/find-notice.adoc

@@ -0,0 +1,55 @@
+== 공지 조회 (명세)
+
+=== 요청
+
+[http]
+----
+GET /api/v1/notice HTTP/1.1
+Authorization: Bearer your-access-token
+----
+
+=== 응답
+
+[http,json]
+----
+HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+Content-Type: application/json
+
+{
+    "status": 200,
+    "message": "공지 조회에 성공하였습니다.",
+    "data": {
+		"imageUrl" : "url here",
+		"redirectUrl": "redirect url here",
+		"startDate": "2021.01.12",
+		"endDate": "2021.01.17",
+		"isAvailable": true
+	}
+}
+----
+
+*필드 타입*
+
+- "imageUrl": String
+* 공지로 보여줄 이미지 URL입니다.
+- "redirectUrl: String
+* 클릭시 이동할 웹 URL입니다.
+- "startDate": String(10)
+* YYYY-MM-DD (ISO-8601)
+- "endDate": String(10)
+* YYYY-MM-DD (ISO-8601)
+- "isAvailable": Boolean
+
+=== NOTE
+
+- 공지 정보를 조회하는 API입니다.
+- 유효한 1개의 공지를 반환합니다.
+* 요구사항에 따라 여러개의 공지를 반환할 수 있도록 염두하고 있습니다.
+* 반환되는 공지를 무조건 View에 띄워주시면 되겠습니다.
+
+=== CHANGELOG
+
+- 2024.01.09 명세 작성

src/docs/asciidoc/index.adoc

@@ -17,15 +17,27 @@
 
 * link:find-onboarding-friends.html[가입한 친구 목록 불러오기]
 
-* link:search-userGroup.html[대학교 검색하기]
+* link:search-school.html[대학교 검색하기]
 
 * link:search-department.html[대학교 학과 검색하기]
 
+* link:search-high-name.html[고등학교 이름 검색하기]
+
+* link:search-high-class.html[고등학교 이름으로 학반 검색하기]
+
 * link:reissue-token.html[토큰 재발급]
 
 === User API
 
-* link:check-user.html[내 정보 조회하기]
+* link:check-user.html[내 정보 조회하기 V1]
+
+* 🆕 link:check-user-v2.html[내 정보 조회하기 V2, 2024-01-07]
+
+* 🆕 link:edit-user.html[유저 정보 수정 (명세), 2024-01-09]
+
+* 🆕 link:user-data-get.html[프로필 수정 가능 여부 조회 (명세), 2024-01-09]
+
+* 🆕 link:user-data-post.html[탈퇴 사유 저장 (명세), 2024-01-09]
 
 * link:check-user-by-id.html[특정 유저 정보 조회하기]
 
@@ -37,9 +49,9 @@
 
 * link:find-votes.html[내 투표 전체 조회하기]
 
-* link:find-friend-votes.html[친구 투표 전체 조회하기]
+* ⬆️ link:find-friend-votes.html[친구 투표 전체 조회하기, 2024-01-09]
 
-* link:find-friend-votes.html[읽지 않은 쪽지 개수 조회하기]
+* link:get-unread-vote.html[읽지 않은 쪽지 개수 조회하기]
 
 * link:find-vote.html[투표 상세 조회하기]
 
@@ -71,6 +83,8 @@
 
 === Purchase API
 
+* 🆕 link:purchase-info.html[유저 구독 정보 (명세), 2024-01-09]
+
 * link:apple.html[Apple 결제 관련 API]
 
 * link:google.html[Google 결제 관련 API]
@@ -81,4 +95,9 @@
 
 === Pay API
 
+- @Deprecated at 2024.03
 * link:pay.html[결제 전환율 체크]
+
+=== Notice API
+
+* 🆕 link:find-notice.html[공지 조회 (명세), 2024-01-09]

src/docs/asciidoc/purchase-info.adoc

@@ -0,0 +1,43 @@
+== 유저 구독 정보 (명세)
+
+=== 요청
+
+[http]
+----
+GET /api/v1/purchase/subscribe HTTP/1.1
+Authorization: Bearer your-access-token
+----
+
+=== 응답
+
+[http,json]
+----
+HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "구독 정보 조회에 성공하였습니다.",
+  "data" : {
+    "id": 5,
+    "subscribe": "active",
+    "expiredDate": "2023-02-12"
+  }
+}
+----
+
+*필드 타입*
+
+- "id": Long
+- "subscribe": "normal" | "active" | "canceled"
+- "expireDate": String(10)
+* YYYY-MM-DD (ISO-8601)
+
+=== Note
+
+=== CHANGELOG
+
+- 2024.01.09 명세 작성

src/docs/asciidoc/search-department.adoc

@@ -2,12 +2,12 @@
 
 === 요청
 
-include::{snippets}/api/v1/auth/findDepartmentsByKeyword/http-request.adoc[]
+include::{snippets}/api/v1/auth/findAllUnivDepartmentName/http-request.adoc[]
 
 === 요청 파라미터
 
-include::{snippets}/api/v1/auth/findDepartmentsByKeyword/request-parameters.adoc[]
+include::{snippets}/api/v1/auth/findAllUnivDepartmentName/request-parameters.adoc[]
 
 === 응답
 
-include::{snippets}/api/v1/auth/findDepartmentsByKeyword/http-response.adoc[]
+include::{snippets}/api/v1/auth/findAllUnivDepartmentName/http-response.adoc[]

src/docs/asciidoc/search-high-class.adoc

@@ -0,0 +1,13 @@
+== 고등학교 이름으로 학반 검색하기
+
+=== 요청
+
+include::{snippets}/api/v1/auth/findGroupIdByName/http-request.adoc[]
+
+=== 요청 파라미터
+
+include::{snippets}/api/v1/auth/findGroupIdByName/request-parameters.adoc[]
+
+=== 응답
+
+include::{snippets}/api/v1/auth/findGroupIdByName/http-response.adoc[]

src/docs/asciidoc/search-high-name.adoc

@@ -0,0 +1,13 @@
+== 고등학교 이름 검색하기
+
+=== 요청
+
+include::{snippets}/api/v1/auth/findAllHighSchoolName/http-request.adoc[]
+
+=== 요청 파라미터
+
+include::{snippets}/api/v1/auth/findAllHighSchoolName/request-parameters.adoc[]
+
+=== 응답
+
+include::{snippets}/api/v1/auth/findAllHighSchoolName/http-response.adoc[]

src/docs/asciidoc/search-school.adoc

@@ -2,12 +2,12 @@
 
 === 요청
 
-include::{snippets}/api/v1/auth/findSchoolsByKeyword/http-request.adoc[]
+include::{snippets}/api/v1/auth/findAllUnivName/http-request.adoc[]
 
 === 요청 파라미터
 
-include::{snippets}/api/v1/auth/findSchoolsByKeyword/request-parameters.adoc[]
+include::{snippets}/api/v1/auth/findAllUnivName/request-parameters.adoc[]
 
 === 응답
 
-include::{snippets}/api/v1/auth/findSchoolsByKeyword/http-response.adoc[]
+include::{snippets}/api/v1/auth/findAllUnivName/http-response.adoc[]