Skip to content

Commit b9c5553

Browse files
anglocangloc
committed
cmsnav-735 Update OAS specification
1 parent 4b19ff9 commit b9c5553

4 files changed

Lines changed: 380 additions & 15 deletions

File tree

‎pyproject.toml‎

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
1-
[project]
2-
python = "^3.8"
3-
41
[tool.poetry]
52
name = "nhs-website-content-api"
6-
version = "0.0.1-alpha"
3+
version = "2.2.0"
74
description = "TODO"
8-
authors = [
9-
#TODO add authors
10-
]
11-
readme = 'README.md'
5+
authors = ["TODO <todo@example.com>"]
6+
readme = "README.md"
127
license = "MIT"
138
repository = "https://github.com/NHSDigital/nhs-website-content-api"
149
homepage = "https://digital.nhs.uk/developer/api-catalogue/nhs-website-content/v2"
15-
keywords = ["healthcare", "uk", "nhs"] #TODO add additional keywords
16-
10+
keywords = ["healthcare", "uk", "nhs"]
11+
package-mode = false
1712

1813
[tool.poetry.dependencies]
19-
python = "^3.8"
14+
python = ">=3.9,<4.0"
2015
pytest-nhsd-apim = "^2.0.2"
16+
requests = "2.27.1"
2117

22-
[tool.poetry.dev-dependencies]
18+
[tool.poetry.group.dev.dependencies]
2319
flake8 = "^3.7.9"
2420
black = "^20.8b1"
2521
pip-licenses = "^2.0.1"
2622
jinja2 = "^2.11.1"
27-
pyyaml = "^5.2"
23+
pyyaml = "^6.0"
2824
docopt = "^0.6.2"
2925
jsonpath-rw = "^1.4.0"
3026
semver = "^2.9.0"
@@ -33,5 +29,6 @@ pytest = "^6.1.2"
3329
coverage = "^5.5"
3430
aiohttp = "^3.8.6"
3531
pytest-asyncio = "^0.14.0"
32+
pre-commit = "^4.2.0"
3633

3734
[tool.poetry.scripts]

‎specification/components/examples/SymptomsAToZ.json‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
{
2+
"@context": "http://schema.org",
3+
"@type": "MedicalWebPage",
4+
"name": "Symptoms A to Z",
5+
"copyrightHolder": {
6+
"name": "Crown Copyright",
7+
"@type": "Organization"
8+
},
9+
"license": "https://developer.api.nhs.uk/terms",
10+
"author": {
11+
"url": "https://www.nhs.uk",
12+
"logo": "https://assets.nhs.uk/nhsuk-cms/images/nhs-attribution.width-510.png",
13+
"email": "nhswebsite.servicedesk@nhs.net",
14+
"@type": "Organization",
15+
"name": "NHS website"
16+
},
17+
"about": {
18+
"@type": "WebPage",
19+
"name": "Symptoms A to Z",
20+
"alternateName": ""
21+
},
22+
"description": "",
23+
"url": "https://www.nhs.uk/symptoms/",
24+
"genre": [],
25+
"keywords": "",
26+
"dateModified": "2025-03-26T14:51:24+00:00",
27+
"breadcrumb": {
28+
"@context": "http://schema.org",
29+
"@type": "BreadcrumbList",
30+
"itemListElement": [
31+
{
32+
"@type": "ListItem",
33+
"position": 0,
34+
"item": {
35+
"@id": "https://www.nhs.uk/symptoms/",
36+
"name": "Symptoms A to Z",
37+
"genre": []
38+
}
39+
}
40+
]
41+
},
42+
"contentSubTypes": [],
43+
"significantLink": [
44+
{
45+
"description": "Find out what you can do to ease ankle pain, what could be causing the pain and when to get medical help.",
46+
"linkRelationship": "Result",
47+
"@type": "LinkRole",
48+
"articleStatus": "published",
49+
"mainEntityOfPage": {
50+
"@type": "MedicalWebPage",
51+
"genre": [
52+
"Symptom"
53+
],
54+
"datePublished": "2022-03-30T12:58:40+00:00",
55+
"dateModified": "2025-03-26T14:50:35+00:00",
56+
"lastReviewed": [
57+
"2022-02-22T08:29:00+00:00",
58+
"2025-02-22T08:29:00+00:00"
59+
],
60+
"reviewDue": "2025-02-22T08:29:00+00:00",
61+
"keywords": ""
62+
},
63+
"url": "https://www.nhs.uk/conditions/foot-pain/ankle-pain/",
64+
"name": "Ankle pain"
65+
},
66+
{
67+
"description": "Find out about high blood pressure, including how to find out if you have it, what causes it and what you can do to lower it.",
68+
"linkRelationship": "Result",
69+
"@type": "LinkRole",
70+
"articleStatus": "published",
71+
"mainEntityOfPage": {
72+
"@type": "MedicalWebPage",
73+
"genre": [
74+
"Condition"
75+
],
76+
"datePublished": "2024-07-22T15:12:33+00:00",
77+
"dateModified": "2025-03-28T11:46:40+00:00",
78+
"lastReviewed": [
79+
"2024-07-19T07:27:00+00:00",
80+
"2027-07-19T07:27:00+00:00"
81+
],
82+
"reviewDue": "2027-07-19T07:27:00+00:00",
83+
"keywords": "",
84+
"alternateName": [
85+
"Hypertension"
86+
]
87+
},
88+
"url": "https://www.nhs.uk/conditions/high-blood-pressure/",
89+
"name": "High blood pressure"
90+
}
91+
],
92+
"relatedLink": [
93+
{
94+
"@type": "LinkRole",
95+
"url": "https://www.nhs.uk/symptoms/?page=1",
96+
"name": "First Page",
97+
"description": "Link to First Page",
98+
"linkRelationship": "Pagination"
99+
},
100+
{
101+
"@type": "LinkRole",
102+
"url": "https://www.nhs.uk/symptoms/?page=1",
103+
"name": "Last Page",
104+
"description": "Link to Last Page",
105+
"linkRelationship": "Pagination"
106+
},
107+
{
108+
"@type": "LinkRole",
109+
"url": "https://www.nhs.uk/symptoms/",
110+
"name": "Self",
111+
"description": "Link to nhs.uk Page",
112+
"linkRelationship": "Self"
113+
}
114+
]
115+
}

