Skip to content

Commit 5399b8c

Browse files
committed
docs: rollout for service serach v3
1 parent 1be99c6 commit 5399b8c

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,32 @@ This can be obtained from [SonarCloud](https://sonarcloud.io/)
121121
as described [here](https://docs.sonarsource.com/sonarqube/latest/user-guide/user-account/generating-and-using-tokens/).
122122
You will need the "Execute Analysis" permission for the project (NHSDigital_prescriptionsforpatients) in order for the token to work.
123123

124+
### Upstream dependencies
125+
126+
#### Directory of Healthcare Services API (aka Service Search) - version 3
127+
128+
[Service Search v3](https://digital.nhs.uk/developer/api-catalogue/directory-of-healthcare-services/version-3) uses
129+
[application-restricted RESTful API - API key authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-api-key-authentication).
130+
To achieve this the following applications have been created on the
131+
[Int/Prod onboarding portal](https://onboarding.prod.api.platform.nhs.uk/):
132+
133+
* `PFP-INTERNAL-DEV-DOHS` - managed by [EPS_team](https://onboarding.prod.api.platform.nhs.uk/MyApplications/Teams/TeamDetails?id=060896ea-ba43-4df8-a011-7cb0f45fd8ed) - connected to [Service Search - REST API (Integration Testing Environment)](https://int.api.service.nhs.uk/service-search-api/search)
134+
* `PFP-QA-DOHS` - managed by [EPS_team](https://onboarding.prod.api.platform.nhs.uk/MyApplications/Teams/TeamDetails?id=060896ea-ba43-4df8-a011-7cb0f45fd8ed) - connected to [Service Search - REST API (Integration Testing Environment)](https://int.api.service.nhs.uk/service-search-api/search)
135+
* `PFP-REF-DOHS` - managed by [EPS_team](https://onboarding.prod.api.platform.nhs.uk/MyApplications/Teams/TeamDetails?id=060896ea-ba43-4df8-a011-7cb0f45fd8ed) - connected to [Service Search - REST API (Integration Testing Environment)](https://int.api.service.nhs.uk/service-search-api/search)
136+
* `PFP-INT-DOHS` - managed by EPS_Team_Prod - connected to [Service Search - REST API (Production Environment)](https://api.service.nhs.uk/service-search-api/search)
137+
* `PFP-PROD-DOHS` - managed by EPS_Team_Prod - connected to [Service Search - REST API (Production Environment)](https://api.service.nhs.uk/service-search-api/search)
138+
139+
After `IaC` creates the secret `pfp-PfP-ServiceSearch-API-Key`
140+
its value must be set manually to the API key from the appropriate app.
141+
142+
In addition the Service Search URL must be set as a GitHub secret:
143+
144+
* DEV_TARGET_SERVICE_SEARCH_V3_SERVER: <https://int.api.service.nhs.uk/service-search-api/search>
145+
* QA_TARGET_SERVICE_SEARCH_V3_SERVER: <https://int.api.service.nhs.uk/service-search-api/search>
146+
* REF_TARGET_SERVICE_SEARCH_V3_SERVER: <https://int.api.service.nhs.uk/service-search-api/search>
147+
* INT_TARGET_SERVICE_SEARCH_V3_SERVER: <https://api.service.nhs.uk/service-search-api/search>
148+
* PROD_TARGET_SERVICE_SEARCH_V3_SERVER: <https://api.service.nhs.uk/service-search-api/search>
149+
124150
### GitHub Packages Setup
125151

126152
To work with the GitHub Package Registry, you need to generate a [personal access token (classic)](https://docs.github.com/en/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) with appropriate permissions.

0 commit comments

Comments
 (0)