Skip to content

Commit 5ddba78

Browse files
nickvergessennickvergessen
authored
Merge pull request #44216 from nextcloud/feat/core/openapi-capabilities
feat(core): Include core capabilities in OpenAPI
2 parents ede541b + f8ab422 commit 5ddba78

File tree

15 files changed

+1254
-245
lines changed

15 files changed

+1254
-245
lines changed

‎apps/dav/openapi.json‎

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -236,29 +236,83 @@
236236
"404": {
237237
"description": "File not found",
238238
"content": {
239-
"text/plain": {
239+
"application/json": {
240240
"schema": {
241-
"type": "string"
241+
"type": "object",
242+
"required": [
243+
"ocs"
244+
],
245+
"properties": {
246+
"ocs": {
247+
"type": "object",
248+
"required": [
249+
"meta",
250+
"data"
251+
],
252+
"properties": {
253+
"meta": {
254+
"$ref": "#/components/schemas/OCSMeta"
255+
},
256+
"data": {}
257+
}
258+
}
259+
}
242260
}
243261
}
244262
}
245263
},
246264
"400": {
247265
"description": "Getting direct link is not possible",
248266
"content": {
249-
"text/plain": {
267+
"application/json": {
250268
"schema": {
251-
"type": "string"
269+
"type": "object",
270+
"required": [
271+
"ocs"
272+
],
273+
"properties": {
274+
"ocs": {
275+
"type": "object",
276+
"required": [
277+
"meta",
278+
"data"
279+
],
280+
"properties": {
281+
"meta": {
282+
"$ref": "#/components/schemas/OCSMeta"
283+
},
284+
"data": {}
285+
}
286+
}
287+
}
252288
}
253289
}
254290
}
255291
},
256292
"403": {
257293
"description": "Missing permissions to get direct link",
258294
"content": {
259-
"text/plain": {
295+
"application/json": {
260296
"schema": {
261-
"type": "string"
297+
"type": "object",
298+
"required": [
299+
"ocs"
300+
],
301+
"properties": {
302+
"ocs": {
303+
"type": "object",
304+
"required": [
305+
"meta",
306+
"data"
307+
],
308+
"properties": {
309+
"meta": {
310+
"$ref": "#/components/schemas/OCSMeta"
311+
},
312+
"data": {}
313+
}
314+
}
315+
}
262316
}
263317
}
264318
}

‎apps/federatedfilesharing/openapi.json‎

Lines changed: 80 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -387,9 +387,27 @@
387387
"400": {
388388
"description": "Re-sharing is not possible",
389389
"content": {
390-
"text/plain": {
390+
"application/json": {
391391
"schema": {
392-
"type": "string"
392+
"type": "object",
393+
"required": [
394+
"ocs"
395+
],
396+
"properties": {
397+
"ocs": {
398+
"type": "object",
399+
"required": [
400+
"meta",
401+
"data"
402+
],
403+
"properties": {
404+
"meta": {
405+
"$ref": "#/components/schemas/OCSMeta"
406+
},
407+
"data": {}
408+
}
409+
}
410+
}
393411
}
394412
}
395413
}
@@ -486,9 +504,27 @@
486504
"400": {
487505
"description": "Updating permissions is not possible",
488506
"content": {
489-
"text/plain": {
507+
"application/json": {
490508
"schema": {
491-
"type": "string"
509+
"type": "object",
510+
"required": [
511+
"ocs"
512+
],
513+
"properties": {
514+
"ocs": {
515+
"type": "object",
516+
"required": [
517+
"meta",
518+
"data"
519+
],
520+
"properties": {
521+
"meta": {
522+
"$ref": "#/components/schemas/OCSMeta"
523+
},
524+
"data": {}
525+
}
526+
}
527+
}
492528
}
493529
}
494530
}
@@ -822,9 +858,27 @@
822858
"400": {
823859
"description": "Revoking the share is not possible",
824860
"content": {
825-
"text/plain": {
861+
"application/json": {
826862
"schema": {
827-
"type": "string"
863+
"type": "object",
864+
"required": [
865+
"ocs"
866+
],
867+
"properties": {
868+
"ocs": {
869+
"type": "object",
870+
"required": [
871+
"meta",
872+
"data"
873+
],
874+
"properties": {
875+
"meta": {
876+
"$ref": "#/components/schemas/OCSMeta"
877+
},
878+
"data": {}
879+
}
880+
}
881+
}
828882
}
829883
}
830884
}
@@ -943,9 +997,27 @@
943997
"400": {
944998
"description": "Moving share is not possible",
945999
"content": {
946-
"text/plain": {
1000+
"application/json": {
9471001
"schema": {
948-
"type": "string"
1002+
"type": "object",
1003+
"required": [
1004+
"ocs"
1005+
],
1006+
"properties": {
1007+
"ocs": {
1008+
"type": "object",
1009+
"required": [
1010+
"meta",
1011+
"data"
1012+
],
1013+
"properties": {
1014+
"meta": {
1015+
"$ref": "#/components/schemas/OCSMeta"
1016+
},
1017+
"data": {}
1018+
}
1019+
}
1020+
}
9491021
}
9501022
}
9511023
}

‎apps/federation/openapi.json‎

Lines changed: 80 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,27 @@
135135
"403": {
136136
"description": "Getting shared secret is not allowed",
137137
"content": {
138-
"text/plain": {
138+
"application/json": {
139139
"schema": {
140-
"type": "string"
140+
"type": "object",
141+
"required": [
142+
"ocs"
143+
],
144+
"properties": {
145+
"ocs": {
146+
"type": "object",
147+
"required": [
148+
"meta",
149+
"data"
150+
],
151+
"properties": {
152+
"meta": {
153+
"$ref": "#/components/schemas/OCSMeta"
154+
},
155+
"data": {}
156+
}
157+
}
158+
}
141159
}
142160
}
143161
}
@@ -223,9 +241,27 @@
223241
"403": {
224242
"description": "Requesting shared secret is not allowed",
225243
"content": {
226-
"text/plain": {
244+
"application/json": {
227245
"schema": {
228-
"type": "string"
246+
"type": "object",
247+
"required": [
248+
"ocs"
249+
],
250+
"properties": {
251+
"ocs": {
252+
"type": "object",
253+
"required": [
254+
"meta",
255+
"data"
256+
],
257+
"properties": {
258+
"meta": {
259+
"$ref": "#/components/schemas/OCSMeta"
260+
},
261+
"data": {}
262+
}
263+
}
264+
}
229265
}
230266
}
231267
}
@@ -321,9 +357,27 @@
321357
"403": {
322358
"description": "Getting shared secret is not allowed",
323359
"content": {
324-
"text/plain": {
360+
"application/json": {
325361
"schema": {
326-
"type": "string"
362+
"type": "object",
363+
"required": [
364+
"ocs"
365+
],
366+
"properties": {
367+
"ocs": {
368+
"type": "object",
369+
"required": [
370+
"meta",
371+
"data"
372+
],
373+
"properties": {
374+
"meta": {
375+
"$ref": "#/components/schemas/OCSMeta"
376+
},
377+
"data": {}
378+
}
379+
}
380+
}
327381
}
328382
}
329383
}
@@ -407,9 +461,27 @@
407461
"403": {
408462
"description": "Requesting shared secret is not allowed",
409463
"content": {
410-
"text/plain": {
464+
"application/json": {
411465
"schema": {
412-
"type": "string"
466+
"type": "object",
467+
"required": [
468+
"ocs"
469+
],
470+
"properties": {
471+
"ocs": {
472+
"type": "object",
473+
"required": [
474+
"meta",
475+
"data"
476+
],
477+
"properties": {
478+
"meta": {
479+
"$ref": "#/components/schemas/OCSMeta"
480+
},
481+
"data": {}
482+
}
483+
}
484+
}
413485
}
414486
}
415487
}

‎apps/files/openapi.json‎

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1084,9 +1084,27 @@
10841084
"403": {
10851085
"description": "Creating template is not allowed",
10861086
"content": {
1087-
"text/plain": {
1087+
"application/json": {
10881088
"schema": {
1089-
"type": "string"
1089+
"type": "object",
1090+
"required": [
1091+
"ocs"
1092+
],
1093+
"properties": {
1094+
"ocs": {
1095+
"type": "object",
1096+
"required": [
1097+
"meta",
1098+
"data"
1099+
],
1100+
"properties": {
1101+
"meta": {
1102+
"$ref": "#/components/schemas/OCSMeta"
1103+
},
1104+
"data": {}
1105+
}
1106+
}
1107+
}
10901108
}
10911109
}
10921110
}
@@ -1192,9 +1210,27 @@
11921210
"403": {
11931211
"description": "Initializing the template directory is not allowed",
11941212
"content": {
1195-
"text/plain": {
1213+
"application/json": {
11961214
"schema": {
1197-
"type": "string"
1215+
"type": "object",
1216+
"required": [
1217+
"ocs"
1218+
],
1219+
"properties": {
1220+
"ocs": {
1221+
"type": "object",
1222+
"required": [
1223+
"meta",
1224+
"data"
1225+
],
1226+
"properties": {
1227+
"meta": {
1228+
"$ref": "#/components/schemas/OCSMeta"
1229+
},
1230+
"data": {}
1231+
}
1232+
}
1233+
}
11981234
}
11991235
}
12001236
}

0 commit comments

Comments
 (0)