Update sandbox routing

proxies/sandbox/apiproxy/proxies/default.xml

@@ -60,8 +60,8 @@
   <RouteRule name="NoRoute">
     <Condition>(request.verb = "OPTIONS") and (request.header.origin != null) and (request.header.Access-Control-Request-Method != null)</Condition>
   </RouteRule>
-  <RouteRule name="sandbox">
-    <TargetEndpoint>sandbox</TargetEndpoint>
+  <RouteRule name="RelatedPerson">
+    <TargetEndpoint>RelatedPerson</TargetEndpoint>
   </RouteRule>
   <DefaultFaultRule>
     <Step>

proxies/sandbox/apiproxy/proxy.xml

@@ -1,4 +1,4 @@
-<APIProxy name="vrsa">
+<APIProxy name="validated-relationship-service-api-sandbox">
   <!-- This is the root of the application -->
   <Description>Proxy to a target service.</Description>
 </APIProxy>

proxies/sandbox/apiproxy/targets/sandbox.xml

@@ -1,4 +1,4 @@
-<TargetEndpoint name="sandbox">
+<TargetEndpoint name="RelatedPerson">
     <Description/>
     <FaultRules/>
     <Flows/>

sandbox/.dockerignore

@@ -1,2 +1 @@
-node_modules
-npm-debug.log
+api/tests

sandbox/Dockerfile

@@ -10,4 +10,4 @@ RUN poetry install --without dev
 
 EXPOSE 9000
 
-CMD ["poetry", "run", "gunicorn", "app:app", "--bind=localhost:9000"]
+CMD ["poetry", "run", "gunicorn", "api.app:app", "--bind=0.0.0.0:9000"]

sandbox/api/app.py

@@ -21,8 +21,8 @@ def health() -> dict:
     }
 
 
-@app.route("/RelatedPerson", methods=["GET"])
-def related_persons() -> Union[dict, tuple]:
+@app.route("/FHIR/R4/RelatedPerson", methods=["GET"])
+def get_related_persons() -> Union[dict, tuple]:
     """Sandbox API for GET /RelatedPerson
 
     Returns:

sandbox/api/tests/test_app.py

@@ -3,6 +3,7 @@
 import pytest
 
 FILE_PATH = "sandbox.api.app"
+RELATED_PERSON_API_ENDPOINT = "/FHIR/R4/RelatedPerson"
 
 
 @pytest.mark.parametrize("endpoint", ["/_status", "/_ping", "/health"])
@@ -26,7 +27,7 @@ def test_related_person__identifier_only(
     # Arrange
     mock_get_response.return_value = expected_body = {"data": "mocked"}
     # Act
-    response = client.get("/RelatedPerson?identifier=1234567890")
+    response = client.get(f"{RELATED_PERSON_API_ENDPOINT}?identifier=1234567890")
     # Assert
     mock_get_response.assert_called_once_with(
         "./api/responses/GET_RelatedPerson/identifier.json"
@@ -43,7 +44,9 @@ def test_related_person__identifier_and_patient(
     # Arrange
     mock_get_response.return_value = expected_body = {"data": "mocked"}
     # Act
-    response = client.get("/RelatedPerson?identifier=1234567890&patient=0987654321")
+    response = client.get(
+        f"{RELATED_PERSON_API_ENDPOINT}?identifier=1234567890&patient=0987654321"
+    )
     # Assert
     mock_get_response.assert_called_once_with(
         "./api/responses/GET_RelatedPerson/identifier_and_patient.json"

specification/validated-relationships-service-api.yaml

@@ -111,7 +111,7 @@ info:
     ## Environments and testing
     | Environment       | Base URL                                                               |
     | ----------------- | ---------------------------------------------------------------------- |
-    | Sandbox           | `https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/`    |
+    | Sandbox           | `https://internal-dev-sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/`    |
     | Integration test  | `https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/`        |
     | Production        | `https://api.service.nhs.uk/validated-relationships/FHIR/R4/`            |
 
@@ -139,7 +139,7 @@ info:
     url: 'https://digital.nhs.uk/developer/help-and-support'
     email: [email protected]
 servers:
-  - url: 'https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4'
+  - url: 'https://internal-dev-sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4'
     description: Sandbox environment.
   - url: 'https://int.api.service.nhs.uk/validated-relationships/FHIR/R4'
     description: Integration test environment.
@@ -507,6 +507,7 @@ components:
       required: false
       schema:
         type: string
+        example: 1234567890
       examples:
         withoutSystem:
           value: "9000000009"
@@ -523,6 +524,7 @@ components:
       required: false
       schema:
         type: string
+        example: 0987654321
       examples:
         withoutSystem:
           value: "9000000009"