diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-11-03 22:49:36 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-11-03 22:49:36 +0900 |
| commit | a515c1f53ebcb8eba0c20b1f7951573d2ca7809e (patch) | |
| tree | bc483f3f9a8033c74687472d8c8c82b359518103 /src/server/api/endpoints/notes | |
| parent | Refactoring (diff) | |
| download | sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.tar.gz sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.tar.bz2 sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.zip | |
Improve API documentation
Diffstat (limited to 'src/server/api/endpoints/notes')
| -rw-r--r-- | src/server/api/endpoints/notes/conversation.ts | 4 | ||||
| -rw-r--r-- | src/server/api/endpoints/notes/polls/vote.ts | 4 | ||||
| -rw-r--r-- | src/server/api/endpoints/notes/reactions/delete.ts | 4 | ||||
| -rw-r--r-- | src/server/api/endpoints/notes/renotes.ts | 4 | ||||
| -rw-r--r-- | src/server/api/endpoints/notes/replies.ts | 4 |
5 files changed, 20 insertions, 0 deletions
diff --git a/src/server/api/endpoints/notes/conversation.ts b/src/server/api/endpoints/notes/conversation.ts index 7703ef7d2e..5e6e5ddb0f 100644 --- a/src/server/api/endpoints/notes/conversation.ts +++ b/src/server/api/endpoints/notes/conversation.ts @@ -14,6 +14,10 @@ export const meta = { noteId: { validator: $.type(ID), transform: transform, + desc: { + 'ja-JP': '対象の投稿のID', + 'en-US': 'Target note ID' + } }, limit: { diff --git a/src/server/api/endpoints/notes/polls/vote.ts b/src/server/api/endpoints/notes/polls/vote.ts index f50e84ba13..dc012152c6 100644 --- a/src/server/api/endpoints/notes/polls/vote.ts +++ b/src/server/api/endpoints/notes/polls/vote.ts @@ -21,6 +21,10 @@ export const meta = { noteId: { validator: $.type(ID), transform: transform, + desc: { + 'ja-JP': '対象の投稿のID', + 'en-US': 'Target note ID' + } }, choice: { diff --git a/src/server/api/endpoints/notes/reactions/delete.ts b/src/server/api/endpoints/notes/reactions/delete.ts index 60f49fb275..53e2f476b2 100644 --- a/src/server/api/endpoints/notes/reactions/delete.ts +++ b/src/server/api/endpoints/notes/reactions/delete.ts @@ -17,6 +17,10 @@ export const meta = { noteId: { validator: $.type(ID), transform: transform, + desc: { + 'ja-JP': '対象の投稿のID', + 'en-US': 'Target note ID' + } }, } }; diff --git a/src/server/api/endpoints/notes/renotes.ts b/src/server/api/endpoints/notes/renotes.ts index 85d5820e58..2a434dd06e 100644 --- a/src/server/api/endpoints/notes/renotes.ts +++ b/src/server/api/endpoints/notes/renotes.ts @@ -14,6 +14,10 @@ export const meta = { noteId: { validator: $.type(ID), transform: transform, + desc: { + 'ja-JP': '対象の投稿のID', + 'en-US': 'Target note ID' + } }, limit: { diff --git a/src/server/api/endpoints/notes/replies.ts b/src/server/api/endpoints/notes/replies.ts index 8b5a3593d1..6046b9b310 100644 --- a/src/server/api/endpoints/notes/replies.ts +++ b/src/server/api/endpoints/notes/replies.ts @@ -14,6 +14,10 @@ export const meta = { noteId: { validator: $.type(ID), transform: transform, + desc: { + 'ja-JP': '対象の投稿のID', + 'en-US': 'Target note ID' + } }, limit: { |