diff --git a/docs/assets/quickstart_swaggerui.png b/docs/assets/quickstart_swaggerui.png index 4ff5524558..e3e6f913a6 100644 Binary files a/docs/assets/quickstart_swaggerui.png and b/docs/assets/quickstart_swaggerui.png differ diff --git a/docs/tre-admins/setup-instructions/deploying-azure-tre.md b/docs/tre-admins/setup-instructions/deploying-azure-tre.md index aa52623e9a..9c4cd0867c 100644 --- a/docs/tre-admins/setup-instructions/deploying-azure-tre.md +++ b/docs/tre-admins/setup-instructions/deploying-azure-tre.md @@ -35,22 +35,34 @@ make letsencrypt ### Using curl -Use `curl` to make a simple request to the status endpoint of the API: +Use `curl` to make a simple request to the health endpoint of the API: ```bash -curl https:///api/status +curl https:///api/health ``` The expected response is: ```json -{"services":[{"service":"Cosmos DB","status":"OK","message":""}]} -``` - -You can also create a request to the `api/health` endpoint to verify that the API is deployed and responds. You should see a *pong* response as a result of the request below: - -```cmd -curl https:///api/health +{ + "services": [ + { + "service": "Cosmos DB", + "status": "OK", + "message": "" + }, + { + "service": "Service Bus", + "status": "OK", + "message": "" + }, + { + "service": "Resource Processor", + "status": "OK", + "message": "" + } + ] +} ``` ### Using the API docs diff --git a/e2e_tests/resources/strings.py b/e2e_tests/resources/strings.py index e5722b1795..a76c151162 100644 --- a/e2e_tests/resources/strings.py +++ b/e2e_tests/resources/strings.py @@ -1,7 +1,6 @@ PONG = "pong" API_HEALTH = "/api/health" -API_STATUS = "/api/status" API_WORKSPACE_TEMPLATES = "/api/workspace-templates" API_WORKSPACES = "/api/workspaces" API_WORKSPACE_SERVICE_TEMPLATES = "/api/workspace-service-templates" diff --git a/e2e_tests/test_provisioned_health_api.py b/e2e_tests/test_provisioned_health_api.py index 0b3b2afae1..14a9806c2d 100644 --- a/e2e_tests/test_provisioned_health_api.py +++ b/e2e_tests/test_provisioned_health_api.py @@ -8,16 +8,14 @@ pytestmark = pytest.mark.asyncio +@pytest.mark.smoke async def test_health() -> None: async with AsyncClient(verify=False) as client: url = f"https://{config.TRE_ID}.{config.RESOURCE_LOCATION}.cloudapp.azure.com{strings.API_HEALTH}" response = await client.get(url) - assert response.json()["message"] == strings.PONG - - -async def test_status() -> None: - async with AsyncClient(verify=False) as client: - url = f"https://{config.TRE_ID}.{config.RESOURCE_LOCATION}.cloudapp.azure.com{strings.API_STATUS}" - response = await client.get(url) assert response.status_code == 200 - assert response.json()["services"] == [{'service': 'Cosmos DB', 'status': 'OK', 'message': ''}] + assert response.json()["services"] == [ + {"service": "Cosmos DB", "status": "OK", "message": ""}, + {"service": "Service Bus", "status": "OK", "message": ""}, + {"service": "Resource Processor", "status": "OK", "message": ""}, + ]