-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.xsd
335 lines (296 loc) · 15.8 KB
/
schema.xsd
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- -->
<!-- Document structure -->
<!-- -->
<xs:element name="searchResult">
<xs:complexType>
<xs:sequence>
<!-- The servers involved in the request. -->
<xs:element name="servers">
<xs:complexType>
<xs:sequence>
<!-- The API layer endpoint behind service.findologic.com processing the request. -->
<xs:element name="frontend" type="server"/>
<!-- The search server handling the request. -->
<xs:element name="backend" type="server"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- The parameters controlling the search result. -->
<xs:element name="query">
<xs:complexType>
<xs:sequence>
<!-- Pagination settings. -->
<xs:element name="limit">
<xs:complexType>
<xs:attribute name="first" type="xs:nonNegativeInteger" use="required"/>
<!-- Product count - May be 0 for an initial navigation request. -->
<xs:attribute name="count" type="xs:nonNegativeInteger" use="required"/>
</xs:complexType>
</xs:element>
<!-- The user query or alternative queries determined by SDYM. -->
<xs:element name="queryString">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="type">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="corrected"/>
<xs:enumeration value="improved"/>
<xs:enumeration value="forced"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<!-- Returned in case the user query is overridden by SDYM. -->
<xs:element name="originalQuery" minOccurs="0">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="allow-override" type="xs:int"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<!-- Alternative query suggested by SDYM. -->
<xs:element name="didYouMeanQuery" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- URL to a landingpage, in case the query matches a configured one. -->
<xs:element name="landingPage" minOccurs="0">
<xs:complexType>
<xs:attribute name="link" type="urlOrPath"/>
</xs:complexType>
</xs:element>
<!-- URL of a promotion and its image, in case the query matches a configured one. -->
<xs:element name="promotion" minOccurs="0">
<xs:complexType>
<xs:attribute name="link" type="urlOrPath"/>
<xs:attribute name="image" type="xs:anyURI"/>
</xs:complexType>
</xs:element>
<!-- Result metadata. -->
<xs:element name="results">
<xs:complexType>
<xs:sequence>
<!-- Number of found products with the effective query. -->
<xs:element name="count" type="xs:nonNegativeInteger"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- The products matching the query. -->
<xs:element name="products">
<xs:complexType>
<xs:sequence>
<xs:element name="product" type="product" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- Filters to constrain the search results. -->
<xs:element name="filters">
<xs:complexType>
<xs:sequence>
<!-- Filters are separated between main and other. The former should be displayed
prominently, while the latter can be a little hidden and require user interaction to
see the available values. -->
<xs:element name="main">
<xs:complexType>
<xs:sequence>
<xs:element name="filter" type="filter" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="other">
<xs:complexType>
<xs:sequence>
<xs:element name="filter" type="filter" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- -->
<!-- Type definitions -->
<!-- -->
<xs:simpleType name="server">
<xs:restriction base="xs:string">
<xs:pattern value="[a-z0-9.]+"/>
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="urlOrPath">
<xs:restriction base="xs:string">
<xs:pattern value="(https?://|/).*"/>
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="product">
<xs:sequence>
<!-- Properties are only returned if requested via query parameter. -->
<xs:element name="properties" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="property" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="name" type="xs:string" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="id" type="xs:string" use="required"/>
<xs:attribute name="relevance" type="xs:decimal" use="required"/>
</xs:complexType>
<!-- Range slider filters. Filters "min"/"max" may not have any values if there is nothing to filter. -->
<xs:complexType name="range">
<xs:sequence>
<xs:element name="min" type="rangeFilter" />
<xs:element name="max" type="rangeFilter" />
</xs:sequence>
</xs:complexType>
<xs:simpleType name="rangeFilter">
<xs:union>
<xs:simpleType>
<xs:restriction base='xs:string'>
<xs:length value='0'/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType>
<xs:restriction base='xs:decimal'>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>
<xs:complexType name="filter">
<xs:sequence>
<!-- Optional itemCount until a "show more filters" link should appear, only relevant for type "select". -->
<xs:element name="itemCount" type="xs:int" minOccurs="0" />
<!-- Optional CSS class from filter config. -->
<xs:element name="cssClass" type="xs:string" minOccurs="0" />
<!-- Optional text from filter config to show when no filter values are available. -->
<xs:element name="noAvailableFiltersText" type="xs:string" minOccurs="0" />
<!-- Internal name of the filter, as exported. -->
<xs:element name="name">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<!-- Display name of the filter from filter config. -->
<xs:element name="display" type="xs:string"/>
<!-- Whether only one or multiple filter values can be selected at once. -->
<xs:element name="select">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="single"/>
<xs:enumeration value="multiple"/>
<xs:enumeration value="multiselect"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<!-- For multiselect filters, the number of currently selected filter values. -->
<xs:element name="selectedItems" type="xs:nonNegativeInteger" minOccurs="0"/>
<!-- The type of filter visualization to use. -->
<xs:element name="type">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="label"/>
<xs:enumeration value="select"/>
<xs:enumeration value="range-slider"/>
<xs:enumeration value="color"/>
<xs:enumeration value="image"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<!-- For range slider filters, the attributes of the range. -->
<xs:element name="attributes" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="selectedRange" type="range"/>
<xs:element name="totalRange" type="range"/>
<xs:element name="stepSize" type="xs:decimal"/>
<xs:element name="unit" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- Available filter values. -->
<xs:element name="items">
<xs:complexType>
<xs:sequence>
<xs:element name="item" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="weight" type="xs:decimal" minOccurs="0"/>
<!-- For filters other than range filters. -->
<xs:element name="frequency" minOccurs="0">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:nonNegativeInteger">
<xs:attribute name="type" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="absolute" />
<xs:enumeration value="additive" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<!-- Category filters may have subfilters -->
<xs:element name="items" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="item" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- Image filter URL. -->
<xs:element name="image" type="xs:anyURI" minOccurs="0" />
<!-- Color code for color filters -->
<xs:element name="color" minOccurs="0" />
<!-- For range filters only. -->
<xs:element name="parameters" type="range" minOccurs="0" />
</xs:sequence>
<!-- If a filter was selected it automatically gets this attribute. This works for -->
<!-- all filters except for range-sliders since those are handled differently. -->
<xs:attribute name="selected" type="xs:boolean" />
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- Color code for color filters -->
<xs:element name="color" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<!-- Matches color codes such as #FFF, #AAAAAA or #ddCcdD -->
<xs:pattern value="^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<!-- Image filter URL. -->
<xs:element name="image" type="xs:anyURI" minOccurs="0"/>
<!-- For range filters only. -->
<xs:element name="parameters" type="range" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>