From 851c562bdd0be65e4ca53c1dd5a3d091808aa55f Mon Sep 17 00:00:00 2001 From: Ean Milligan Date: Wed, 8 Apr 2026 04:17:57 -0400 Subject: [PATCH] update api doc for hor to read plan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0af7a6b..4f44915 100644 --- a/README.md +++ b/README.md @@ -41,9 +41,9 @@ The API will be a combination API and basic SSR. - /api - SSR Page: shows login form - /api/[userId] - SSR Page: provides import plan button to upload an existing xivplan url to the db, shows all user's plans (have section for deleted plans), each plan should have the following buttons: [Open], [Share], [Rename*] [Delete*] Buttons with an \* will prompt for PIN to confirm. + - /api/read/[planId] - API Page: **GET** returns name and data as JSON object - /api/[userId]/list - API Page: **GET** returns non-deleted plans, specifically the name, id, and folder of each plan as a JSON array of objects - /api/[userId]/export - API Page: **GET** returns zip of .xivplan files - - /api/[userId]/read/[planId] - API Page: **GET** returns name and data as JSON object - /api/[userId]/create - API Page: **POST** to save new plan to DB, requires name, **PIN**, and data (optionally folder), api will generate a nanoid for the PK - /api/[userId]/update/[planId] - API Page: **PUT** to overwrite plan while keeping same name and id, requires **PIN** and data - /api/[userId]/undelete/[planId] - API Page: **PUT** to unmark plan as deleted, requires **PIN**