Developer
28 lines
1.9 KiB
Markdown
28 lines
1.9 KiB
Markdown
# docs/api
|
|
dir: docs/api
|
|
|
|
index: docs/api/.pi-map.index.md
|
|
|
|
## role
|
|
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 | 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 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
|
|
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, management, tool, rest, terminal, ssh, endpoints
|
|
## symbols
|
|
-
|
|
## workflows
|
|
-
|
|
## dirty
|
|
-
|