xivdev/XIVPlan-DB
1
0
Fork 0
Code Issues Wiki Activity

update api doc for hor to read plan

Browse Source
This commit is contained in:
Ean Milligan
2026-04-08 04:17:57 -04:00
parent 1eac7180c0
commit 851c562bdd
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -41,9 +41,9 @@ The API will be a combination API and basic SSR.
- /api - SSR Page: shows login form - /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/[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]/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]/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]/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]/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** - /api/[userId]/undelete/[planId] - API Page: **PUT** to unmark plan as deleted, requires **PIN**