-
Notifications
You must be signed in to change notification settings - Fork 1
/
specification.yml
204 lines (202 loc) · 6.31 KB
/
specification.yml
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
asyncapi: 3.0.0
info:
title: dp-search-data-importer
version: 1.1.0
description: |-
The *dp-search-data-importer* processes search-data-import events and then
upserts the ElasticSearch index with them.
license:
name: MIT
url: https://opensource.org/license/MIT
defaultContentType: avro/binary
channels:
search-data-import:
messages:
search-data-import:
$ref: '#/components/messages/search-data-import'
description: This topic contains a message of processed search information, ready for import.
search-content-deleted:
messages:
search-content-deleted:
$ref: '#/components/messages/search-content-deleted'
description: This topic contains the information with which to delete an item from the search index
operations:
search-data-import:
action: receive
channel:
$ref: '#/channels/search-data-import'
summary: Receive data for import to ElasticSearch
messages:
- $ref: '#/channels/search-data-import/messages/search-data-import'
search-content-deleted:
action: receive
channel:
$ref: '#/channels/search-content-deleted'
summary: Delete item from index in ElasticSearch
messages:
- $ref: '#/channels/search-content-deleted/messages/search-content-deleted'
components:
messages:
search-data-import:
name: search-data-import
title: Item has been processed ready for search import
payload:
type: object
required:
- uid
- uri
- title
- search_index
properties:
uid:
type: string
description: Unique ID by which to index in search
uri:
type: string
description: URI of upstream content item
data_type:
type: string
description: Content type ID, used for aggregations
enum:
- api_dataset_landing_page
- article
- article_download
- bulletin
- compendium_chapter
- compendium_data
- compendium_landing_page
- dataset
- dataset_landing_page
- home_page
- home_page_census
- product_page
- reference_tables
- release
- static_adhoc
- static_article
- static_foi
- static_landing_page
- static_methodology
- static_methodology_download
- static_page
- static_qmi
- taxonomy_landing_page
- timeseries
- visualisation
job_id:
type: string
description: Job ID for use with reindex pipeline
search_index:
type: string
description: Specific search index ID for use with reindex pipeline
cdid:
type: string
description: CDID for content item, typically used with timeseries
dataset_id:
type: string
description: Dataset ID for content item
edition:
type: string
keywords:
type: array
items:
type: string
meta_description:
type: string
release_date:
type: string
format: date-time
description: Release date in an ISO 8601 format
example: "2026-02-12T07:00:00.000Z"
summary:
type: string
description: Summary text, typically used in search listings
title:
type: string
description: Title of the content item
topics:
type: array
description: Array of topic IDs taken from Topic API
items:
type: string
trace_id:
type: string
description: Trace ID for OTEL tracing
cancelled:
type: boolean
description: Shows if a release has been cancelled, only used with Release content type
finalised:
type: boolean
description: Shows if a release has been finalised, only used with Release content type
published:
type: boolean
description: Shows if a release has been published, only used with Release content type
tags:
- name: bum
description: hello there
language:
type: string
survey:
type: string
canonical_topic:
type: string
date_changes:
type: array
description: List of date changes, only used with Release content type
items:
type: object
properties:
change_notice:
type: string
previous_date:
type: string
provisional_date:
type: string
description: A provisional date string, only used with Release content type
example: October-November 2024
dimensions:
type: array
description: Array of dimensions, not currently used.
items:
type: object
properties:
key:
type: string
agg_key:
type: string
name:
type: string
label:
type: string
raw_label:
type: string
population_type:
type: array
description: Array of population types, not currently used.
items:
type: object
properties:
key:
type: string
agg_key:
type: string
name:
type: string
label:
type: string
search-content-deleted:
name: search-content-deleted
title: Content item has been deleted and should be removed from search
payload:
type: object
required:
- uri
properties:
uri:
type: string
description: URI of the upstream content item
format: uri
example: /economy/environmentalaccounts
trace_id:
type: string
description: Trace ID for OTEL tracing