summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/following
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-11-03 22:49:36 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-11-03 22:49:36 +0900
commita515c1f53ebcb8eba0c20b1f7951573d2ca7809e (patch)
treebc483f3f9a8033c74687472d8c8c82b359518103 /src/server/api/endpoints/following
parentRefactoring (diff)
downloadsharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.tar.gz
sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.tar.bz2
sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.zip
Improve API documentation
Diffstat (limited to 'src/server/api/endpoints/following')
-rw-r--r--src/server/api/endpoints/following/requests/accept.ts4
-rw-r--r--src/server/api/endpoints/following/requests/cancel.ts4
-rw-r--r--src/server/api/endpoints/following/requests/reject.ts4
-rw-r--r--src/server/api/endpoints/following/stalk.ts4
-rw-r--r--src/server/api/endpoints/following/unstalk.ts4
5 files changed, 20 insertions, 0 deletions
diff --git a/src/server/api/endpoints/following/requests/accept.ts b/src/server/api/endpoints/following/requests/accept.ts
index 36c3694eed..2cca3a1ccb 100644
--- a/src/server/api/endpoints/following/requests/accept.ts
+++ b/src/server/api/endpoints/following/requests/accept.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/requests/cancel.ts b/src/server/api/endpoints/following/requests/cancel.ts
index bfb7d0713c..f2dec9ffae 100644
--- a/src/server/api/endpoints/following/requests/cancel.ts
+++ b/src/server/api/endpoints/following/requests/cancel.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/requests/reject.ts b/src/server/api/endpoints/following/requests/reject.ts
index bd0b3bba22..cce41e2df4 100644
--- a/src/server/api/endpoints/following/requests/reject.ts
+++ b/src/server/api/endpoints/following/requests/reject.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/stalk.ts b/src/server/api/endpoints/following/stalk.ts
index 1fef9a429a..3a58e2192f 100644
--- a/src/server/api/endpoints/following/stalk.ts
+++ b/src/server/api/endpoints/following/stalk.ts
@@ -16,6 +16,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/unstalk.ts b/src/server/api/endpoints/following/unstalk.ts
index 66e99bed58..ad07ec38ba 100644
--- a/src/server/api/endpoints/following/unstalk.ts
+++ b/src/server/api/endpoints/following/unstalk.ts
@@ -16,6 +16,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};