chore: track all project map and index files
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).
This commit is contained in:
Developer
@@ -0,0 +1,36 @@
|
||||
# apps/api/src/schemas (index)
|
||||
dir: apps/api/src/schemas
|
||||
|
||||
## role
|
||||
Defines Pydantic schemas for data validation, serialization, and API request/response models in the FastAPI application.
|
||||
## parent
|
||||
index: apps/api/src/.pi-map.index.md
|
||||
map: apps/api/src/.pi-map.md
|
||||
## children
|
||||
- apps/api/src/schemas/config
|
||||
index: apps/api/src/schemas/config/.pi-map.index.md
|
||||
map: apps/api/src/schemas/config/.pi-map.md
|
||||
- apps/api/src/schemas/project
|
||||
index: apps/api/src/schemas/project/.pi-map.index.md
|
||||
map: apps/api/src/schemas/project/.pi-map.md
|
||||
- apps/api/src/schemas/system
|
||||
index: apps/api/src/schemas/system/.pi-map.index.md
|
||||
map: apps/api/src/schemas/system/.pi-map.md
|
||||
- apps/api/src/schemas/tool
|
||||
index: apps/api/src/schemas/tool/.pi-map.index.md
|
||||
map: apps/api/src/schemas/tool/.pi-map.md
|
||||
- apps/api/src/schemas/user
|
||||
index: apps/api/src/schemas/user/.pi-map.index.md
|
||||
map: apps/api/src/schemas/user/.pi-map.md
|
||||
## files
|
||||
- __init__.py
|
||||
## links
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
map: apps/api/src/schemas/.pi-map.md
|
||||
## workflows
|
||||
- change schemas behavior
|
||||
read: __init__.py
|
||||
- explore schemas subdirectories
|
||||
index: apps/api/src/schemas/config/.pi-map.index.md, apps/api/src/schemas/project/.pi-map.index.md, apps/api/src/schemas/system/.pi-map.index.md
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# apps/api/src/schemas
|
||||
dir: apps/api/src/schemas
|
||||
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines Pydantic schemas for data validation, serialization, and API request/response models in the FastAPI application.
|
||||
## files
|
||||
- __init__.py | Empty file with no functionality
|
||||
## arch
|
||||
Modular schema organization following FastAPI/Pydantic patterns, with empty __init__.py indicating package initialization for future schema modules.
|
||||
## tags
|
||||
init, empty, functionality
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
- change schemas behavior
|
||||
read: __init__.py
|
||||
- explore schemas subdirectories
|
||||
index: apps/api/src/schemas/config/.pi-map.index.md, apps/api/src/schemas/project/.pi-map.index.md, apps/api/src/schemas/system/.pi-map.index.md
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,23 @@
|
||||
# apps/api/src/schemas/config (index)
|
||||
dir: apps/api/src/schemas/config
|
||||
|
||||
## role
|
||||
Provides Pydantic validation schemas for configuration profile API endpoints, ensuring data integrity for mounts, git URLs, UUIDs, and file paths.
|
||||
## parent
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
map: apps/api/src/schemas/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- config_profile.py
|
||||
## links
|
||||
index: apps/api/src/schemas/config/.pi-map.index.md
|
||||
map: apps/api/src/schemas/config/.pi-map.md
|
||||
## workflows
|
||||
- change config behavior
|
||||
read: __init__.py, config_profile.py
|
||||
- change config config
|
||||
read: config_profile.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,30 @@
|
||||
# apps/api/src/schemas/config
|
||||
dir: apps/api/src/schemas/config
|
||||
|
||||
index: apps/api/src/schemas/config/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides Pydantic validation schemas for configuration profile API endpoints, ensuring data integrity for mounts, git URLs, UUIDs, and file paths.
|
||||
## files
|
||||
- __init__.py | Re-exports Pydantic schemas for configuration profile operations from a submodule to provide a clean public API. | dep: src.schemas.config.config_profile
|
||||
- config_profile.py | Defines Pydantic request/response schemas for config profile API operations with validation for mounts, git URLs, UUIDs, and file paths. | exp: class:GitMountMapping, class:GitMountItem, class:MountItem, class:ConfigProfileCreate, class:ConfigProfileUpdate, class:ConfigProfileIncludeUpdate, class:ConfigProfileResponse, class:DefaultProfilesUpdate, class:ValidateGitUrlRequest, class:ValidateGitUrlResponse, func:_validate_uuid(v: str | None) → str | None, call:uuid.UUID, raise:ValueError | dep: uuid, pydantic, src.api.shared_validators
|
||||
## arch
|
||||
Simple schema-as-code pattern using Pydantic models with field validators; clean public API via explicit re-exports in `__init__.py`.
|
||||
## tags
|
||||
profile, config, git, mount, update, validate, response, item
|
||||
## symbols
|
||||
- GitMountMapping
|
||||
- GitMountItem
|
||||
- MountItem
|
||||
- ConfigProfileCreate
|
||||
- ConfigProfileUpdate
|
||||
- ConfigProfileIncludeUpdate
|
||||
- ConfigProfileResponse
|
||||
- DefaultProfilesUpdate
|
||||
## workflows
|
||||
- change config behavior
|
||||
read: __init__.py, config_profile.py
|
||||
- change config config
|
||||
read: config_profile.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,23 @@
|
||||
# apps/api/src/schemas/project (index)
|
||||
dir: apps/api/src/schemas/project
|
||||
|
||||
## role
|
||||
Provides Pydantic data validation schemas for project-related API endpoints including projects, Git repositories, and SSH keys.
|
||||
## parent
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
map: apps/api/src/schemas/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- git_repository.py
|
||||
- project.py
|
||||
- ssh_key.py
|
||||
## links
|
||||
index: apps/api/src/schemas/project/.pi-map.index.md
|
||||
map: apps/api/src/schemas/project/.pi-map.md
|
||||
## workflows
|
||||
- change project behavior
|
||||
read: __init__.py, git_repository.py, project.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,30 @@
|
||||
# apps/api/src/schemas/project
|
||||
dir: apps/api/src/schemas/project
|
||||
|
||||
index: apps/api/src/schemas/project/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides Pydantic data validation schemas for project-related API endpoints including projects, Git repositories, and SSH keys.
|
||||
## files
|
||||
- __init__.py | Re-exports Pydantic schema classes from submodules to provide a unified public API for the project schemas module | dep: src.schemas.project.git_repository, src.schemas.project.project, src.schemas.project.ssh_key
|
||||
- git_repository.py | Defines Pydantic request/response schemas for Git repository operations in an API. | exp: class:GitRepositoryCreate, class:URLParseRequest, class:URLParseResponse, class:GitRepositoryResponse, class:UpdateSSHKeyRequest, class:FileListResponse, class:FileContentResponse, class:BranchesResponse, class:FileUpdateRequest, class:FileUpdateResponse, class:StatusResponse, class:BranchCreateRequest, class:CheckoutRequest, class:CommitRequest, class:CommitResponse, class:FetchResponse, class:PullResponse, class:PushResponse, class:MergeRequest, class:MergeResponse | dep: uuid, datetime, pydantic
|
||||
- project.py | Defines Pydantic request/response schemas for project-related API operations. | exp: class:ProjectCreate, class:ProjectUpdate, class:ProjectResponse, class:SetDefaultSSHKeyRequest | dep: uuid, pydantic
|
||||
- ssh_key.py | Defines Pydantic schemas for SSH key creation, response, signing, and signature verification in an API. | exp: class:SSHKeyCreate, class:SSHKeyResponse, class:SignPayloadRequest, class:SignatureResponse, class:VerifySignatureRequest, class:VerifySignatureResponse | dep: uuid, datetime, pydantic
|
||||
## arch
|
||||
Modular schema-per-domain pattern with clean separation of concerns, using Pydantic models for request/response validation and an `__init__.py` facade for unified public API access.
|
||||
## tags
|
||||
response, request, project, create, update, sshkey, pydantic, schemas
|
||||
## symbols
|
||||
- GitRepositoryCreate
|
||||
- URLParseRequest
|
||||
- URLParseResponse
|
||||
- GitRepositoryResponse
|
||||
- UpdateSSHKeyRequest
|
||||
- FileListResponse
|
||||
- FileContentResponse
|
||||
- BranchesResponse
|
||||
## workflows
|
||||
- change project behavior
|
||||
read: __init__.py, git_repository.py, project.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,21 @@
|
||||
# apps/api/src/schemas/system (index)
|
||||
dir: apps/api/src/schemas/system
|
||||
|
||||
## role
|
||||
Provides Pydantic schemas for system health monitoring endpoints in the API.
|
||||
## parent
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
map: apps/api/src/schemas/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- health.py
|
||||
## links
|
||||
index: apps/api/src/schemas/system/.pi-map.index.md
|
||||
map: apps/api/src/schemas/system/.pi-map.md
|
||||
## workflows
|
||||
- change system behavior
|
||||
read: __init__.py, health.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,25 @@
|
||||
# apps/api/src/schemas/system
|
||||
dir: apps/api/src/schemas/system
|
||||
|
||||
index: apps/api/src/schemas/system/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides Pydantic schemas for system health monitoring endpoints in the API.
|
||||
## files
|
||||
- __init__.py | Re-exports health check schema classes from a submodule to provide a unified interface for the system schemas module. | dep: src.schemas.system.health
|
||||
- health.py | Defines Pydantic data models for health check API responses including database, disk, and overall system health status. | exp: class:DatabaseHealth, class:DiskHealth, class:HealthChecks, class:HealthResponse, class:DatabaseHealthResponse | dep: pydantic
|
||||
## arch
|
||||
Simple submodule pattern with explicit re-exports in __init__.py, using Pydantic models for structured API response validation.
|
||||
## tags
|
||||
health, database, response, system, disk, check, schemas, init
|
||||
## symbols
|
||||
- DatabaseHealth
|
||||
- DiskHealth
|
||||
- HealthChecks
|
||||
- HealthResponse
|
||||
- DatabaseHealthResponse
|
||||
## workflows
|
||||
- change system behavior
|
||||
read: __init__.py, health.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# apps/api/src/schemas/tool (index)
|
||||
dir: apps/api/src/schemas/tool
|
||||
|
||||
## role
|
||||
Provides Pydantic data validation schemas for tool-related API operations including tool types and instances.
|
||||
## parent
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
map: apps/api/src/schemas/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- tool_instance.py
|
||||
- tool_type.py
|
||||
## links
|
||||
index: apps/api/src/schemas/tool/.pi-map.index.md
|
||||
map: apps/api/src/schemas/tool/.pi-map.md
|
||||
## workflows
|
||||
- change tool behavior
|
||||
read: __init__.py, tool_instance.py, tool_type.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,27 @@
|
||||
# apps/api/src/schemas/tool
|
||||
dir: apps/api/src/schemas/tool
|
||||
|
||||
index: apps/api/src/schemas/tool/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides Pydantic data validation schemas for tool-related API operations including tool types and instances.
|
||||
## files
|
||||
- __init__.py | Re-exports tool-related schema classes from submodules to provide a unified import interface for the tool schemas module. | dep: src.schemas.tool.tool_instance, src.schemas.tool.tool_type
|
||||
- tool_instance.py | Defines Pydantic request/response schemas for tool instance lifecycle operations (create and start). | exp: class:CreateInstanceRequest, class:StartInstanceRequest | dep: pydantic
|
||||
- tool_type.py | Defines Pydantic request/response schemas for creating, updating, and validating tool types with Docker compose/dockerfile/manifest definitions | exp: class:ToolTypeCreate, class:ToolTypeUpdate, class:ToolTypeResponse, class:ToolTypeValidateRequest | dep: uuid, datetime, pydantic, src.api.tool.tool_types_validation
|
||||
## arch
|
||||
Modular schema organization with submodule-per-entity pattern and unified re-export interface via `__init__.py`, following standard Python package structure for clean API imports.
|
||||
## tags
|
||||
tool, type, request, instance, schemas, create, pydantic, response
|
||||
## symbols
|
||||
- CreateInstanceRequest
|
||||
- StartInstanceRequest
|
||||
- ToolTypeCreate
|
||||
- ToolTypeUpdate
|
||||
- ToolTypeResponse
|
||||
- ToolTypeValidateRequest
|
||||
## workflows
|
||||
- change tool behavior
|
||||
read: __init__.py, tool_instance.py, tool_type.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,24 @@
|
||||
# apps/api/src/schemas/user (index)
|
||||
dir: apps/api/src/schemas/user
|
||||
|
||||
## role
|
||||
Provides centralized Pydantic data validation schemas for user-related API requests and responses.
|
||||
## parent
|
||||
index: apps/api/src/schemas/.pi-map.index.md
|
||||
map: apps/api/src/schemas/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- user.py
|
||||
- user_config.py
|
||||
## links
|
||||
index: apps/api/src/schemas/user/.pi-map.index.md
|
||||
map: apps/api/src/schemas/user/.pi-map.md
|
||||
## workflows
|
||||
- change user behavior
|
||||
read: __init__.py, user.py, user_config.py
|
||||
- change user config
|
||||
read: user_config.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,27 @@
|
||||
# apps/api/src/schemas/user
|
||||
dir: apps/api/src/schemas/user
|
||||
|
||||
index: apps/api/src/schemas/user/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides centralized Pydantic data validation schemas for user-related API requests and responses.
|
||||
## files
|
||||
- __init__.py | Re-exports user-related Pydantic schemas from submodules to provide a unified public API for the user schemas package. | dep: src.schemas.user.user, src.schemas.user.user_config
|
||||
- user.py | Defines Pydantic response and update schemas for user profile data | exp: class:UserProfileResponse, class:UserProfileUpdate | dep: uuid, pydantic
|
||||
- user_config.py | Defines Pydantic models for user configuration data transfer objects (response and update schemas). | exp: class:UserConfigResponse, class:UserConfigUpdate | dep: pydantic
|
||||
## arch
|
||||
Modular package pattern with submodule separation of concerns (user profile vs. user config) and unified public API via `__init__.py` re-exports.
|
||||
## tags
|
||||
user, schemas, response, update, config, pydantic, profile, src
|
||||
## symbols
|
||||
- UserProfileResponse
|
||||
- UserProfileUpdate
|
||||
- UserConfigResponse
|
||||
- UserConfigUpdate
|
||||
## workflows
|
||||
- change user behavior
|
||||
read: __init__.py, user.py, user_config.py
|
||||
- change user config
|
||||
read: user_config.py
|
||||
## dirty
|
||||
-
|
||||
Reference in New Issue
Block a user