Developer
7ef8b0eb36
Regenerate .pi-map*.md artifacts for source changes in: - apps/api/src/api/tool/tool_types_validation.py - apps/api/src/schemas/tool/tool_type.py - apps/api/tests/integration/test_tool_types_api_extended.py - and all affected test files from backend-frontend refactoring cleanup
2.1 KiB
2.1 KiB
docs/api
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.
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
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.
tags
api, documents, rest, tool, terminal, endpoints, management, profile