diff --git a/.changeset/wise-rockets-smoke.md b/.changeset/wise-rockets-smoke.md new file mode 100644 index 0000000000..c81d20519d --- /dev/null +++ b/.changeset/wise-rockets-smoke.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Document the default behavior of `statusCheck` option in `createStatusCheckRouter`. diff --git a/packages/backend-common/src/service/createStatusCheckRouter.ts b/packages/backend-common/src/service/createStatusCheckRouter.ts index ab24a6953b..fd794cc9c4 100644 --- a/packages/backend-common/src/service/createStatusCheckRouter.ts +++ b/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; }