fix: api docs

Author: luislhl

hathor/healthcheck/resources/healthcheck.py

@@ -90,14 +90,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 +116,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.'
+                                                }
+                                            ]
+                                        }
                                     }
                                 }
                             }