-
Notifications
You must be signed in to change notification settings - Fork 0
/
pageapi.yaml
351 lines (351 loc) · 8.35 KB
/
pageapi.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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
openapi: 3.0.3
info:
title: Page Delivery API
description: ''
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: '1.0'
servers:
- url: https://kenan.bloomreach.io
tags:
- name: page
description: Page Delivery API
paths:
/delivery/site/v1/channels/{channel_id}/pages/{path}:
get:
tags:
- page
summary: Get Page by path
operationId: getPage
parameters:
- name: path
in: path
required: true
schema:
type: string
format: path
- name: channel_id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Page'
'404':
description: Page not found
content: {}
components:
schemas:
Channel:
type: object
properties:
info:
type: object
properties:
props:
type: object
additionalProperties:
type: string
Link:
required:
- href
- type
type: object
properties:
href:
type: string
type:
type: string
Pointer:
type: object
properties:
$ref:
type: string
ComponentMeta:
type: object
properties:
params:
type: object
additionalProperties:
type: string
paramsInfo:
type: object
additionalProperties:
type: string
Element:
required:
- type
type: object
properties:
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
meta:
$ref: '#/components/schemas/ComponentMeta'
type:
type: string
enum:
- document
- component
- menu
- container
- container-item
- asset
- imageset
discriminator:
propertyName: type
mapping:
component: '#/components/schemas/Component'
container-item: '#/components/schemas/ContainerItem'
container: '#/components/schemas/Container'
document: '#/components/schemas/Document'
imageset: '#/components/schemas/Imageset'
menu: '#/components/schemas/Menu'
componentcontent: '#/components/schemas/ComponentContent'
pagination: '#/components/schemas/Pagination'
AbstractComponent:
type: object
properties:
id:
type: string
label:
type: string
name:
type: string
allOf:
- $ref: '#/components/schemas/Element'
Component:
type: object
properties:
children:
type: array
items:
$ref: '#/components/schemas/Pointer'
models:
type: object
additionalProperties:
$ref: '#/components/schemas/Pointer'
allOf:
- $ref: '#/components/schemas/AbstractComponent'
discriminator:
propertyName: type
PaginationPage:
type: object
properties:
number:
type: integer
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
Pagination:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Pointer'
offset:
type: integer
total:
type: integer
size:
type: integer
first:
$ref: '#/components/schemas/PaginationPage'
current:
$ref: '#/components/schemas/PaginationPage'
previous:
$ref: '#/components/schemas/PaginationPage'
next:
$ref: '#/components/schemas/PaginationPage'
last:
$ref: '#/components/schemas/PaginationPage'
pages:
type: array
items:
$ref: '#/components/schemas/PaginationPage'
enabled:
type: boolean
allOf:
- $ref: '#/components/schemas/Element'
discriminator:
propertyName: type
Data:
type: object
properties:
data:
type: object
additionalProperties:
type: object
Document:
type: object
properties:
data:
$ref: '#/components/schemas/Data'
allOf:
- $ref: '#/components/schemas/Element'
discriminator:
propertyName: type
ComponentContent:
type: object
properties:
data:
$ref: '#/components/schemas/Data'
allOf:
- $ref: '#/components/schemas/Element'
discriminator:
propertyName: type
MenuItem:
type: object
properties:
depth:
type: integer
repositoryBased:
type: boolean
properties:
type: object
additionalProperties:
type: string
name:
type: string
childMenuItems:
type: array
items:
$ref: '#/components/schemas/MenuItem'
expanded:
type: boolean
selected:
type: boolean
parameters:
type: object
additionalProperties:
type: string
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
Menu:
type: object
properties:
data:
type: object
properties:
name:
type: string
siteMenuItems:
type: array
items:
$ref: '#/components/schemas/MenuItem'
additionalProperties:
type: object
allOf:
- $ref: '#/components/schemas/Element'
discriminator:
propertyName: type
Image:
type: object
properties:
width:
type: integer
height:
type: integer
lastModified:
type: integer
mimeType:
type: string
size:
type: integer
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
ImageData:
type: object
properties:
fileName:
type:
string
thumbnail:
$ref: '#/components/schemas/Image'
original:
$ref: '#/components/schemas/Image'
additionalProperties:
type: object
Imageset:
type: object
properties:
data:
$ref: '#/components/schemas/ImageData'
allOf:
- $ref: '#/components/schemas/Element'
discriminator:
propertyName: type
Container:
type: object
properties:
children:
type: array
items:
$ref: '#/components/schemas/Pointer'
xtype:
type: string
allOf:
- $ref: '#/components/schemas/AbstractComponent'
discriminator:
propertyName: type
ContainerItem:
type: object
properties:
ctype:
type: string
models:
type: object
additionalProperties:
$ref: '#/components/schemas/Pointer'
content:
$ref: '#/components/schemas/Pointer'
allOf:
- $ref: '#/components/schemas/AbstractComponent'
discriminator:
propertyName: type
PageMeta:
type: object
properties:
branch:
type: string
default: master
product:
type: string
default: brx
version:
type: string
default: '1.0'
Page:
type: object
properties:
meta:
$ref: '#/components/schemas/PageMeta'
channel:
$ref: '#/components/schemas/Channel'
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
root:
$ref: '#/components/schemas/Pointer'
document:
$ref: '#/components/schemas/Pointer'
page:
type: object
additionalProperties:
$ref: '#/components/schemas/Element'