alex/headquarter
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(project-map): regenerate .pi-map artifacts across the repo

Browse Source
This commit is contained in:
Developer
2026-06-17 11:31:24 +00:00
parent 0dd5f2317b
commit 93da9b42a2
683 changed files with 5075 additions and 4965 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/.pi-map.index.md
+1 -1
View File
@@ -2,7 +2,7 @@
dir: docs/api
## role
Provides comprehensive API documentation for the Headquarter platform's REST and WebSocket endpoints, covering authentication, project management, infrastructure tooling, and interactive terminal access.
Documents the REST API and WebSocket interfaces for the platform's core services including authentication, project management, tool instances, and interactive terminal access.
## parent
index: docs/.pi-map.index.md
map: docs/.pi-map.md
docs/api/.pi-map.md
+11 -11
View File
@@ -4,21 +4,21 @@ dir: docs/api
index: docs/api/.pi-map.index.md
## role
Provides comprehensive API documentation for the Headquarter platform's REST and WebSocket endpoints, covering authentication, project management, infrastructure tooling, and interactive terminal access.
Documents the REST API and WebSocket interfaces for the platform's core services including authentication, project management, tool instances, and interactive terminal access.
## 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
- README.md | Provides documentation for a RESTful API built with FastAPI, covering authentication, response formats, endpoint sections, and interactive testing. | dep: FastAPI
- 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.
- config-profiles.md | Documents an API for managing reusable configuration profiles with git repository mounting capabilities for tool instances | dep: git, filesystem, API endpoints, JSON
- projects.md | Documents a REST API for project management with CRUD operations
- repositories.md | Documents REST API endpoints for Git repository management and file operations within a project-based system.
- ssh-keys.md | Documents a REST API for SSH key management including listing, generating, and deleting user SSH keys
- terminal.md | Documents a WebSocket-based Terminal API for interactive terminal access to running tool instance containers with session persistence and heartbeat management. | dep: WebSocket, HTTP, JSON, UUID, terminal/shell, container runtime
- tool-types.md | Documents REST API endpoints for managing Docker Compose-based tool types with built-in vs custom differentiation
- users.md | Documents a REST API for user profile management, avatar uploads, and user configuration settings.
## arch
Documentation-as-code structure organized by domain entity with FastAPI-style endpoint documentation, following standard HTTP method conventions (GET/POST/PUT/DELETE) with WebSocket extensions for real-time features, and OAuth2/session-based authentication patterns.
FastAPI-based RESTful API with OAuth2/Authentik authentication, WebSocket support for real-time features, resource-oriented endpoint organization, and CRUD patterns across project-scoped resources with git integration and container-based tooling.
## tags
api, documents, rest, tool, terminal, endpoints, management, profile
api, documents, management, tool, rest, terminal, ssh, endpoints
## symbols
-
## workflows