thePR0M3TH3AN/seedPass
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/SeedPass.git synced 2025-09-08 07:18:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #624 from PR0M3TH3AN/codex/add-note-to-api-reference-and-reformat

Browse Source 
Update API docs with GUI adapter note
This commit is contained in:
thePR0M3TH3AN
2025-07-17 22:21:28 -04:00
committed by GitHub
parent 6512b2f501 df0279ac03
commit 9976e5473f
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/docs/content/01-getting-started/02-api_reference.md
View File

@@ -2,6 +2,9 @@
This guide covers how to start the SeedPass API, authenticate requests, and interact with the available endpoints. This guide covers how to start the SeedPass API, authenticate requests, and interact with the available endpoints.
**Note:** All UI layers, including the CLI, BeeWare GUI, and future adapters, consume this REST API through service classes in `seedpass.core`. See [docs/gui_adapter.md](docs/gui_adapter.md) for more details on the GUI integration.
## Starting the API ## Starting the API
Run `seedpass api start` from your terminal. The command prints a one‑time token used for authentication: Run `seedpass api start` from your terminal. The command prints a one‑time token used for authentication: