-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
311 lines (311 loc) · 10.3 KB
/
openapi.yaml
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
openapi: 3.1.0
info:
title: Connect for Commerce Frontend API Server
description: This schema has to be implemented by any server functioning as the backend of the Frontend API in order for the client module to use it.
version: 1.0.0
paths:
/findPage:
get:
operationId: findPage
summary: Finds a page based on the given parameters.
parameters:
- name: id
description: ID of the page as defined in the mapping.
in: query
required: true
schema:
type: string
- name: type
description: Type of the page; either 'product', 'category' or 'content'.
in: query
required: true
schema:
type: string
- name: locale
description: Locale of the desired response.
in: query
required: false
schema:
type: string
- name: x-referrer
description: Provide url about the iframe parent
in: header
required: false
schema:
type: string
format: url
- name: ecom-share-token
description: Provide a token for ShareView
in: header
required: false
schema:
type: string
format: string
responses:
'200':
description: Response containing information about the requested page.
headers:
Access-Control-Expose-Headers:
description: Header to expose the `shared-preview` header.
schema:
type: string
shared-preview:
description: Header indicating shared preview information.
schema:
type: string
content:
application/json:
schema:
type: object
properties:
previewId:
type: string
example: befda52e-240a-4961-b167-80ea7bab00a8
children:
type: array
items:
type: object
properties:
name:
type: string
example: sup_content
previewId:
type: string
example: 57eaaa37-cdec-4c1a-8867-d3b860cec996
children:
type: array
items:
type: object
properties:
id:
type: string
example: 76d255f3-e65f-42ee-96b6-42ea00677b5e
previewId:
type: string
example: 792e9ece-b3cf-49b0-ba96-b8c03a2d4acb
type:
type: string
example: type
sectionType:
type: string
example: section_type
data:
type: object
children:
type: array
items:
type: object
displayed:
type: boolean
example: true
default:
description: ''
/findElement:
get:
operationId: findElement
summary: Finds an element based on the given parameters.
parameters:
- name: fsPageId
description: ID of the FirstSpirit page.
in: query
required: true
schema:
type: string
- name: locale
description: Locale of the desired response.
in: query
required: false
schema:
type: string
- name: x-referrer
description: Provide url about the iframe parent
in: header
required: false
schema:
type: string
format: url
- name: token
description: Provide a token for ShareView
in: header
required: false
schema:
type: string
format: string
responses:
'200':
description: Response containing information about the requested element.
headers:
Access-Control-Expose-Headers:
description: Header to expose the `shared-preview` header.
schema:
type: string
shared-preview:
description: Header indicating shared preview information.
schema:
type: string
content:
application/json:
schema:
type: object
properties:
previewId:
type: string
example: befda52e-240a-4961-b167-80ea7bab00a8
children:
type: array
items:
type: object
properties:
name:
type: string
example: sup_content
previewId:
type: string
example: 57eaaa37-cdec-4c1a-8867-d3b860cec996
children:
type: array
items:
type: object
properties:
id:
type: string
example: 76d255f3-e65f-42ee-96b6-42ea00677b5e
previewId:
type: string
example: 792e9ece-b3cf-49b0-ba96-b8c03a2d4acb
type:
type: string
example: type
sectionType:
type: string
example: section_type
data:
type: object
children:
type: array
items:
type: object
displayed:
type: boolean
example: true
default:
description: ''
/fetchNavigation:
get:
operationId: fetchNavigation
summary: Fetches the navigation based on the given parameters.
parameters:
- name: initialPath
description: Sub-path to search below.
in: query
required: false
schema:
type: string
- name: locale
description: Locale of the desired response.
in: query
required: false
schema:
type: string
- name: x-referrer
description: Provide url about the iframe parent
in: header
required: false
schema:
type: string
format: url
- name: token
description: Provide a token for ShareView
in: header
required: false
schema:
type: string
format: string
responses:
'200':
description: The requested navigation information.
headers:
Access-Control-Expose-Headers:
description: Header to expose the `shared-preview` header.
schema:
type: string
shared-preview:
description: Header indicating shared preview information.
schema:
type: string
content:
application/json:
schema:
type: object
properties:
idMap:
type: object
seoRouteMap:
type: object
structure:
type: array
items:
type: object
pages:
type: object
meta:
type: object
properties:
identifier:
type: object
properties:
tenantId:
type: string
example: 792e9ece-b3cf-49b0-ba96-b8c03a2d4acb
navigationId:
type: string
example: 792e9ece-b3cf-49b0-ba96-b8c03a2d4acb
languageId:
type: string
example: en_GB
default:
description: ''
/isPreview:
get:
operationId: isPreview
summary: Determines whether the requester is in preview mode.
parameters:
- name: x-referrer
description: Provide url about the iframe parent
in: header
required: false
schema:
type: string
format: url
- name: token
description: Provide a token for ShareView
in: header
required: false
schema:
type: string
format: string
responses:
'200':
description: Information about whether the requester is in preview mode.
headers:
Access-Control-Expose-Headers:
description: Header to expose the `shared-preview` header.
schema:
type: string
shared-preview:
description: Header indicating shared preview information.
schema:
type: string
content:
application/json:
schema:
type: object
properties:
isPreview:
type: boolean
example: true
isShareSession:
type: boolean
example: false
default:
description: ''