‎specification/components/examples/TestsAndTreatmentsAToZ.json‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
{
2+
"@context": "http://schema.org",
3+
"@type": "MedicalWebPage",
4+
"name": "Tests and treatments A to Z",
5+
"copyrightHolder": {
6+
"name": "Crown Copyright",
7+
"@type": "Organization"
8+
},
9+
"license": "https://developer.api.nhs.uk/terms",
10+
"author": {
11+
"url": "https://www.nhs.uk",
12+
"logo": "https://assets.nhs.uk/nhsuk-cms/images/nhs-attribution.width-510.png",
13+
"email": "nhswebsite.servicedesk@nhs.net",
14+
"@type": "Organization",
15+
"name": "NHS website"
16+
},
17+
"about": {
18+
"@type": "WebPage",
19+
"name": "Tests and treatments A to Z",
20+
"alternateName": ""
21+
},
22+
"description": "",
23+
"url": "https://www.nhs.uk/tests-and-treatments/",
24+
"genre": [],
25+
"keywords": "",
26+
"dateModified": "2025-03-26T14:52:02+00:00",
27+
"breadcrumb": {
28+
"@context": "http://schema.org",
29+
"@type": "BreadcrumbList",
30+
"itemListElement": [
31+
{
32+
"@type": "ListItem",
33+
"position": 0,
34+
"item": {
35+
"@id": "https://www.nhs.uk/tests-and-treatments/",
36+
"name": "Tests and treatments A to Z",
37+
"genre": []
38+
}
39+
}
40+
]
41+
},
42+
"contentSubTypes": [],
43+
"significantLink": [
44+
{
45+
"description": "Read about how X-rays work, why they're used, what happens before, during and after an X-ray, and what the risks are.",
46+
"linkRelationship": "Result",
47+
"@type": "LinkRole",
48+
"articleStatus": "published",
49+
"mainEntityOfPage": {
50+
"@type": "MedicalWebPage",
51+
"genre": [
52+
"Test"
53+
],
54+
"datePublished": "2017-10-18T14:30:01+00:00",
55+
"dateModified": "2025-03-26T15:23:06+00:00",
56+
"lastReviewed": [
57+
"2022-04-20T00:00:00+00:00",
58+
"2025-04-20T00:00:00+00:00"
59+
],
60+
"reviewDue": "2025-04-20T00:00:00+00:00",
61+
"keywords": "",
62+
"code": [
63+
{
64+
"@type": "MedicalCode",
65+
"codeValue": "",
66+
"codingSystem": "SNOMED-CT"
67+
}
68+
]
69+
},
70+
"url": "https://www.nhs.uk/conditions/x-ray/",
71+
"name": "X-ray"
72+
},
73+
{
74+
"description": "Find out about abdominal aortic aneurysm (AAA) screening, including who it's offered to, why it's done and what happens.",
75+
"linkRelationship": "Result",
76+
"@type": "LinkRole",
77+
"articleStatus": "published",
78+
"mainEntityOfPage": {
79+
"@type": "MedicalWebPage",
80+
"genre": [
81+
"Test"
82+
],
83+
"datePublished": "2017-10-20T10:36:32+00:00",
84+
"dateModified": "2025-03-26T15:28:47+00:00",
85+
"lastReviewed": [
86+
"2024-11-11T01:00:00+00:00",
87+
"2027-11-11T01:00:00+00:00"
88+
],
89+
"reviewDue": "2027-11-11T01:00:00+00:00",
90+
"keywords": "",
91+
"alternateName": [
92+
"AAA screening"
93+
],
94+
"code": [
95+
{
96+
"@type": "MedicalCode",
97+
"codeValue": "",
98+
"codingSystem": "SNOMED-CT"
99+
}
100+
]
101+
},
102+
"url": "https://www.nhs.uk/conditions/abdominal-aortic-aneurysm-screening/",
103+
"name": "Abdominal aortic aneurysm (AAA) screening"
104+
}
105+
],
106+
"relatedLink": [
107+
{
108+
"@type": "LinkRole",
109+
"url": "https://www.nhs.uk/tests-and-treatments/?page=1",
110+
"name": "First Page",
111+
"description": "Link to First Page",
112+
"linkRelationship": "Pagination"
113+
},
114+
{
115+
"@type": "LinkRole",
116+
"url": "https://www.nhs.uk/tests-and-treatments/?page=1",
117+
"name": "Last Page",
118+
"description": "Link to Last Page",
119+
"linkRelationship": "Pagination"
120+
},
121+
{
122+
"@type": "LinkRole",
123+
"url": "https://www.nhs.uk/tests-and-treatments/",
124+
"name": "Self",
125+
"description": "Link to nhs.uk Page",
126+
"linkRelationship": "Self"
127+
}
128+
]
129+
}

0 commit comments

Comments
 (0)