fix: api docs

Author: luislhl

hathor/healthcheck/models.py

@@ -2,7 +2,7 @@
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum
-from typing import Any, Dict, List, Optional
+from typing import Any, Optional
 
 
 class ComponentType(str, Enum):
@@ -37,7 +37,7 @@ class ComponentHealthCheck:
     def __post_init__(self) -> None:
         self.time = datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")
 
-    def to_json(self) -> Dict[str, str]:
+    def to_json(self) -> dict[str, str]:
         """Return a dict representation of the object. All field names are converted to camel case."""
         json = {
             "componentType": self.component_type.value,
@@ -67,7 +67,7 @@ class ServiceHealthCheck:
     """This class is used to store the result of a service health check."""
 
     description: str
-    checks: Dict[str, List[ComponentHealthCheck]]
+    checks: dict[str, list[ComponentHealthCheck]]
 
     @property
     def status(self) -> HealthCheckStatus:
@@ -98,7 +98,7 @@ def get_http_status_code(self) -> int:
         else:
             raise ValueError(f"Missing treatment for status {self.status}")
 
-    def to_json(self) -> Dict[str, Any]:
+    def to_json(self) -> dict[str, Any]:
         """Return a dict representation of the object. All field names are converted to camel case."""
         return {
             "status": self.status.value,

hathor/healthcheck/resources/healthcheck.py

@@ -74,10 +74,9 @@ def render_GET(self, request):
 Returns 503 otherwise. The response will contain the components that were considered for the healthcheck
 and the reason why they were unhealthy.
 
-We currently perform 3 checks in the sync mechanism for the healthcheck:
+We currently perform 2 checks in the sync mechanism for the healthcheck:
 1. Whether the fullnode has recent block activity, i.e. if the fullnode has blocks with recent timestamps.
 2. Whether the fullnode has at least one synced peer
-3. Whether the other fullnodes in the network have a best block that is at most 10 blocks ahead of the fullnode's best block.
             ''',
             'responses': {
                 '200': {
@@ -90,14 +89,16 @@ def render_GET(self, request):
                                     'value': {
                                         'status': 'pass',
                                         'description': 'Hathor-core v0.56.0',
-                                        'components': [
-                                            {
-                                                'componentName': 'sync',
-                                                'componentType': 'internal',
-                                                'status': 'pass',
-                                                'output': 'Healthy'
-                                            }
-                                        ]
+                                        'checks': {
+                                            'sync': [
+                                                {
+                                                    'componentName': 'sync',
+                                                    'componentType': 'internal',
+                                                    'status': 'pass',
+                                                    'output': 'Healthy'
+                                                }
+                                            ]
+                                        }
                                     }
                                 }
                             }
@@ -114,44 +115,50 @@ def render_GET(self, request):
                                     'value': {
                                         'status': 'fail',
                                         'description': 'Hathor-core v0.56.0',
-                                        'components': [
-                                            {
-                                                'componentName': 'sync',
-                                                'componentType': 'internal',
-                                                'status': 'fail',
-                                                'output': 'Node doesn\'t have recent blocks'
-                                            }
-                                        ]
+                                        'checks': {
+                                            'sync': [
+                                                {
+                                                    'componentName': 'sync',
+                                                    'componentType': 'internal',
+                                                    'status': 'fail',
+                                                    'output': 'Node doesn\'t have recent blocks'
+                                                }
+                                            ]
+                                        }
                                     }
                                 },
                                 'no_synced_peer': {
                                     'summary': 'Node with no synced peer',
                                     'value': {
                                         'status': 'fail',
                                         'description': 'Hathor-core v0.56.0',
-                                        'components': [
-                                            {
-                                                'componentName': 'sync',
-                                                'componentType': 'internal',
-                                                'status': 'fail',
-                                                'output': 'Node doesn\'t have a synced peer'
-                                            }
-                                        ]
+                                        'checks': {
+                                            'sync': [
+                                                {
+                                                    'componentName': 'sync',
+                                                    'componentType': 'internal',
+                                                    'status': 'fail',
+                                                    'output': 'Node doesn\'t have a synced peer'
+                                                }
+                                            ]
+                                        }
                                     }
                                 },
                                 'peer_best_block_far_ahead': {
                                     'summary': 'Peer with best block too far ahead',
                                     'value': {
                                         'status': 'fail',
                                         'description': 'Hathor-core v0.56.0',
-                                        'components': [
-                                            {
-                                                'componentName': 'sync',
-                                                'componentType': 'internal',
-                                                'status': 'fail',
-                                                'output': 'Node\'s peer with highest height is too far ahead.'
-                                            }
-                                        ]
+                                        'checks': {
+                                            'sync': [
+                                                {
+                                                    'componentName': 'sync',
+                                                    'componentType': 'internal',
+                                                    'status': 'fail',
+                                                    'output': 'Node\'s peer with highest height is too far ahead.'
+                                                }
+                                            ]
+                                        }
                                     }
                                 }
                             }