Skip to content

Commit 4c12418

Browse files
lambodarpadhy1lambodarpadhy1
authored
Merge pull request #309 from NHSDigital/feature/nhso-61032-documentation-and-postman-collection-change-for-dep
NHSO-61032: Dep documentaion and postman collection changes
2 parents 046efa9 + 311c7e3 commit 4c12418

3 files changed

Lines changed: 131 additions & 8 deletions

File tree

‎postman/NHS App - dev (NHS Login sandpit).postman_environment.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"values": [
55
{
66
"key": "base_url",
7-
"value": "https://dev.api.service.nhs.uk",
7+
"value": "https://dep.api.service.nhs.uk",
88
"enabled": true
99
},
1010
{
@@ -41,4 +41,4 @@
4141
"_postman_variable_scope": "environment",
4242
"_postman_exported_at": "2021-02-10T23:55:54.828Z",
4343
"_postman_exported_using": "Postman/7.36.3"
44-
}
44+
}

‎postman/NHS App.postman_collection.json‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@
2020
"type": "text/javascript",
2121
"packages": {}
2222
}
23+
},
24+
{
25+
"listen": "prerequest",
26+
"script": {
27+
"exec": [
28+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
29+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
30+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
31+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
32+
"}"
33+
],
34+
"type": "text/javascript"
35+
}
2336
}
2437
],
2538
"request": {
@@ -57,6 +70,19 @@
5770
],
5871
"type": "text/javascript"
5972
}
73+
},
74+
{
75+
"listen": "prerequest",
76+
"script": {
77+
"exec": [
78+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
79+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
80+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
81+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
82+
"}"
83+
],
84+
"type": "text/javascript"
85+
}
6086
}
6187
],
6288
"request": {
@@ -148,6 +174,12 @@
148174
"var uniqueId = pm.variables.replaceIn('{{$guid}}');",
149175
"eval(pm.globals.get(\"jsrsasign-js\")); //import jsrsasign lib",
150176
"",
177+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
178+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
179+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"oauth2/\")){",
180+
" pm.request.url = pm.request.url.toString().replace(\"oauth2/\", \"oauth2-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
181+
"}",
182+
"",
151183
"var header = {",
152184
" \"typ\": \"JWT\",",
153185
" \"alg\": \"RS512\",",
@@ -242,6 +274,19 @@
242274
],
243275
"type": "text/javascript"
244276
}
277+
},
278+
{
279+
"listen": "prerequest",
280+
"script": {
281+
"exec": [
282+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
283+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
284+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
285+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
286+
"}"
287+
],
288+
"type": "text/javascript"
289+
}
245290
}
246291
],
247292
"request": {
@@ -302,6 +347,19 @@
302347
],
303348
"type": "text/javascript"
304349
}
350+
},
351+
{
352+
"listen": "prerequest",
353+
"script": {
354+
"exec": [
355+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
356+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
357+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
358+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
359+
"}"
360+
],
361+
"type": "text/javascript"
362+
}
305363
}
306364
],
307365
"request": {
@@ -362,6 +420,19 @@
362420
],
363421
"type": "text/javascript"
364422
}
423+
},
424+
{
425+
"listen": "prerequest",
426+
"script": {
427+
"exec": [
428+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
429+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
430+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
431+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
432+
"}"
433+
],
434+
"type": "text/javascript"
435+
}
365436
}
366437
],
367438
"request": {
@@ -422,6 +493,19 @@
422493
],
423494
"type": "text/javascript"
424495
}
496+
},
497+
{
498+
"listen": "prerequest",
499+
"script": {
500+
"exec": [
501+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
502+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
503+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
504+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
505+
"}"
506+
],
507+
"type": "text/javascript"
508+
}
425509
}
426510
],
427511
"request": {
@@ -480,6 +564,19 @@
480564
],
481565
"type": "text/javascript"
482566
}
567+
},
568+
{
569+
"listen": "prerequest",
570+
"script": {
571+
"exec": [
572+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
573+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
574+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
575+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
576+
"}"
577+
],
578+
"type": "text/javascript"
579+
}
483580
}
484581
],
485582
"request": {
@@ -543,6 +640,19 @@
543640
],
544641
"type": "text/javascript"
545642
}
643+
},
644+
{
645+
"listen": "prerequest",
646+
"script": {
647+
"exec": [
648+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
649+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
650+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
651+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
652+
"}"
653+
],
654+
"type": "text/javascript"
655+
}
546656
}
547657
],
548658
"request": {
@@ -606,6 +716,19 @@
606716
],
607717
"type": "text/javascript"
608718
}
719+
},
720+
{
721+
"listen": "prerequest",
722+
"script": {
723+
"exec": [
724+
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
725+
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
726+
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
727+
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
728+
"}"
729+
],
730+
"type": "text/javascript"
731+
}
609732
}
610733
],
611734
"request": {

‎specification/nhs-app.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ info:
6262
After following these steps to create an application and register the public key, the App ID should be provided to the [NHS App onboarding team](mailto:app.onboarding@nhs.net) to grant your application permissions to the features that are appropriate to your use cases. If this step is not completed, all calls to this API will return responses with status code 403 Forbidden.
6363
6464
## Environments and testing
65-
| API Environment | NHS Login Environment | Base URL |
66-
| -------------------- | --------------------- | ------------------------------------------- |
67-
| Development | Sandpit | `https://dev.api.service.nhs.uk/nhs-app/` |
68-
| Integration Testing | Integration (AOS) | `https://int.api.service.nhs.uk/nhs-app/` |
69-
| Production | Production | `https://api.service.nhs.uk/nhs-app/` |
65+
| API Environment | NHS Login Environment | Base URL |
66+
| -------------------- | --------------------- | ----------------------------------------------- |
67+
| Development | Sandpit | `https://dep.api.service.nhs.uk/nhs-app-dep/` |
68+
| Integration Testing | Integration (AOS) | `https://int.api.service.nhs.uk/nhs-app/` |
69+
| Production | Production | `https://api.service.nhs.uk/nhs-app/` |
7070
7171
### Development
7272
Our development environment:
@@ -146,7 +146,7 @@ x-spec-publication:
146146
try-this-api:
147147
disabled: true
148148
servers:
149-
- url: "https://dev.api.service.nhs.uk/nhs-app"
149+
- url: "https://dep.api.service.nhs.uk/nhs-app-dep"
150150
description: Development environment.
151151
- url: "https://int.api.service.nhs.uk/nhs-app"
152152
description: Integration test environment.

0 commit comments

Comments
 (0)