Developer
070cd4d5a5
Add generated .pi-map.md and .pi-map.index.md files across the repository so the project navigation maps are shared and versioned. These artifacts are maintained by project_map_init/patch/validate and must be kept in sync with source edits. Note: .cache/ remains ignored (added in previous commit).
28 lines
2.0 KiB
Markdown
28 lines
2.0 KiB
Markdown
# docs/api
|
|
dir: docs/api
|
|
|
|
index: docs/api/.pi-map.index.md
|
|
|
|
## role
|
|
Provides comprehensive API documentation for a FastAPI-based Headquarter REST API covering authentication, project management, repositories, SSH keys, terminal access, tool types, and user profiles.
|
|
## files
|
|
- README.md | API documentation for a FastAPI-based Headquarter REST API describing authentication, endpoints, and testing | dep: FastAPI, REST API, session cookie authentication, JSON
|
|
- auth.md | Documents OAuth2 authentication API endpoints for Authentik-based login flow with session management | dep: Authentik, OAuth2, session cookies
|
|
- config-profiles.md | Documents a configuration profile system with git repository mounting capabilities for tool instances, including API endpoints, validation rules, and profile resolution with merge/override semantics. | dep: git repositories, tool instances, container filesystem, SSH keys, glob pattern matching
|
|
- projects.md | Documents a REST API for project management with CRUD operations.
|
|
- repositories.md | Documents a REST API for managing Git repositories, files, branches, and commits within projects.
|
|
- ssh-keys.md | Documents a REST API for managing user SSH keys including listing, generating, and deleting key pairs
|
|
- terminal.md | Documents a WebSocket-based Terminal API for interactive terminal access to running tool instance containers with session persistence and heartbeat mechanisms. | dep: WebSocket, HTTP, JSON, UUID, session cookies, terminal/shell emulation
|
|
- tool-types.md | Documents REST API endpoints for managing Docker Compose-based tool types with template variable support
|
|
- users.md | Documents a REST API for user profile management, avatar uploads, and user-configurable settings.
|
|
## arch
|
|
Standard REST API documentation structure organized by domain/resource with OAuth2/Authentik authentication, WebSocket for real-time terminal sessions, and git-backed configuration profile system with merge/override semantics.
|
|
## tags
|
|
api, documents, rest, tool, terminal, endpoints, management, profile
|
|
## symbols
|
|
-
|
|
## workflows
|
|
-
|
|
## dirty
|
|
-
|