Skip to content

Commit 98c366d

Browse files
authored
Spec documentation updates (#111)
1 parent ff2d52c commit 98c366d

1 file changed

Lines changed: 3 additions & 14 deletions

File tree

specification/nhs-website-content-api.yaml

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,7 @@ info:
2121
* [find services near you](https://www.nhs.uk/nhs-services/services-near-you/)
2222
* get Ratings and Reviews of NHS services.
2323
24-
Pick a page from one of these sections on the [NHS website](https://www.nhs.uk/).
25-
Make a note of the path in the page URL (the bit that appears after '`https://www.nhs.uk/`').
26-
27-
You can then use this path to make API calls to the 'Integration test' environment and the 'Production' environment like so …
28-
29-
**Integration test environment**
30-
31-
`https://int.api.service.nhs.uk/nhs-website-content/YOUR_PATH_GOES_HERE`
32-
33-
**Production environment**
34-
35-
`https://api.service.nhs.uk/nhs-website-content/YOUR_PATH_GOES_HERE`
24+
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/assistant) to help walk you through the process and a [migration assistant](https://developer.api.nhs.uk/support/migration/guide) to illustrate the differences in how your API requests will need to be updated.
3625
3726
## Who can use this API
3827
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.
@@ -45,12 +34,12 @@ info:
4534
The logo should be clearly visible and in line with the associated content on every web page that contains the syndicated content. You should also link this logo to the relevant page on the NHS website that the content has been supplied from.
4635
4736
```
48-
<a href="https://www.nhs.uk/THE_PATH_TO_THE_CONTENT_GOES_HERE" target="_blank">
37+
<a href="https://www.nhs.uk/THE_PATH_TO_THE_ORIGINAL_CONTENT_GOES_HERE" target="_blank">
4938
<img src="https://digital.nhs.uk/binaries/content/gallery/website/developer/api-catalogue/nhs-website-content/nhs-attribution.png" alt="Content supplied by the NHS website" width="801" height="157" style="width: 250px; height: 49px;" />
5039
</a>
5140
```
5241
53-
This URL is supplied as part of the JSON response under author:
42+
The logo image URL is supplied as part of the JSON response under author:
5443
5544
```
5645
"author": {

0 commit comments

Comments
 (0)