cmsnav-747 Propose wording changes, correct omission from Makefile and document changes.

Author: angloc

Makefile

@@ -32,6 +32,10 @@ publish: clean
 	mkdir -p build
 	npm run publish 2> /dev/null
 
+#Serve the API description locally
+serve:
+	npm run serve
+
 #Runs build proxy script
 build-proxy:
 	scripts/build_proxy.sh

README.md

@@ -21,18 +21,31 @@ The contents of this repository are protected by Crown Copyright (C).
 
 ## Development
 
-### Requirements
+You can set up your development manually on your development machine, or :bulb: use the supplied devcontainer specification to set up
+the required environment automatically.
+
+### :bulb: Developing in a devcontainer
+
+If you are unfamiliar with the use of devcontainers, these resources may be helpful:
+- VSCode: https://code.visualstudio.com/docs/devcontainers/tutorial
+- JetBrains/pycharm: https://www.jetbrains.com/help/idea/prerequisites-for-dev-containers.html 
+
+The provided configuration in the .devcontainer folder will set up all the required tooling as detailed in the following section automatically.
+
+### Developing without a devcontainer
+
+#### Requirements
 * make
 * nodejs + npm/yarn
 * [poetry](https://github.com/python-poetry/poetry)
 * Java 8+
 
-### Install
+#### Install
 ```
 $ make install
 ```
 
-#### Updating hooks
+##### Updating hooks
 You can install some pre-commit hooks to ensure you can't commit invalid spec changes by accident. These are also run
 in CI, but it's useful to run them locally too.
 
@@ -49,7 +62,7 @@ Various scripts and commands rely on environment variables being set. These are
 There are `make` commands that alias some of this functionality:
  * `lint` -- Lints the spec and code
  * `publish` -- Outputs the specification as a **single file** into the `build/` directory
- * `serve` -- Serves a preview of the specification in human-readable format
+ * `serve` -- Serves a preview of the specification in human-readable format on http://127.0.0.1:5000
 
 ### Testing
 Each API and team is unique. We encourage you to use a `test/` folder in the root of the project, and use whatever testing frameworks or apps your team feels comfortable with. It is important that the URL your test points to be configurable. We have included some stubs in the Makefile for running tests.

specification/nhs-website-content-api.yaml

@@ -8,9 +8,16 @@ info:
     ## Overview
     This API provides content from the [NHS website](https://www.nhs.uk) as JSON, to be consumed programmatically and used by your application.
 
+    ⚠️ Historically, many pages describing conditions or tests were inappropriately allocated to the Conditions A to Z.
+
+    The April 2025 update introduces two new endpoints for 'symptoms' and 'testandtreatments' that reflect the reallocation of these
+    pages to new hub pages in the website.
+
     You can reuse the content from the following sections of the NHS website:
-      * Health A to Z / Conditions ([Website](https://www.nhs.uk/conditions/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/conditions))
+      * Conditions A to Z / Conditions ([Website](https://www.nhs.uk/conditions/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/conditions))
       * Medicines A to Z ([Website](https://www.nhs.uk/medicines/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/medicines))
+      * Symptoms A to Z ([Website](https://www.nhs.uk/symptoms/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/symptoms))
+      * Tests and treatments A to Z ([Website](https://www.nhs.uk/testsandtreatments/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/testsandtreatments))
       * Mental health ([Website](https://www.nhs.uk/mental-health/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/mental-health))
       * Live Well ([Website](https://www.nhs.uk/live-well/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/live-well))
       * Pregnancy ([Website](https://www.nhs.uk/pregnancy/) | [API](https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2#get-/pregnancy))
@@ -25,6 +32,13 @@ info:
 
     If you are migrating from our [old NHS website APIs](https://developer.api.nhs.uk/nhs-api), we have a [migration guide](https://developer.api.nhs.uk/support/migration/guide) to help walk you through the process and a [migration assistant](https://developer.api.nhs.uk/support/migration/assistant) to illustrate the differences in how your API requests will need to be updated.
 
+    ## Updates
+
+    | Version       | Date | Changes   |
+    |------------|-----|--------------|
+    | 2.2.0 | April 2025  | Introduce `symptoms` and `testsandtreatments` endpoints |
+
+
     ## Who can use this API
     Anyone can use this API for any purpose, so long as they have agreed to the [Online connection agreement](https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement) during the [onboarding process](https://digital.nhs.uk/developer/guides-and-documentation/onboarding-process) and they include an [attribution](#overview--attribution) as outlined below.