From 05f8172ce99a4c80c87946d77c0de584e1f98fb4 Mon Sep 17 00:00:00 2001
From: Johann150 <johann.galle@protonmail.com>
Date: Thu, 26 Jan 2023 08:36:32 +0100
Subject: [PATCH] docs: describe /ap/ endpoints

---
 packages/backend/src/server/api/endpoints/ap/get.ts  | 2 ++
 packages/backend/src/server/api/endpoints/ap/show.ts | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/packages/backend/src/server/api/endpoints/ap/get.ts b/packages/backend/src/server/api/endpoints/ap/get.ts
index 3a051086a..676b6141d 100644
--- a/packages/backend/src/server/api/endpoints/ap/get.ts
+++ b/packages/backend/src/server/api/endpoints/ap/get.ts
@@ -7,6 +7,8 @@ export const meta = {
 
 	requireCredential: true,
 
+	description: 'Tries to fetch the given `uri` from the remote server.',
+
 	limit: {
 		duration: HOUR,
 		max: 30,
diff --git a/packages/backend/src/server/api/endpoints/ap/show.ts b/packages/backend/src/server/api/endpoints/ap/show.ts
index 414f71d31..4bf8f0091 100644
--- a/packages/backend/src/server/api/endpoints/ap/show.ts
+++ b/packages/backend/src/server/api/endpoints/ap/show.ts
@@ -18,6 +18,8 @@ export const meta = {
 
 	requireCredential: true,
 
+	description: 'Shows the requested object. If necessary, fetches the object from the remote server.',
+
 	limit: {
 		duration: HOUR,
 		max: 30,