From c669e9212f19ad9af2dc01e67b751974c1d79e55 Mon Sep 17 00:00:00 2001 From: Johann150 Date: Thu, 27 Jul 2023 18:17:36 +0200 Subject: [PATCH] docs: add descriptions for some endpoints --- packages/backend/src/server/api/endpoints/notes/clips.ts | 2 ++ packages/backend/src/server/api/endpoints/notes/conversation.ts | 2 ++ 2 files changed, 4 insertions(+) diff --git a/packages/backend/src/server/api/endpoints/notes/clips.ts b/packages/backend/src/server/api/endpoints/notes/clips.ts index 69b879feb..58ee6b07a 100644 --- 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: { diff --git a/packages/backend/src/server/api/endpoints/notes/conversation.ts b/packages/backend/src/server/api/endpoints/notes/conversation.ts index f1ef46a6d..863481052 100644 --- 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: {