diff --git a/src/docs/asciidoc/chats.adoc b/src/docs/asciidoc/chats.adoc index 543e113..633e28b 100644 --- a/src/docs/asciidoc/chats.adoc +++ b/src/docs/asciidoc/chats.adoc @@ -121,3 +121,17 @@ include::{snippets}/get-chat-room-info-of-foreigner/query-parameters.adoc[] include::{snippets}/get-chat-room-info-of-foreigner/http-response.adoc[] include::{snippets}/get-chat-room-info-of-foreigner/response-fields.adoc[] + +== 채팅방 나가기(영구 삭제가 아닌 단순 나가기) + +채팅방에 나가는 API (영구 삭제가 아닌 단순 나가기) + +=== Request + +include::{snippets}/leave-chat-room/http-request.adoc[] +include::{snippets}/leave-chat-room/path-parameters.adoc[] + +=== Response (Success) + +include::{snippets}/leave-chat-room/http-response.adoc[] + diff --git a/src/main/resources/static/docs/chats.html b/src/main/resources/static/docs/chats.html index 2e3cae3..e8e05c3 100644 --- a/src/main/resources/static/docs/chats.html +++ b/src/main/resources/static/docs/chats.html @@ -754,11 +754,11 @@

Response (Success)

HTTP/1.1 201 Created
 Content-Type: application/json;charset=UTF-8
-Content-Length: 126
+Content-Length: 129
 
 {
   "textBySpeech" : "Hello my name is byeol",
-  "createdAt" : "2024-05-10T10:39:43.467337",
+  "createdAt" : "2024-05-11T23:09:46.612011500",
   "sttProvider" : "WHISPER"
 }
@@ -885,14 +885,13 @@

채팅방 password를 저장

Request

-
POST /chat-rooms/password HTTP/1.1
+
POST /chat-rooms/1/passwords HTTP/1.1
 Content-Type: application/json;charset=UTF-8
-Content-Length: 64
+Content-Length: 43
 Host: localhost:8080
 
 {
-  "chatRoomPassword" : "30303TWSA!!!",
-  "chatRoomId" : 1
+  "chatRoomPassword" : "30303TWSA!!!"
 }
@@ -918,7 +917,7 @@

채팅방 password 맞는지 체

Request

-
PUT /chat-rooms/1 HTTP/1.1
+
PATCH /chat-rooms/1/passwords HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 43
 Host: localhost:8080
@@ -929,7 +928,7 @@ 

Request

- +@@ -1237,11 +1236,62 @@

Response (Success)

+
+

채팅방 나가기(영구 삭제가 아닌 단순 나가기)

+
+
+

채팅방에 나가는 API (영구 삭제가 아닌 단순 나가기)

+
+
+

Request

+
+
+
PATCH /chat-rooms/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 38
+Host: localhost:8080
+
+{
+  "userId" : 1,
+  "isFC" : true
+}
+
+
+
Table 4. /chat-rooms/{chatRoomId}Table 4. /chat-rooms/{chatRoomId}/passwords
+ ++++ + + + + + + + + + + + + +
Table 6. /chat-rooms/{chatRoomId}
ParameterDescription

chatRoomId

채팅방 id

+ +
+

Response (Success)

+
+
+
HTTP/1.1 204 No Content
+
+
+
+ + diff --git a/src/main/resources/static/docs/index.html b/src/main/resources/static/docs/index.html index f1fd501..37cb837 100644 --- a/src/main/resources/static/docs/index.html +++ b/src/main/resources/static/docs/index.html @@ -503,48 +503,54 @@

