Skip to content

Commit e285dda

Browse files
sandereggsanderegg
committed
openapi
1 parent 0de1cfa commit e285dda

File tree

1 file changed

+210
-1
lines changed

1 file changed

+210
-1
lines changed

‎services/storage/openapi.json‎

Lines changed: 210 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.1.0",
33
"info": {
44
"title": "simcore_service_storage",
5-
"description": "Service to auto-scale swarm",
5+
"description": "Service that manages osparc storage backend",
66
"version": "0.6.0"
77
},
88
"paths": {
@@ -979,6 +979,105 @@
979979
}
980980
}
981981
},
982+
"/v0/locations/{location_id}/paths": {
983+
"get": {
984+
"tags": [
985+
"files"
986+
],
987+
"summary": "List Paths",
988+
"description": "Returns one level of files (paginated)",
989+
"operationId": "list_paths_v0_locations__location_id__paths_get",
990+
"parameters": [
991+
{
992+
"name": "location_id",
993+
"in": "path",
994+
"required": true,
995+
"schema": {
996+
"type": "integer",
997+
"title": "Location Id"
998+
}
999+
},
1000+
{
1001+
"name": "user_id",
1002+
"in": "query",
1003+
"required": true,
1004+
"schema": {
1005+
"type": "integer",
1006+
"exclusiveMinimum": true,
1007+
"title": "User Id",
1008+
"minimum": 0
1009+
}
1010+
},
1011+
{
1012+
"name": "file_filter",
1013+
"in": "query",
1014+
"required": false,
1015+
"schema": {
1016+
"anyOf": [
1017+
{
1018+
"type": "string",
1019+
"format": "path"
1020+
},
1021+
{
1022+
"type": "null"
1023+
}
1024+
],
1025+
"title": "File Filter"
1026+
}
1027+
},
1028+
{
1029+
"name": "cursor",
1030+
"in": "query",
1031+
"required": false,
1032+
"schema": {
1033+
"anyOf": [
1034+
{
1035+
"type": "string"
1036+
},
1037+
{
1038+
"type": "null"
1039+
}
1040+
],
1041+
"title": "Cursor"
1042+
}
1043+
},
1044+
{
1045+
"name": "size",
1046+
"in": "query",
1047+
"required": false,
1048+
"schema": {
1049+
"type": "integer",
1050+
"maximum": 100,
1051+
"minimum": 0,
1052+
"default": 50,
1053+
"title": "Size"
1054+
}
1055+
}
1056+
],
1057+
"responses": {
1058+
"200": {
1059+
"description": "Successful Response",
1060+
"content": {
1061+
"application/json": {
1062+
"schema": {
1063+
"$ref": "#/components/schemas/CursorPage_PathMetaDataGet_"
1064+
}
1065+
}
1066+
}
1067+
},
1068+
"422": {
1069+
"description": "Validation Error",
1070+
"content": {
1071+
"application/json": {
1072+
"schema": {
1073+
"$ref": "#/components/schemas/HTTPValidationError"
1074+
}
1075+
}
1076+
}
1077+
}
1078+
}
1079+
}
1080+
},
9821081
"/v0/simcore-s3:access": {
9831082
"post": {
9841083
"tags": [
@@ -1320,6 +1419,82 @@
13201419
],
13211420
"title": "AppStatusCheck"
13221421
},
1422+
"CursorPage_PathMetaDataGet_": {
1423+
"properties": {
1424+
"items": {
1425+
"items": {
1426+
"$ref": "#/components/schemas/PathMetaDataGet"
1427+
},
1428+
"type": "array",
1429+
"title": "Items"
1430+
},
1431+
"total": {
1432+
"anyOf": [
1433+
{
1434+
"type": "integer"
1435+
},
1436+
{
1437+
"type": "null"
1438+
}
1439+
],
1440+
"title": "Total",
1441+
"description": "Total items"
1442+
},
1443+
"current_page": {
1444+
"anyOf": [
1445+
{
1446+
"type": "string"
1447+
},
1448+
{
1449+
"type": "null"
1450+
}
1451+
],
1452+
"title": "Current Page",
1453+
"description": "Cursor to refetch the current page"
1454+
},
1455+
"current_page_backwards": {
1456+
"anyOf": [
1457+
{
1458+
"type": "string"
1459+
},
1460+
{
1461+
"type": "null"
1462+
}
1463+
],
1464+
"title": "Current Page Backwards",
1465+
"description": "Cursor to refetch the current page starting from the last item"
1466+
},
1467+
"previous_page": {
1468+
"anyOf": [
1469+
{
1470+
"type": "string"
1471+
},
1472+
{
1473+
"type": "null"
1474+
}
1475+
],
1476+
"title": "Previous Page",
1477+
"description": "Cursor for the previous page"
1478+
},
1479+
"next_page": {
1480+
"anyOf": [
1481+
{
1482+
"type": "string"
1483+
},
1484+
{
1485+
"type": "null"
1486+
}
1487+
],
1488+
"title": "Next Page",
1489+
"description": "Cursor for the next page"
1490+
}
1491+
},
1492+
"type": "object",
1493+
"required": [
1494+
"items"
1495+
],
1496+
"title": "CursorPage[PathMetaDataGet]"
1497+
},
13231498
"DatasetMetaDataGet": {
13241499
"properties": {
13251500
"dataset_id": {
@@ -2256,6 +2431,40 @@
22562431
],
22572432
"title": "LinkType"
22582433
},
2434+
"PathMetaDataGet": {
2435+
"properties": {
2436+
"path": {
2437+
"type": "string",
2438+
"format": "path",
2439+
"title": "Path",
2440+
"description": "the path to the current path"
2441+
},
2442+
"display_path": {
2443+
"type": "string",
2444+
"format": "path",
2445+
"title": "Display Path",
2446+
"description": "the path to display with UUID replaced"
2447+
},
2448+
"file_meta_data": {
2449+
"anyOf": [
2450+
{
2451+
"$ref": "#/components/schemas/FileMetaDataGet"
2452+
},
2453+
{
2454+
"type": "null"
2455+
}
2456+
],
2457+
"description": "if filled, this is the file meta data of the s3 object"
2458+
}
2459+
},
2460+
"additionalProperties": false,
2461+
"type": "object",
2462+
"required": [
2463+
"path",
2464+
"display_path"
2465+
],
2466+
"title": "PathMetaDataGet"
2467+
},
22592468
"S3Settings": {
22602469
"properties": {
22612470
"S3_ACCESS_KEY": {

0 commit comments

Comments
 (0)