docs: describe /ap/ endpoints

2023-01-26 08:36:32 +01:00 · 2023-01-26 08:36:32 +01:00 · 05f8172ce9
commit 05f8172ce9
parent 151053897d
2 changed files with 4 additions and 0 deletions
--- 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,
--- 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,