Skip to content

Commit 7793799

Browse files
susnuxsusnux
committed
docs: update openAPI extracted files
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
1 parent 477c990 commit 7793799

15 files changed

Lines changed: 319 additions & 55 deletions

File tree

‎apps/dav/openapi.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,8 @@
399399
"description": "location/URL to filter by",
400400
"schema": {
401401
"type": "string",
402-
"nullable": true
402+
"nullable": true,
403+
"default": null
403404
}
404405
},
405406
{

‎apps/federatedfilesharing/openapi.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,47 +158,56 @@
158158
"remote": {
159159
"type": "string",
160160
"nullable": true,
161+
"default": null,
161162
"description": "Address of the remote"
162163
},
163164
"token": {
164165
"type": "string",
165166
"nullable": true,
167+
"default": null,
166168
"description": "Shared secret between servers"
167169
},
168170
"name": {
169171
"type": "string",
170172
"nullable": true,
173+
"default": null,
171174
"description": "Name of the shared resource"
172175
},
173176
"owner": {
174177
"type": "string",
175178
"nullable": true,
179+
"default": null,
176180
"description": "Display name of the receiver"
177181
},
178182
"sharedBy": {
179183
"type": "string",
180184
"nullable": true,
185+
"default": null,
181186
"description": "Display name of the sender"
182187
},
183188
"shareWith": {
184189
"type": "string",
185190
"nullable": true,
191+
"default": null,
186192
"description": "ID of the user that receives the share"
187193
},
188194
"remoteId": {
189195
"type": "integer",
190196
"format": "int64",
191197
"nullable": true,
198+
"default": null,
192199
"description": "ID of the remote"
193200
},
194201
"sharedByFederatedId": {
195202
"type": "string",
196203
"nullable": true,
204+
"default": null,
197205
"description": "Federated ID of the sender"
198206
},
199207
"ownerFederatedId": {
200208
"type": "string",
201209
"nullable": true,
210+
"default": null,
202211
"description": "Federated ID of the receiver"
203212
}
204213
}
@@ -276,11 +285,13 @@
276285
"token": {
277286
"type": "string",
278287
"nullable": true,
288+
"default": null,
279289
"description": "Shared secret between servers"
280290
},
281291
"shareWith": {
282292
"type": "string",
283293
"nullable": true,
294+
"default": null,
284295
"description": "ID of the user that receives the share"
285296
},
286297
"remoteId": {
@@ -417,12 +428,14 @@
417428
"token": {
418429
"type": "string",
419430
"nullable": true,
431+
"default": null,
420432
"description": "Shared secret between servers"
421433
},
422434
"permissions": {
423435
"type": "integer",
424436
"format": "int64",
425437
"nullable": true,
438+
"default": null,
426439
"description": "New permissions"
427440
}
428441
}
@@ -538,6 +551,7 @@
538551
"token": {
539552
"type": "string",
540553
"nullable": true,
554+
"default": null,
541555
"description": "Shared secret between servers"
542556
}
543557
}
@@ -635,6 +649,7 @@
635649
"token": {
636650
"type": "string",
637651
"nullable": true,
652+
"default": null,
638653
"description": "Shared secret between servers"
639654
}
640655
}
@@ -722,6 +737,7 @@
722737
"token": {
723738
"type": "string",
724739
"nullable": true,
740+
"default": null,
725741
"description": "Shared secret between servers"
726742
}
727743
}
@@ -809,6 +825,7 @@
809825
"token": {
810826
"type": "string",
811827
"nullable": true,
828+
"default": null,
812829
"description": "Shared secret between servers"
813830
}
814831
}
@@ -924,16 +941,19 @@
924941
"token": {
925942
"type": "string",
926943
"nullable": true,
944+
"default": null,
927945
"description": "Shared secret between servers"
928946
},
929947
"remote": {
930948
"type": "string",
931949
"nullable": true,
950+
"default": null,
932951
"description": "Address of the remote"
933952
},
934953
"remote_id": {
935954
"type": "string",
936955
"nullable": true,
956+
"default": null,
937957
"description": "ID of the remote"
938958
}
939959
}

‎apps/files/openapi.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -847,12 +847,14 @@
847847
"editorId": {
848848
"type": "string",
849849
"nullable": true,
850+
"default": null,
850851
"description": "ID of the editor"
851852
},
852853
"fileId": {
853854
"type": "integer",
854855
"format": "int64",
855856
"nullable": true,
857+
"default": null,
856858
"description": "ID of the file"
857859
}
858860
}
@@ -1032,6 +1034,7 @@
10321034
"templateId": {
10331035
"type": "string",
10341036
"nullable": true,
1037+
"default": null,
10351038
"description": "ID of the template"
10361039
}
10371040
}
@@ -2366,6 +2369,7 @@
23662369
"destination": {
23672370
"type": "string",
23682371
"nullable": true,
2372+
"default": null,
23692373
"description": "The target path of the converted file. Written to a temporary file if left empty"
23702374
}
23712375
}

