[#101] Docs: Pin 순서 변경 restdocs 추가

Nexters · Feb 24, 2024 · 2df1f5a · 2df1f5a
1 parent 734ddac
commit 2df1f5a
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc
@@ -34,6 +34,10 @@ include::{snippets}/user-controller-test/유저_조회/auto-section.adoc[]
 include::{snippets}/../../src/docs/custom-snippets/socket/pin/pin-save-request.adoc[]
 include::{snippets}/../../src/docs/custom-snippets/socket/pin/pin-save-response.adoc[]
 
+=== Update Pin Order
+include::{snippets}/../../src/docs/custom-snippets/socket/pin/pin-order-update-request.adoc[]
+include::{snippets}/../../src/docs/custom-snippets/socket/pin/pin-order-update-response.adoc[]
+
 === Update Pin Name
 
 include::{snippets}/../../src/docs/custom-snippets/socket/pin/pin-name-update-request.adoc[]

diff --git a/src/docs/custom-snippets/socket/pin/pin-order-update-request.adoc b/src/docs/custom-snippets/socket/pin/pin-order-update-request.adoc
@@ -0,0 +1,10 @@
+[source,http,options="nowrap"]
+----
+SEND /pub/{courseId}/pin/modification
+EX /pub/1/pin/modification
+Content-Type: application/json
+{
+    "pinId": "10b24e0e-7d7f-49ab-858d-14097f47ee8a",
+    "order": 0
+}
+----
diff --git a/src/docs/custom-snippets/socket/pin/pin-order-update-response.adoc b/src/docs/custom-snippets/socket/pin/pin-order-update-response.adoc
@@ -0,0 +1,14 @@
+[source,http,options="nowrap"]
+----
+SUBSCRIBE /sub/{courseId}/pin/modification
+EX /sub/1/pin/modification
+Content-Type: application/json
+{
+  "code" : 0,
+  "message" : "실행에 성공했습니다.",
+  "data" : {
+    "pinId" : "10b24e0e-7d7f-49ab-858d-14097f47ee8a",
+    "order" : 0
+  }
+}
+----