-
Notifications
You must be signed in to change notification settings - Fork 16
/
schema.json
313 lines (313 loc) · 6.89 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"description",
"details",
"document_type",
"publishing_app",
"schema_name",
"title"
],
"additionalProperties": false,
"properties": {
"access_limited": {
"$ref": "#/definitions/access_limited"
},
"analytics_identifier": {
"$ref": "#/definitions/analytics_identifier"
},
"auth_bypass_ids": {
"description": "A list of ids that will allow access to this item for non-authenticated users",
"$ref": "#/definitions/guid_list"
},
"base_path": {
"type": "null"
},
"bulk_publishing": {
"type": "boolean"
},
"change_note": {
"type": [
"null",
"string"
]
},
"description": {
"$ref": "#/definitions/description"
},
"details": {
"$ref": "#/definitions/details"
},
"document_type": {
"type": "string",
"enum": [
"external_content"
]
},
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
"format": "date-time"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {}
},
"locale": {
"$ref": "#/definitions/locale"
},
"need_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"phase": {
"description": "The service design phase of this content item - https://www.gov.uk/service-manual/phases",
"type": "string",
"enum": [
"alpha",
"beta",
"live"
]
},
"previous_version": {
"type": "string"
},
"public_updated_at": {
"$ref": "#/definitions/public_updated_at"
},
"publishing_app": {
"$ref": "#/definitions/publishing_app_name"
},
"redirects": {
"type": "array",
"additionalItems": false,
"items": {}
},
"rendering_app": {
"type": "null"
},
"routes": {
"type": "array",
"additionalItems": false,
"items": {}
},
"schema_name": {
"type": "string",
"enum": [
"external_content"
]
},
"title": {
"$ref": "#/definitions/title"
},
"update_type": {
"$ref": "#/definitions/update_type"
}
},
"definitions": {
"description": {
"type": "string"
},
"access_limited": {
"type": "object",
"additionalProperties": false,
"properties": {
"auth_bypass_ids": {
"description": "Deprecated: auth_bypass_ids should be sent as a separate field",
"$ref": "#/definitions/guid_list"
},
"organisations": {
"description": "A list of organisation content ids permitted access to this item",
"$ref": "#/definitions/guid_list"
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"analytics_identifier": {
"description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"details": {
"type": "object",
"required": [
"url"
],
"additionalProperties": false,
"properties": {
"hidden_search_terms": {
"$ref": "#/definitions/hidden_search_terms"
},
"url": {
"description": "A URL for the external resource",
"type": "string",
"format": "uri"
}
}
},
"first_published_at": {
"description": "The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application.",
"type": "string",
"format": "date-time"
},
"guid": {
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
},
"guid_list": {
"type": "array",
"items": {
"$ref": "#/definitions/guid"
},
"uniqueItems": true
},
"hidden_search_terms": {
"description": "List of words/phrases the user can search for that aren't present on the page.",
"type": "array",
"items": {
"type": "string"
}
},
"locale": {
"type": "string",
"enum": [
"ar",
"az",
"be",
"bg",
"bn",
"cs",
"cy",
"da",
"de",
"dr",
"el",
"en",
"es",
"es-419",
"et",
"fa",
"fi",
"fr",
"gd",
"gu",
"he",
"hi",
"hr",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"ka",
"kk",
"ko",
"lt",
"lv",
"ms",
"mt",
"ne",
"nl",
"no",
"pa",
"pa-pk",
"pl",
"ps",
"pt",
"ro",
"ru",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"sv",
"sw",
"ta",
"th",
"tk",
"tr",
"uk",
"ur",
"uz",
"vi",
"yi",
"zh",
"zh-hk",
"zh-tw"
]
},
"public_updated_at": {
"description": "When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.",
"type": "string",
"format": "date-time"
},
"publishing_app_name": {
"description": "The application that published this item.",
"type": "string",
"enum": [
"account-api",
"calculators",
"calendars",
"collections-publisher",
"contacts",
"content-publisher",
"content-tagger",
"email-alert-frontend",
"external-link-tracker",
"feedback",
"frontend",
"government-frontend",
"hmrc-manuals-api",
"local-links-manager",
"manuals-publisher",
"maslow",
"performanceplatform-big-screen-view",
"publisher",
"rummager",
"search-admin",
"search-api",
"service-manual-publisher",
"share-sale-publisher",
"short-url-manager",
"smartanswers",
"special-route-publisher",
"specialist-publisher",
"static",
"tariff",
"travel-advice-publisher",
"whitehall"
]
},
"title": {
"type": "string"
},
"update_type": {
"enum": [
"major",
"minor",
"republish"
]
}
}
}