omnibase_infra 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

omnibase_infra/services/registry_api/models/model_registry_node_view.py

@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Registry node view model for dashboard display.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Literal
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from omnibase_core.models.primitives.model_semver import ModelSemVer
+
+
+class ModelRegistryNodeView(BaseModel):
+    """Node view for dashboard display.
+
+    Represents a registered ONEX node from the registration projection,
+    flattened for dashboard consumption.
+
+    Attributes:
+        node_id: Unique identifier (entity_id from projection)
+        name: Human-readable node name (from service_name or node_type)
+        service_name: Consul service name for discovery
+        namespace: Optional namespace for multi-tenant deployments
+        display_name: Optional human-friendly display name
+        node_type: ONEX node archetype (EFFECT, COMPUTE, REDUCER, ORCHESTRATOR)
+        version: Semantic version (ModelSemVer instance)
+        state: Current FSM registration state
+        capabilities: List of capability tags
+        registered_at: Timestamp of initial registration
+        last_heartbeat_at: Timestamp of last heartbeat (nullable)
+    """
+
+    model_config = ConfigDict(frozen=True, extra="forbid", from_attributes=True)
+
+    node_id: UUID = Field(
+        ...,
+        description="Unique node identifier",
+    )
+    name: str = Field(
+        ...,
+        description="Node name (service_name or derived from node_type)",
+    )
+    service_name: str = Field(  # ONEX_EXCLUDE: pattern - Consul discovery identifier
+        ...,
+        description="Consul service name (external Consul identifier, not entity reference)",
+    )
+    namespace: str | None = Field(
+        default=None,
+        description="Optional namespace for multi-tenant deployments",
+    )
+    display_name: str | None = Field(
+        default=None,
+        description="Optional human-friendly display name",
+    )
+    node_type: Literal["EFFECT", "COMPUTE", "REDUCER", "ORCHESTRATOR"] = Field(
+        ...,
+        description="ONEX node archetype",
+    )
+    version: ModelSemVer = Field(
+        ...,
+        description="Semantic version (ONEX standard)",
+    )
+    state: str = Field(
+        ...,
+        description="Current FSM registration state",
+    )
+    capabilities: list[str] = Field(
+        default_factory=list,
+        description="List of capability tags",
+    )
+    registered_at: datetime = Field(
+        ...,
+        description="Timestamp of initial registration",
+    )
+    last_heartbeat_at: datetime | None = Field(
+        default=None,
+        description="Timestamp of last heartbeat",
+    )
+
+
+__all__ = ["ModelRegistryNodeView"]

omnibase_infra/services/registry_api/models/model_registry_summary.py

@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Registry summary model for aggregate statistics.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+"""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ModelRegistrySummary(BaseModel):
+    """Summary statistics for the registry.
+
+    Provides aggregate counts for dashboard widgets.
+
+    Attributes:
+        total_nodes: Total number of registered nodes
+        active_nodes: Number of nodes in ACTIVE state
+        healthy_instances: Number of passing health check instances
+        unhealthy_instances: Number of failing health check instances
+        by_node_type: Count of nodes by type
+        by_state: Count of nodes by registration state
+    """
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    total_nodes: int = Field(
+        ...,
+        ge=0,
+        description="Total number of registered nodes",
+    )
+    active_nodes: int = Field(
+        ...,
+        ge=0,
+        description="Number of nodes in ACTIVE state",
+    )
+    healthy_instances: int = Field(
+        ...,
+        ge=0,
+        description="Number of passing health check instances",
+    )
+    unhealthy_instances: int = Field(
+        ...,
+        ge=0,
+        description="Number of failing health check instances",
+    )
+    by_node_type: dict[str, int] = Field(
+        default_factory=dict,
+        description="Count of nodes by type",
+    )
+    by_state: dict[str, int] = Field(
+        default_factory=dict,
+        description="Count of nodes by registration state",
+    )
+
+
+__all__ = ["ModelRegistrySummary"]

omnibase_infra/services/registry_api/models/model_response_list_instances.py

@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Response model for list_instances endpoint.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+    - PR #182: Add Pydantic response models for API endpoints
+"""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from omnibase_infra.services.registry_api.models.model_registry_instance_view import (
+    ModelRegistryInstanceView,
+)
+from omnibase_infra.services.registry_api.models.model_warning import ModelWarning
+
+
+class ModelResponseListInstances(BaseModel):
+    """Response model for the GET /registry/instances endpoint.
+
+    Provides a list of live Consul service instances with optional warnings
+    for partial success scenarios.
+
+    Attributes:
+        instances: List of live Consul service instances
+        warnings: List of warnings for partial success scenarios
+    """
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    instances: list[ModelRegistryInstanceView] = Field(
+        default_factory=list,
+        description="List of live Consul service instances",
+    )
+    warnings: list[ModelWarning] = Field(
+        default_factory=list,
+        description="Warnings for partial success scenarios",
+    )
+
+
+__all__ = ["ModelResponseListInstances"]

