docs: add descriptions for some endpoints

2023-07-27 18:17:36 +02:00 · 2023-07-27 18:17:36 +02:00 · c669e9212f
commit c669e9212f
parent b39716a199
2 changed files with 4 additions and 0 deletions
--- a/packages/backend/src/server/api/endpoints/notes/clips.ts
+++ b/packages/backend/src/server/api/endpoints/notes/clips.ts
@ -7,6 +7,8 @@ import { ApiError } from '@/server/api/error.js';
 export const meta = {
 	tags: ['clips', 'notes'],

+	description: 'Provides a list of all clips that a specific note is in.',
+
 	requireCredential: false,

 	res: {
--- a/packages/backend/src/server/api/endpoints/notes/conversation.ts
+++ b/packages/backend/src/server/api/endpoints/notes/conversation.ts
@ -7,6 +7,8 @@ import { getNote } from '@/server/api/common/getters.js';
 export const meta = {
 	tags: ['notes'],

+	description: 'Get the notes the specific note is a reply to, recursively.',
+
 	requireCredential: false,

 	res: {