Merge pull request #6451 from backstage/orkohunter/document-default-status-check-behavior

docs: add a docstring about the default healthcheck middleware behavior

.changeset/wise-rockets-smoke.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+Document the default behavior of `statusCheck` option in `createStatusCheckRouter`.

packages/backend-common/src/service/createStatusCheckRouter.ts

@@ -22,6 +22,10 @@ import { errorHandler, statusCheckHandler, StatusCheck } from '../middleware';
 export interface StatusCheckRouterOptions {
   logger: Logger;
   path?: string;
+  /**
+   * If not implemented, the default express middleware always returns 200.
+   * Override this to implement your own logic for a health check.
+   */
   statusCheck?: StatusCheck;
 }