HELLO-MERITZ API Document

  • Response (Success)
  • -
  • 외국인 회원 생성하기 +
  • 채팅방 나가기(영구 삭제가 아닌 단순 나가기)
  • -
  • 외국인 설문 내용 저장 +
  • 외국인 회원 생성하기
  • -
  • 설계사인지 외국인인지 확인 하는 API +
  • 외국인 설문 내용 저장
  • -
  • 설계사에게 외국인 채팅방에 입장했음을 알리는 API +
  • 설계사인지 외국인인지 확인 하는 API
  • -
  • 설계사의 정보를 조회하는 API +
  • 설계사에게 외국인 채팅방에 입장했음을 알리는 API
  • -
  • 외국인 정보를 조회하는 API +
  • 설계사의 정보를 조회하는 API
  • -
  • 상담원 매칭하는 API +
  • 외국인 정보를 조회하는 API
  • +
  • 상담원 매칭하는 API + +
  • @@ -863,11 +869,11 @@

    Respons
    HTTP/1.1 201 Created
     Content-Type: application/json;charset=UTF-8
    -Content-Length: 126
    +Content-Length: 129
     
     {
       "textBySpeech" : "Hello my name is byeol",
    -  "createdAt" : "2024-05-10T10:39:43.467337",
    +  "createdAt" : "2024-05-11T23:09:46.612011500",
       "sttProvider" : "WHISPER"
     }
    @@ -994,14 +1000,13 @@

    Request

    -
    POST /chat-rooms/password HTTP/1.1
    +
    POST /chat-rooms/1/passwords HTTP/1.1
     Content-Type: application/json;charset=UTF-8
    -Content-Length: 64
    +Content-Length: 43
     Host: localhost:8080
     
     {
    -  "chatRoomPassword" : "30303TWSA!!!",
    -  "chatRoomId" : 1
    +  "chatRoomPassword" : "30303TWSA!!!"
     }
    @@ -1027,7 +1032,7 @@

    Request

    -
    PUT /chat-rooms/1 HTTP/1.1
    +
    PATCH /chat-rooms/1/passwords HTTP/1.1
     Content-Type: application/json;charset=UTF-8
     Content-Length: 43
     Host: localhost:8080
    @@ -1038,7 +1043,7 @@ 

    Request

    - +@@ -1347,13 +1352,64 @@

    Respons
    +

    채팅방 나가기(영구 삭제가 아닌 단순 나가기)

    +
    +
    +

    채팅방에 나가는 API (영구 삭제가 아닌 단순 나가기)

    +
    +
    +

    Request

    +
    +
    +
    PATCH /chat-rooms/1 HTTP/1.1
    +Content-Type: application/json;charset=UTF-8
    +Content-Length: 38
    +Host: localhost:8080
    +
    +{
    +  "userId" : 1,
    +  "isFC" : true
    +}
    +
    +
    +

    Table 4. /chat-rooms/{chatRoomId}Table 4. /chat-rooms/{chatRoomId}/passwords
    + ++++ + + + + + + + + + + + + +
    Table 6. /chat-rooms/{chatRoomId}
    ParameterDescription

    chatRoomId

    채팅방 id

    + +
    +

    Response (Success)

    +
    +
    +
    HTTP/1.1 204 No Content
    +
    +
    +
    + + +

    외국인 회원 생성하기

    외국인 회원을 생성합니다.

    -

    Request

    +

    Request

    POST /users HTTP/1.1
    @@ -1363,7 +1419,7 @@ 

    Request

    -

    Response (Success)

    +

    Response (Success)

    HTTP/1.1 201 Created
    @@ -1406,7 +1462,7 @@ 

    -

    Request

    +

    Request

    POST /users HTTP/1.1
    @@ -1466,7 +1522,7 @@ 

    Request

    -

    Response (Success)

    +

    Response (Success)

    HTTP/1.1 200 OK
    @@ -1509,7 +1565,7 @@ 

    설계사인지 외국인인지 확인 하는 API

    -

    Request

    +

    Request

    GET /users/1 HTTP/1.1
    @@ -1518,7 +1574,7 @@ 

    Request

    - +@@ -1538,7 +1594,7 @@

    Request

    Table 6. /users/{userId}Table 7. /users/{userId}
    -

    Response (Success)

    +

    Response (Success)

    HTTP/1.1 200 OK
    @@ -1582,7 +1638,7 @@ 

    < 외국인 채팅을 보낼 수 있음으로 이에 대해서 설계사에게 알람을 보냅니다.

    -

    Request

    +

    Request

    GET /users/1/alarm?chatRoomId=1 HTTP/1.1
    @@ -1590,7 +1646,7 @@ 

    Request

    - +@@ -1610,7 +1666,7 @@

    Request

    Table 7. /users/{fcId}/alarmTable 8. /users/{fcId}/alarm
    -

    Response (Success)

    +

    Response (Success)

    HTTP/1.1 204 No Content
    @@ -1626,7 +1682,7 @@

    -

    Request

    +

    Request

    GET /users/1/fc-info HTTP/1.1
    @@ -1634,7 +1690,7 @@ 

    Request

    - +@@ -1654,7 +1710,7 @@

    Request

    Table 8. /users/{fcId}/fc-infoTable 9. /users/{fcId}/fc-info
    -

    Response (Success)

    +

    Response (Success)

    HTTP/1.1 200 OK
    @@ -1721,7 +1777,7 @@ 

    -

    Request

    +

    Request

    GET /users/1/foreigner-info HTTP/1.1
    @@ -1729,7 +1785,7 @@ 

    Request

    - +@@ -1749,7 +1805,7 @@

    Request

    Table 9. /users/{foreignerId}/foreigner-infoTable 10. /users/{foreignerId}/foreigner-info
    -

    Response (Success)

    +

    Response (Success)

    HTTP/1.1 200 OK
    @@ -1822,7 +1878,7 @@ 

    -

    Request

    +

    Request

    PATCH /consultants HTTP/1.1
    @@ -1832,7 +1888,7 @@ 

    Request