/status and ServiceBroker.status()

openbrokerapi/api.py

@@ -64,6 +64,18 @@ def get_blueprint(service_brokers: Union[List[ServiceBroker], ServiceBroker],
     logger.debug("Apply print_request filter for debugging")
     openbroker.before_request(print_request)
 
+    @openbroker.route("/status", methods=['GET'])
+    def status():
+        """
+        :return: Status of broker (Run health check for each service)
+        """
+        logger.debug("Status check filter %s %s", request.method, request.path)
+        if request.method == 'GET' and request.path == '/status':
+            return to_json_response({broker.service_id():broker.status() for broker in service_brokers})
+
+    logger.debug("Apply status filter for health check")
+    openbroker.before_request(status)
+
     if DISABLE_VERSION_CHECK:
         logger.warning(
             "Minimum API version is not checked, this can cause illegal contracts between service broker and platform!"
@@ -96,8 +108,7 @@ def add_service_id_to_async_response(response, service_id: str):
     def extract_authorization_username(request: Request):
         if request.authorization is not None:
             return request.authorization.username
-        else:
-            return None
+        return None
 
     @openbroker.errorhandler(Exception)
     def error_handler(e):

openbrokerapi/service_broker.py

@@ -271,6 +271,15 @@ def check_plan_id(self, plan_id) -> bool:
                 return True
         return False
 
+    def status(self) -> str:
+        """
+        Returns the health status of the service provided by this broker.
+
+        :return: string "OK" or "KO" or anything usefull
+        :rtype: str
+        """
+        return "OK"
+
     def catalog(self) -> Service:
         """
         Returns the services information which is provided by this broker.