omnibase_infra/services/registry_api/models/model_response_list_nodes.py

@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Response model for list_nodes endpoint.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+    - PR #182: Add Pydantic response models for API endpoints
+"""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from omnibase_infra.services.registry_api.models.model_pagination_info import (
+    ModelPaginationInfo,
+)
+from omnibase_infra.services.registry_api.models.model_registry_node_view import (
+    ModelRegistryNodeView,
+)
+from omnibase_infra.services.registry_api.models.model_warning import ModelWarning
+
+
+class ModelResponseListNodes(BaseModel):
+    """Response model for the GET /registry/nodes endpoint.
+
+    Provides a paginated list of registered nodes with optional warnings
+    for partial success scenarios.
+
+    Attributes:
+        nodes: List of registered nodes matching the query
+        pagination: Pagination information for the result set
+        warnings: List of warnings for partial success scenarios
+    """
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    nodes: list[ModelRegistryNodeView] = Field(
+        default_factory=list,
+        description="List of registered nodes matching the query",
+    )
+    pagination: ModelPaginationInfo = Field(
+        ...,
+        description="Pagination information for the result set",
+    )
+    warnings: list[ModelWarning] = Field(
+        default_factory=list,
+        description="Warnings for partial success scenarios",
+    )
+
+
+__all__ = ["ModelResponseListNodes"]

omnibase_infra/services/registry_api/models/model_warning.py

@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Warning model for partial success scenarios.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ModelWarning(BaseModel):
+    """Warning message for partial success scenarios.
+
+    Used when one backend succeeds but another fails, allowing the
+    API to return partial results with appropriate warnings.
+
+    Attributes:
+        source: Source of the warning (e.g., "consul", "postgres")
+        message: Human-readable warning message
+        code: Optional error code for programmatic handling
+        timestamp: When the warning was generated
+    """
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    source: str = Field(
+        ...,
+        description="Source of the warning",
+    )
+    message: str = Field(
+        ...,
+        description="Human-readable warning message",
+    )
+    code: str | None = Field(
+        default=None,
+        description="Optional error code",
+    )
+    timestamp: datetime = Field(
+        ...,
+        description="When the warning was generated",
+    )
+
+
+__all__ = ["ModelWarning"]

omnibase_infra/services/registry_api/models/model_widget_defaults.py

@@ -0,0 +1,28 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Widget defaults model for dashboard configuration.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+"""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+
+class ModelWidgetDefaults(BaseModel):
+    """Default configuration for a widget type.
+
+    Attributes vary by widget type and provide sensible defaults.
+    """
+
+    model_config = ConfigDict(frozen=True, extra="allow")
+
+    # Common fields - all optional
+    show_timestamp: bool | None = None
+    max_items: int | None = None
+    refresh_interval_seconds: int | None = None
+
+
+__all__ = ["ModelWidgetDefaults"]

omnibase_infra/services/registry_api/models/model_widget_mapping.py

@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 OmniNode Team
+"""Widget mapping model for complete dashboard configuration.
+
+Related Tickets:
+    - OMN-1278: Contract-Driven Dashboard - Registry Discovery
+"""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from omnibase_infra.services.registry_api.models.model_capability_widget_mapping import (
+    ModelCapabilityWidgetMapping,
+)
+
+
+class ModelWidgetMapping(BaseModel):
+    """Complete widget mapping configuration.
+
+    Loaded from widget_mapping.yaml, provides the mapping from
+    capabilities and semantic roles to widget types.
+
+    Attributes:
+        version: Configuration version for compatibility checking
+        capability_mappings: Map of capability tags to widget configs
+        semantic_mappings: Map of semantic roles to widget configs
+        fallback: Default widget config when no mapping matches
+    """
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    version: str = Field(
+        ...,
+        description="Configuration version",
+    )
+    capability_mappings: dict[str, ModelCapabilityWidgetMapping] = Field(
+        default_factory=dict,
+        description="Map of capability tags to widget configs",
+    )
+    semantic_mappings: dict[str, ModelCapabilityWidgetMapping] = Field(
+        default_factory=dict,
+        description="Map of semantic roles to widget configs",
+    )
+    fallback: ModelCapabilityWidgetMapping = Field(
+        ...,
+        description="Default widget config when no mapping matches",
+    )
+
+
+__all__ = ["ModelWidgetMapping"]