Skip to content

eli-263 modify _status endpoint #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Karthikeyannhs merged 6 commits into from
Sep 26, 2025
Merged

eli-263 modify _status endpoint #159

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
186ce07
eli-263 modify _status endpoint
Karthikeyannhs Sep 25, 2025
8e4ee35
Merge branch 'main' into eli-363/_status_implementation
Karthikeyannhs Sep 26, 2025
8b0bb50
eli-263 update target with new status endpoint
Karthikeyannhs Sep 26, 2025
587c1e9
remove HealthStatusEndpoint.json
Karthikeyannhs Sep 26, 2025
1be2f06
lint fixes
Karthikeyannhs Sep 26, 2025
a39ea40
add cli tools to package.json
Karthikeyannhs Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions sandbox/HealthStatusEndpoint.json
View file
Open in desktop

This file was deleted.

25 changes: 22 additions & 3 deletions sandbox/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@
import logging
import os
import sys
from http import HTTPStatus

import requests # pyright: ignore [reportMissingModuleSource]
from flask import Flask, Request, Response, request # pyright: ignore [reportMissingImports]
from flask import Flask, Request, Response, request, make_response # pyright: ignore [reportMissingImports]

# Configure logging to output to stdout
logging.basicConfig(stream=sys.stdout, level=logging.INFO)
Expand Down Expand Up @@ -157,13 +158,31 @@ def parse_prefer_header_value(prefer_header_value: str) -> str:
return ""


@app.route("/_status", methods=["GET"])
@app.route("/patient-check/_status", methods=["GET"])
def health_check() -> Response:
"""
Health-check endpoint to verify the application is running.
Returns a 200 OK status with a simple JSON response.
"""
return Response('{"status": "ok"}', status=200, mimetype="application/json")
status_json = {
"status": "pass",
"version": "",
"revision": "",
"releaseId": "",
"commitId": "",
"checks": {
"healthcheckService:status": [
{
"status": "pass",
"timeout": False,
"responseCode": 200,
"outcome": "<html><h1>Ok</h1></html>",
"links": {"self": f"https://default-eligibility-signposting-api-live/patient-check/_status"},
}
]
},
}
return make_response(status_json, HTTPStatus.OK, {"Content-Type": "application/json"})


@app.route("/", defaults={"path": ""})
Expand Down
2 changes: 1 addition & 1 deletion specification/x-nhsd-apim/target-dev.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
type: external
url: "TBC"
healthcheck: /_status
healthcheck: /patient-check/_status
security:
type: mtls
secret: eligibility-signposting-api
2 changes: 1 addition & 1 deletion specification/x-nhsd-apim/target-preprod.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
type: external
url: "preprod.eligibility-signposting-api.nhs.uk"
healthcheck: /_status
healthcheck: /patient-check/_status
security:
type: mtls
secret: eligibility-signposting-api
2 changes: 1 addition & 1 deletion specification/x-nhsd-apim/target-prod.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
type: external
url: "prod.eligibility-signposting-api.national.nhs.uk"
healthcheck: /_status
healthcheck: /patient-check/_status
security:
type: mtls
secret: eligibility-signposting-api
2 changes: 1 addition & 1 deletion specification/x-nhsd-apim/target-sandbox.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
type: hosted
healthcheck: /_status
healthcheck: /patient-check/_status
containers:
- name: eligibility-signposting-api
image:
Expand Down
2 changes: 1 addition & 1 deletion specification/x-nhsd-apim/target-test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
type: external
url: "test.eligibility-signposting-api.nhs.uk"
healthcheck: /_status
healthcheck: /patient-check/_status
security:
type: mtls
secret: eligibility-signposting-api
Expand Down
Loading