@itentialopensource/adapter-sharepoint 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
@@ -0,0 +1,619 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "Sharepoint",
5
+ "contact": {},
6
+ "version": "1.0"
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "https://{site_url}/_api/web",
11
+ "variables": {
12
+ "site_url": {
13
+ "default": "DefaultParameterValue"
14
+ }
15
+ }
16
+ }
17
+ ],
18
+ "paths": {
19
+ "/lists/{title}": {
20
+ "get": {
21
+ "tags": [
22
+ "Lists"
23
+ ],
24
+ "summary": "getListByTitle",
25
+ "operationId": "getListByTitle",
26
+ "parameters": [
27
+ {
28
+ "name": "title",
29
+ "in": "path",
30
+ "description": "",
31
+ "required": true,
32
+ "style": "simple",
33
+ "schema": {
34
+ "type": "string",
35
+ "example": "null"
36
+ }
37
+ }
38
+ ],
39
+ "responses": {
40
+ "200": {
41
+ "description": "",
42
+ "headers": {}
43
+ }
44
+ },
45
+ "deprecated": false
46
+ }
47
+ },
48
+ "/{guid}": {
49
+ "get": {
50
+ "tags": [
51
+ "Lists"
52
+ ],
53
+ "summary": "getListByGuid",
54
+ "operationId": "getListByGuid",
55
+ "parameters": [
56
+ {
57
+ "name": "guid",
58
+ "in": "path",
59
+ "description": "",
60
+ "required": true,
61
+ "style": "simple",
62
+ "schema": {
63
+ "type": "string",
64
+ "example": "null"
65
+ }
66
+ }
67
+ ],
68
+ "responses": {
69
+ "200": {
70
+ "description": "",
71
+ "headers": {}
72
+ }
73
+ },
74
+ "deprecated": false
75
+ },
76
+ "post": {
77
+ "tags": [
78
+ "Lists"
79
+ ],
80
+ "summary": "updateList",
81
+ "operationId": "updateList",
82
+ "parameters": [
83
+ {
84
+ "name": "guid",
85
+ "in": "path",
86
+ "description": "",
87
+ "required": true,
88
+ "style": "simple",
89
+ "schema": {
90
+ "type": "string",
91
+ "example": "null"
92
+ }
93
+ }
94
+ ],
95
+ "requestBody": {
96
+ "description": "",
97
+ "content": {
98
+ "application/json": {
99
+ "schema": {
100
+ "allOf": [
101
+ {
102
+ "$ref": "#/components/schemas/updateListRequest"
103
+ },
104
+ {
105
+ "example": {
106
+ "__metadata": {
107
+ "type": "SP.List"
108
+ },
109
+ "Title": "New title"
110
+ }
111
+ }
112
+ ]
113
+ },
114
+ "example": {
115
+ "__metadata": {
116
+ "type": "SP.List"
117
+ },
118
+ "Title": "New title"
119
+ }
120
+ }
121
+ },
122
+ "required": true
123
+ },
124
+ "responses": {
125
+ "200": {
126
+ "description": "",
127
+ "headers": {}
128
+ }
129
+ },
130
+ "deprecated": false
131
+ }
132
+ },
133
+ "/lists": {
134
+ "post": {
135
+ "tags": [
136
+ "Lists"
137
+ ],
138
+ "summary": "createList",
139
+ "operationId": "createList",
140
+ "parameters": [],
141
+ "requestBody": {
142
+ "description": "",
143
+ "content": {
144
+ "application/json": {
145
+ "schema": {
146
+ "allOf": [
147
+ {
148
+ "$ref": "#/components/schemas/createListRequest"
149
+ },
150
+ {
151
+ "example": {
152
+ "__metadata": {
153
+ "type": "SP.List"
154
+ },
155
+ "AllowContentTypes": true,
156
+ "BaseTemplate": 100,
157
+ "ContentTypesEnabled": true,
158
+ "Description": "My list description",
159
+ "Title": "Test"
160
+ }
161
+ }
162
+ ]
163
+ },
164
+ "example": {
165
+ "__metadata": {
166
+ "type": "SP.List"
167
+ },
168
+ "AllowContentTypes": true,
169
+ "BaseTemplate": 100,
170
+ "ContentTypesEnabled": true,
171
+ "Description": "My list description",
172
+ "Title": "Test"
173
+ }
174
+ }
175
+ },
176
+ "required": true
177
+ },
178
+ "responses": {
179
+ "200": {
180
+ "description": "",
181
+ "headers": {}
182
+ }
183
+ },
184
+ "deprecated": false
185
+ }
186
+ },
187
+ "/{relativeUrl}": {
188
+ "get": {
189
+ "tags": [
190
+ "Folders"
191
+ ],
192
+ "summary": "getFolderByServerRelativeUrl",
193
+ "operationId": "getFolderByServerRelativeUrl",
194
+ "parameters": [
195
+ {
196
+ "name": "relativeUrl",
197
+ "in": "path",
198
+ "description": "",
199
+ "required": true,
200
+ "style": "simple",
201
+ "schema": {
202
+ "type": "string",
203
+ "example": "null"
204
+ }
205
+ }
206
+ ],
207
+ "responses": {
208
+ "200": {
209
+ "description": "",
210
+ "headers": {}
211
+ }
212
+ },
213
+ "deprecated": false
214
+ },
215
+ "post": {
216
+ "tags": [
217
+ "Folders"
218
+ ],
219
+ "summary": "deleteFolder",
220
+ "operationId": "deleteFolder",
221
+ "parameters": [
222
+ {
223
+ "name": "relativeUrl",
224
+ "in": "path",
225
+ "description": "",
226
+ "required": true,
227
+ "style": "simple",
228
+ "schema": {
229
+ "type": "string",
230
+ "example": "null"
231
+ }
232
+ }
233
+ ],
234
+ "responses": {
235
+ "200": {
236
+ "description": "",
237
+ "headers": {}
238
+ }
239
+ },
240
+ "deprecated": false
241
+ }
242
+ },
243
+ "/folders": {
244
+ "post": {
245
+ "tags": [
246
+ "Folders"
247
+ ],
248
+ "summary": "createFolder",
249
+ "operationId": "createFolder",
250
+ "parameters": [],
251
+ "requestBody": {
252
+ "description": "",
253
+ "content": {
254
+ "application/json": {
255
+ "schema": {
256
+ "allOf": [
257
+ {
258
+ "$ref": "#/components/schemas/createFolderRequest"
259
+ },
260
+ {
261
+ "example": {
262
+ "__metadata": {
263
+ "type": "SP.Folder"
264
+ },
265
+ "ServerRelativeUrl": "/document library relative url/folder name"
266
+ }
267
+ }
268
+ ]
269
+ },
270
+ "example": {
271
+ "__metadata": {
272
+ "type": "SP.Folder"
273
+ },
274
+ "ServerRelativeUrl": "/document library relative url/folder name"
275
+ }
276
+ }
277
+ },
278
+ "required": true
279
+ },
280
+ "responses": {
281
+ "200": {
282
+ "description": "",
283
+ "headers": {}
284
+ }
285
+ },
286
+ "deprecated": false
287
+ }
288
+ },
289
+ "/{relativeUrl}/ListItemAllFields": {
290
+ "get": {
291
+ "tags": [
292
+ "Folders"
293
+ ],
294
+ "summary": "getFolderODataType",
295
+ "operationId": "getFolderODataType",
296
+ "parameters": [
297
+ {
298
+ "name": "relativeUrl",
299
+ "in": "path",
300
+ "description": "",
301
+ "required": true,
302
+ "style": "simple",
303
+ "schema": {
304
+ "type": "string",
305
+ "example": "null"
306
+ }
307
+ }
308
+ ],
309
+ "responses": {
310
+ "200": {
311
+ "description": "",
312
+ "headers": {}
313
+ }
314
+ },
315
+ "deprecated": false
316
+ },
317
+ "post": {
318
+ "tags": [
319
+ "Folders"
320
+ ],
321
+ "summary": "renameFolder",
322
+ "operationId": "renameFolder",
323
+ "parameters": [
324
+ {
325
+ "name": "relativeUrl",
326
+ "in": "path",
327
+ "description": "",
328
+ "required": true,
329
+ "style": "simple",
330
+ "schema": {
331
+ "type": "string",
332
+ "example": "null"
333
+ }
334
+ }
335
+ ],
336
+ "requestBody": {
337
+ "description": "",
338
+ "content": {
339
+ "application/json": {
340
+ "schema": {
341
+ "allOf": [
342
+ {
343
+ "$ref": "#/components/schemas/renameFolderRequest"
344
+ },
345
+ {
346
+ "example": {
347
+ "__metadata": {
348
+ "type": "{odata.type from previous call}"
349
+ },
350
+ "Title": "New name",
351
+ "FileLeafRef": "New name"
352
+ }
353
+ }
354
+ ]
355
+ },
356
+ "example": {
357
+ "__metadata": {
358
+ "type": "{odata.type from previous call}"
359
+ },
360
+ "Title": "New name",
361
+ "FileLeafRef": "New name"
362
+ }
363
+ }
364
+ },
365
+ "required": true
366
+ },
367
+ "responses": {
368
+ "200": {
369
+ "description": "",
370
+ "headers": {}
371
+ }
372
+ },
373
+ "deprecated": false
374
+ }
375
+ },
376
+ "/{relativeUrl}/Files": {
377
+ "get": {
378
+ "tags": [
379
+ "Files"
380
+ ],
381
+ "summary": "getFilesByFolder",
382
+ "operationId": "getFilesByFolder",
383
+ "parameters": [
384
+ {
385
+ "name": "relativeUrl",
386
+ "in": "path",
387
+ "description": "",
388
+ "required": true,
389
+ "style": "simple",
390
+ "schema": {
391
+ "type": "string",
392
+ "example": "null"
393
+ }
394
+ }
395
+ ],
396
+ "responses": {
397
+ "200": {
398
+ "description": "",
399
+ "headers": {}
400
+ }
401
+ },
402
+ "deprecated": false
403
+ }
404
+ },
405
+ "/{relativeUrl}/{fileName}/$value": {
406
+ "get": {
407
+ "tags": [
408
+ "Files"
409
+ ],
410
+ "summary": "getFile",
411
+ "operationId": "getFile",
412
+ "parameters": [
413
+ {
414
+ "name": "relativeUrl",
415
+ "in": "path",
416
+ "description": "",
417
+ "required": true,
418
+ "style": "simple",
419
+ "schema": {
420
+ "type": "string",
421
+ "example": "null"
422
+ }
423
+ },
424
+ {
425
+ "name": "fileName",
426
+ "in": "path",
427
+ "description": "",
428
+ "required": true,
429
+ "style": "simple",
430
+ "schema": {
431
+ "type": "string",
432
+ "example": "null"
433
+ }
434
+ }
435
+ ],
436
+ "responses": {
437
+ "200": {
438
+ "description": "",
439
+ "headers": {}
440
+ }
441
+ },
442
+ "deprecated": false
443
+ }
444
+ },
445
+ "/{relativeUrl}/$value": {
446
+ "get": {
447
+ "tags": [
448
+ "Files"
449
+ ],
450
+ "summary": "getFileByFileUrl",
451
+ "operationId": "getFileByFileUrl",
452
+ "parameters": [
453
+ {
454
+ "name": "relativeUrl",
455
+ "in": "path",
456
+ "description": "",
457
+ "required": true,
458
+ "style": "simple",
459
+ "schema": {
460
+ "type": "string",
461
+ "example": "null"
462
+ }
463
+ }
464
+ ],
465
+ "responses": {
466
+ "200": {
467
+ "description": "",
468
+ "headers": {}
469
+ }
470
+ },
471
+ "deprecated": false
472
+ }
473
+ }
474
+ },
475
+ "components": {
476
+ "schemas": {
477
+ "createListRequest": {
478
+ "title": "createListRequest",
479
+ "required": [
480
+ "__metadata",
481
+ "AllowContentTypes",
482
+ "BaseTemplate",
483
+ "ContentTypesEnabled",
484
+ "Description",
485
+ "Title"
486
+ ],
487
+ "type": "object",
488
+ "properties": {
489
+ "__metadata": {
490
+ "$ref": "#/components/schemas/Metadata"
491
+ },
492
+ "AllowContentTypes": {
493
+ "type": "boolean"
494
+ },
495
+ "BaseTemplate": {
496
+ "type": "integer",
497
+ "format": "int32"
498
+ },
499
+ "ContentTypesEnabled": {
500
+ "type": "boolean"
501
+ },
502
+ "Description": {
503
+ "type": "string"
504
+ },
505
+ "Title": {
506
+ "type": "string"
507
+ }
508
+ },
509
+ "example": {
510
+ "__metadata": {
511
+ "type": "SP.List"
512
+ },
513
+ "AllowContentTypes": true,
514
+ "BaseTemplate": 100,
515
+ "ContentTypesEnabled": true,
516
+ "Description": "My list description",
517
+ "Title": "Test"
518
+ }
519
+ },
520
+ "Metadata": {
521
+ "title": "Metadata",
522
+ "required": [
523
+ "type"
524
+ ],
525
+ "type": "object",
526
+ "properties": {
527
+ "type": {
528
+ "type": "string"
529
+ }
530
+ },
531
+ "example": {
532
+ "type": "SP.List"
533
+ }
534
+ },
535
+ "updateListRequest": {
536
+ "title": "updateListRequest",
537
+ "required": [
538
+ "__metadata",
539
+ "Title"
540
+ ],
541
+ "type": "object",
542
+ "properties": {
543
+ "__metadata": {
544
+ "$ref": "#/components/schemas/Metadata"
545
+ },
546
+ "Title": {
547
+ "type": "string"
548
+ }
549
+ },
550
+ "example": {
551
+ "__metadata": {
552
+ "type": "SP.List"
553
+ },
554
+ "Title": "New title"
555
+ }
556
+ },
557
+ "createFolderRequest": {
558
+ "title": "createFolderRequest",
559
+ "required": [
560
+ "__metadata",
561
+ "ServerRelativeUrl"
562
+ ],
563
+ "type": "object",
564
+ "properties": {
565
+ "__metadata": {
566
+ "$ref": "#/components/schemas/Metadata"
567
+ },
568
+ "ServerRelativeUrl": {
569
+ "type": "string"
570
+ }
571
+ },
572
+ "example": {
573
+ "__metadata": {
574
+ "type": "SP.Folder"
575
+ },
576
+ "ServerRelativeUrl": "/document library relative url/folder name"
577
+ }
578
+ },
579
+ "renameFolderRequest": {
580
+ "title": "renameFolderRequest",
581
+ "required": [
582
+ "__metadata",
583
+ "Title",
584
+ "FileLeafRef"
585
+ ],
586
+ "type": "object",
587
+ "properties": {
588
+ "__metadata": {
589
+ "$ref": "#/components/schemas/Metadata"
590
+ },
591
+ "Title": {
592
+ "type": "string"
593
+ },
594
+ "FileLeafRef": {
595
+ "type": "string"
596
+ }
597
+ },
598
+ "example": {
599
+ "__metadata": {
600
+ "type": "{odata.type from previous call}"
601
+ },
602
+ "Title": "New name",
603
+ "FileLeafRef": "New name"
604
+ }
605
+ }
606
+ }
607
+ },
608
+ "tags": [
609
+ {
610
+ "name": "Lists"
611
+ },
612
+ {
613
+ "name": "Folders"
614
+ },
615
+ {
616
+ "name": "Files"
617
+ }
618
+ ]
619
+ }