Skip to content

Commit 81bf9f3

Browse files
marcelklehrmarcelklehr
committed
fix: regenerate openapi descriptions
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
1 parent be8e168 commit 81bf9f3

File tree

4 files changed

+652
-1
lines changed

4 files changed

+652
-1
lines changed

‎core/Controller/TaskProcessingApiController.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ public function getNextScheduledTask(array $providerIds, array $taskTypeIds): Da
581581
* @param list<string> $providerIds The ids of the providers
582582
* @param list<string> $taskTypeIds The ids of the task types
583583
* @param int $numberOfTasks The number of tasks to return
584-
* @return DataResponse<Http::STATUS_OK, array{tasks: list<array{task: CoreTaskProcessingTask, provider: string}>, has_more: bool}, array{}>|DataResponse<Http::STATUS_NO_CONTENT, null, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
584+
* @return DataResponse<Http::STATUS_OK, array{tasks: list<array{task: CoreTaskProcessingTask, provider: string}>, has_more: bool}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
585585
*
586586
* 200: Tasks returned
587587
*/

‎core/openapi-ex_app.json‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1364,6 +1364,223 @@
13641364
}
13651365
}
13661366
}
1367+
},
1368+
"/ocs/v2.php/taskprocessing/tasks_provider/next_batch": {
1369+
"get": {
1370+
"operationId": "task_processing_api-get-next-scheduled-task-batch",
1371+
"summary": "Returns the next n scheduled tasks for the specified set of taskTypes and providers The returned tasks are capped at ~50MiB",
1372+
"description": "This endpoint requires admin access",
1373+
"tags": [
1374+
"task_processing_api"
1375+
],
1376+
"security": [
1377+
{
1378+
"bearer_auth": []
1379+
},
1380+
{
1381+
"basic_auth": []
1382+
}
1383+
],
1384+
"parameters": [
1385+
{
1386+
"name": "providerIds[]",
1387+
"in": "query",
1388+
"description": "The ids of the providers",
1389+
"required": true,
1390+
"schema": {
1391+
"type": "array",
1392+
"items": {
1393+
"type": "string"
1394+
}
1395+
}
1396+
},
1397+
{
1398+
"name": "taskTypeIds[]",
1399+
"in": "query",
1400+
"description": "The ids of the task types",
1401+
"required": true,
1402+
"schema": {
1403+
"type": "array",
1404+
"items": {
1405+
"type": "string"
1406+
}
1407+
}
1408+
},
1409+
{
1410+
"name": "numberOfTasks",
1411+
"in": "query",
1412+
"description": "The number of tasks to return",
1413+
"schema": {
1414+
"type": "integer",
1415+
"format": "int64",
1416+
"default": 1
1417+
}
1418+
},
1419+
{
1420+
"name": "OCS-APIRequest",
1421+
"in": "header",
1422+
"description": "Required to be true for the API request to pass",
1423+
"required": true,
1424+
"schema": {
1425+
"type": "boolean",
1426+
"default": true
1427+
}
1428+
}
1429+
],
1430+
"responses": {
1431+
"200": {
1432+
"description": "Tasks returned",
1433+
"content": {
1434+
"application/json": {
1435+
"schema": {
1436+
"type": "object",
1437+
"required": [
1438+
"ocs"
1439+
],
1440+
"properties": {
1441+
"ocs": {
1442+
"type": "object",
1443+
"required": [
1444+
"meta",
1445+
"data"
1446+
],
1447+
"properties": {
1448+
"meta": {
1449+
"$ref": "#/components/schemas/OCSMeta"
1450+
},
1451+
"data": {
1452+
"type": "object",
1453+
"required": [
1454+
"tasks",
1455+
"has_more"
1456+
],
1457+
"properties": {
1458+
"tasks": {
1459+
"type": "array",
1460+
"items": {
1461+
"type": "object",
1462+
"required": [
1463+
"task",
1464+
"provider"
1465+
],
1466+
"properties": {
1467+
"task": {
1468+
"$ref": "#/components/schemas/TaskProcessingTask"
1469+
},
1470+
"provider": {
1471+
"type": "string"
1472+
}
1473+
}
1474+
}
1475+
},
1476+
"has_more": {
1477+
"type": "boolean"
1478+
}
1479+
}
1480+
}
1481+
}
1482+
}
1483+
}
1484+
}
1485+
}
1486+
}
1487+
},
1488+
"500": {
1489+
"description": "",
1490+
"content": {
1491+
"application/json": {
1492+
"schema": {
1493+
"type": "object",
1494+
"required": [
1495+
"ocs"
1496+
],
1497+
"properties": {
1498+
"ocs": {
1499+
"type": "object",
1500+
"required": [
1501+
"meta",
1502+
"data"
1503+
],
1504+
"properties": {
1505+
"meta": {
1506+
"$ref": "#/components/schemas/OCSMeta"
1507+
},
1508+
"data": {
1509+
"type": "object",
1510+
"required": [
1511+
"message"
1512+
],
1513+
"properties": {
1514+
"message": {
1515+
"type": "string"
1516+
}
1517+
}
1518+
}
1519+
}
1520+
}
1521+
}
1522+
}
1523+
}
1524+
}
1525+
},
1526+
"401": {
1527+
"description": "Current user is not logged in",
1528+
"content": {
1529+
"application/json": {
1530+
"schema": {
1531+
"type": "object",
1532+
"required": [
1533+
"ocs"
1534+
],
1535+
"properties": {
1536+
"ocs": {
1537+
"type": "object",
1538+
"required": [
1539+
"meta",
1540+
"data"
1541+
],
1542+
"properties": {
1543+
"meta": {
1544+
"$ref": "#/components/schemas/OCSMeta"
1545+
},
1546+
"data": {}
1547+
}
1548+
}
1549+
}
1550+
}
1551+
}
1552+
}
1553+
},
1554+
"403": {
1555+
"description": "Logged in account must be an admin",
1556+
"content": {
1557+
"application/json": {
1558+
"schema": {
1559+
"type": "object",
1560+
"required": [
1561+
"ocs"
1562+
],
1563+
"properties": {
1564+
"ocs": {
1565+
"type": "object",
1566+
"required": [
1567+
"meta",
1568+
"data"
1569+
],
1570+
"properties": {
1571+
"meta": {
1572+
"$ref": "#/components/schemas/OCSMeta"
1573+
},
1574+
"data": {}
1575+
}
1576+
}
1577+
}
1578+
}
1579+
}
1580+
}
1581+
}
1582+
}
1583+
}
13671584
}
13681585
},
13691586
"tags": [

0 commit comments

Comments
 (0)