‎apps/files_sharing/openapi.json‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1490,6 +1490,13 @@
14901490
1
14911491
]
14921492
}
1493+
},
1494+
{
1495+
"name": "X-NC-Preview",
1496+
"in": "header",
1497+
"schema": {
1498+
"type": "string"
1499+
}
14931500
}
14941501
],
14951502
"responses": {
@@ -1574,11 +1581,13 @@
15741581
"password": {
15751582
"type": "string",
15761583
"nullable": true,
1584+
"default": null,
15771585
"description": "Password of the share"
15781586
},
15791587
"dir": {
15801588
"type": "string",
15811589
"nullable": true,
1590+
"default": null,
15821591
"description": "Subdirectory to get info about"
15831592
},
15841593
"depth": {
@@ -1782,12 +1791,14 @@
17821791
"path": {
17831792
"type": "string",
17841793
"nullable": true,
1794+
"default": null,
17851795
"description": "Path of the share"
17861796
},
17871797
"permissions": {
17881798
"type": "integer",
17891799
"format": "int64",
17901800
"nullable": true,
1801+
"default": null,
17911802
"description": "Permissions for the share"
17921803
},
17931804
"shareType": {
@@ -1799,11 +1810,13 @@
17991810
"shareWith": {
18001811
"type": "string",
18011812
"nullable": true,
1813+
"default": null,
18021814
"description": "The entity this should be shared with"
18031815
},
18041816
"publicUpload": {
18051817
"type": "string",
18061818
"nullable": true,
1819+
"default": null,
18071820
"enum": [
18081821
"true",
18091822
"false"
@@ -1818,11 +1831,13 @@
18181831
"sendPasswordByTalk": {
18191832
"type": "string",
18201833
"nullable": true,
1834+
"default": null,
18211835
"description": "Send the password for the share over Talk"
18221836
},
18231837
"expireDate": {
18241838
"type": "string",
18251839
"nullable": true,
1840+
"default": null,
18261841
"description": "The expiry date of the share in the user's timezone at 00:00. If $expireDate is not supplied or set to `null`, the system default will be used."
18271842
},
18281843
"note": {
@@ -1838,11 +1853,13 @@
18381853
"attributes": {
18391854
"type": "string",
18401855
"nullable": true,
1856+
"default": null,
18411857
"description": "Additional attributes for the share"
18421858
},
18431859
"sendMail": {
18441860
"type": "string",
18451861
"nullable": true,
1862+
"default": null,
18461863
"enum": [
18471864
"false",
18481865
"true"
@@ -2297,56 +2314,67 @@
22972314
"type": "integer",
22982315
"format": "int64",
22992316
"nullable": true,
2317+
"default": null,
23002318
"description": "New permissions"
23012319
},
23022320
"password": {
23032321
"type": "string",
23042322
"nullable": true,
2323+
"default": null,
23052324
"description": "New password"
23062325
},
23072326
"sendPasswordByTalk": {
23082327
"type": "string",
23092328
"nullable": true,
2329+
"default": null,
23102330
"description": "New condition if the password should be send over Talk"
23112331
},
23122332
"publicUpload": {
23132333
"type": "string",
23142334
"nullable": true,
2335+
"default": null,
23152336
"description": "New condition if public uploading is allowed"
23162337
},
23172338
"expireDate": {
23182339
"type": "string",
23192340
"nullable": true,
2341+
"default": null,
23202342
"description": "New expiry date"
23212343
},
23222344
"note": {
23232345
"type": "string",
23242346
"nullable": true,
2347+
"default": null,
23252348
"description": "New note"
23262349
},
23272350
"label": {
23282351
"type": "string",
23292352
"nullable": true,
2353+
"default": null,
23302354
"description": "New label"
23312355
},
23322356
"hideDownload": {
23332357
"type": "string",
23342358
"nullable": true,
2359+
"default": null,
23352360
"description": "New condition if the download should be hidden"
23362361
},
23372362
"attributes": {
23382363
"type": "string",
23392364
"nullable": true,
2365+
"default": null,
23402366
"description": "New additional attributes"
23412367
},
23422368
"sendMail": {
23432369
"type": "string",
23442370
"nullable": true,
2371+
"default": null,
23452372
"description": "if the share should be send by mail. Considering the share already exists, no mail will be send after the share is updated. You will have to use the sendMail action to send the mail."
23462373
},
23472374
"token": {
23482375
"type": "string",
23492376
"nullable": true,
2377+
"default": null,
23502378
"description": "New token"
23512379
}
23522380
}
@@ -3099,7 +3127,8 @@
30993127
"description": "Limit to specific item types",
31003128
"schema": {
31013129
"type": "string",
3102-
"nullable": true
3130+
"nullable": true,
3131+
"default": null
31033132
}
31043133
},
31053134
{
@@ -3128,6 +3157,7 @@
31283157
"description": "Limit to specific share types",
31293158
"schema": {
31303159
"nullable": true,
3160+
"default": null,
31313161
"oneOf": [
31323162
{
31333163
"type": "integer",
@@ -3267,6 +3297,7 @@
32673297
"description": "Limit to specific share types",
32683298
"schema": {
32693299
"nullable": true,
3300+
"default": null,
32703301
"oneOf": [
32713302
{
32723303
"type": "integer",

‎apps/provisioning_api/openapi-administration.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,8 @@
381381
"description": "Filter for enabled or disabled apps",
382382
"schema": {
383383
"type": "string",
384-
"nullable": true
384+
"nullable": true,
385+
"default": null
385386
}
386387
},
387388
{
@@ -1003,7 +1004,8 @@
10031004
"schema": {
10041005
"type": "integer",
10051006
"format": "int64",
1006-
"nullable": true
1007+
"nullable": true,
1008+
"default": null
10071009
}
10081010
},
10091011
{

0 commit comments

Comments
 (0)