added detail to open API spec

Author: Brad Morton

specification/nhs-website-content-api.yaml

@@ -6,27 +6,57 @@ info:
   version: 'Computed and injected at build time by `scripts/set_version.py`'
   description: |
     ## Overview
-    Add a fully fledged description here with markdown syntax.
-    For help completing the content of your API spec, see our guidance on the minimum standard (bronze) details 
-    to include [here](https://nhsd-confluence.digital.nhs.uk/display/APM/Writing+a+bronze+API+cover+page). You should also base your content on our exemplar API - [PDS FHIR](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir).
+    An API representation of content on the [NHS website](https://www.nhs.uk)
+    You can reuse the following content from the NHS website:
+      - health conditions
+      - medicines
+      - pregnancy
+      - mental health
+      - videos
+      - common health questions
+      - information about NHS services
+
+    You cannot currently use this API to:
+      - access data from NHS Services
+      - access Ratings and Reviews of NHS organisations submitted to the NHS website
+
+    TODO to include [here](https://nhsd-confluence.digital.nhs.uk/display/APM/Writing+a+bronze+API+cover+page). You should also base your content on our exemplar API - [PDS FHIR](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir).
+
     ## Who can use this API
-    To be completed.
+    Anyone can use this API. Users need to agree to our terms and conditions. TODO link to terms and conditions
+
     ## Related APIs
-    To be completed.
+    The following APIs also give access to data from the NHS website:
+      - Service Search API
+      - Ratings and Reviews API
+      TODO link to API docs
+
     ## API status and roadmap
-    To be completed.
+    This API has been moved from the nhs.uk developer API website. It is currently in Alpha phase
+
     ## Service level
-    To be completed.
+
     ## Technology
-    To be completed.
+
     ## Network access
-    To be completed.
+    No special network access is required for this API.
+
     ## Security and authorisation
-    To be completed.
+    You will need to provide a subscription key in the header or as a query parameter in your requests.
+    Your subscription key can be found by logging into the API portal (provide link)
+
     ## Environments and testing
-    To be completed.
+    We have a sandbox here (provide link) where you can see typical responses. We also have a test environment here (provide link)
     ## Onboarding
-    To be completed.
+
+    ## Attribution
+
+    Any syndicated content must incorporate the following attribution (credit) to the NHS website:
+
+    ![NHS logo with attribution](../static/images/nhs_attribution.png)
+
+    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. This URL is supplied as part of the feed under author:
+
   contact:
     name: 'nhs-website-content-api API Support'
     url: 'https://digital.nhs.uk/developer/help-and-support'