Skip to content

Commit 351b3ee

Browse files
committed
update OAS
1 parent c7e06c9 commit 351b3ee

File tree

1 file changed

+193
-1
lines changed

1 file changed

+193
-1
lines changed

services/api-server/openapi.json

Lines changed: 193 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1499,13 +1499,75 @@
14991499
]
15001500
}
15011501
},
1502+
"/v0/solvers/page": {
1503+
"get": {
1504+
"tags": [
1505+
"solvers"
1506+
],
1507+
"summary": "Get Solvers Page",
1508+
"description": "Lists all available solvers (latest version) with pagination",
1509+
"operationId": "get_solvers_page",
1510+
"security": [
1511+
{
1512+
"HTTPBasic": []
1513+
}
1514+
],
1515+
"parameters": [
1516+
{
1517+
"name": "limit",
1518+
"in": "query",
1519+
"required": false,
1520+
"schema": {
1521+
"type": "integer",
1522+
"maximum": 50,
1523+
"minimum": 1,
1524+
"default": 20,
1525+
"title": "Limit"
1526+
}
1527+
},
1528+
{
1529+
"name": "offset",
1530+
"in": "query",
1531+
"required": false,
1532+
"schema": {
1533+
"type": "integer",
1534+
"minimum": 0,
1535+
"default": 0,
1536+
"title": "Offset"
1537+
}
1538+
}
1539+
],
1540+
"responses": {
1541+
"200": {
1542+
"description": "Successful Response",
1543+
"content": {
1544+
"application/json": {
1545+
"schema": {
1546+
"$ref": "#/components/schemas/Page_Solver_"
1547+
}
1548+
}
1549+
}
1550+
},
1551+
"422": {
1552+
"description": "Validation Error",
1553+
"content": {
1554+
"application/json": {
1555+
"schema": {
1556+
"$ref": "#/components/schemas/HTTPValidationError"
1557+
}
1558+
}
1559+
}
1560+
}
1561+
}
1562+
}
1563+
},
15021564
"/v0/solvers/releases": {
15031565
"get": {
15041566
"tags": [
15051567
"solvers"
15061568
],
15071569
"summary": "Lists All Releases",
1508-
"description": "Lists all released solvers i.e. all released versions\n\nSEE get_solvers_releases_page for a paginated version of this function",
1570+
"description": "\ud83d\udea8 **Deprecated**: This endpoint is deprecated and will be removed in a future release.\nPlease use `GET /v0/solvers/{solver_key}/releases/page` instead.\n\n\n\nLists all released solvers (not just latest version)\n\nNew in *version 0.5.0*\n\nRemoved in *version 0.7*: This endpoint is deprecated and will be removed in a future version",
15091571
"operationId": "list_solvers_releases",
15101572
"responses": {
15111573
"200": {
@@ -1812,6 +1874,77 @@
18121874
}
18131875
}
18141876
},
1877+
"/v0/solvers/{solver_key}/releases/page": {
1878+
"get": {
1879+
"tags": [
1880+
"solvers"
1881+
],
1882+
"summary": "Get Solver Releases Page",
1883+
"operationId": "get_solver_releases_page",
1884+
"security": [
1885+
{
1886+
"HTTPBasic": []
1887+
}
1888+
],
1889+
"parameters": [
1890+
{
1891+
"name": "solver_key",
1892+
"in": "path",
1893+
"required": true,
1894+
"schema": {
1895+
"type": "string",
1896+
"pattern": "^simcore/services/comp/([a-z0-9][a-z0-9_.-]*/)*([a-z0-9-_]+[a-z0-9])$",
1897+
"title": "Solver Key"
1898+
}
1899+
},
1900+
{
1901+
"name": "limit",
1902+
"in": "query",
1903+
"required": false,
1904+
"schema": {
1905+
"type": "integer",
1906+
"maximum": 50,
1907+
"minimum": 1,
1908+
"default": 20,
1909+
"title": "Limit"
1910+
}
1911+
},
1912+
{
1913+
"name": "offset",
1914+
"in": "query",
1915+
"required": false,
1916+
"schema": {
1917+
"type": "integer",
1918+
"minimum": 0,
1919+
"default": 0,
1920+
"title": "Offset"
1921+
}
1922+
}
1923+
],
1924+
"responses": {
1925+
"200": {
1926+
"description": "Successful Response",
1927+
"content": {
1928+
"application/json": {
1929+
"schema": {
1930+
"$ref": "#/components/schemas/Page_Solver_"
1931+
}
1932+
}
1933+
}
1934+
},
1935+
"422": {
1936+
"description": "Validation Error",
1937+
"content": {
1938+
"application/json": {
1939+
"schema": {
1940+
"$ref": "#/components/schemas/HTTPValidationError"
1941+
}
1942+
}
1943+
}
1944+
}
1945+
}
1946+
}
1947+
},
18151948
"/v0/solvers/{solver_key}/releases/{version}": {
18161949
"get": {
18171950
"tags": [
@@ -7444,6 +7577,65 @@
74447577
],
74457578
"title": "Page[LicensedItemGet]"
74467579
},
7580+
"Page_Solver_": {
7581+
"properties": {
7582+
"items": {
7583+
"items": {
7584+
"$ref": "#/components/schemas/Solver"
7585+
},
7586+
"type": "array",
7587+
"title": "Items"
7588+
},
7589+
"total": {
7590+
"anyOf": [
7591+
{
7592+
"type": "integer",
7593+
"minimum": 0
7594+
},
7595+
{
7596+
"type": "null"
7597+
}
7598+
],
7599+
"title": "Total"
7600+
},
7601+
"limit": {
7602+
"anyOf": [
7603+
{
7604+
"type": "integer",
7605+
"minimum": 1
7606+
},
7607+
{
7608+
"type": "null"
7609+
}
7610+
],
7611+
"title": "Limit"
7612+
},
7613+
"offset": {
7614+
"anyOf": [
7615+
{
7616+
"type": "integer",
7617+
"minimum": 0
7618+
},
7619+
{
7620+
"type": "null"
7621+
}
7622+
],
7623+
"title": "Offset"
7624+
},
7625+
"links": {
7626+
"$ref": "#/components/schemas/Links"
7627+
}
7628+
},
7629+
"type": "object",
7630+
"required": [
7631+
"items",
7632+
"total",
7633+
"limit",
7634+
"offset",
7635+
"links"
7636+
],
7637+
"title": "Page[Solver]"
7638+
},
74477639
"Page_Study_": {
74487640
"properties": {
74497641
"items": {

0 commit comments

Comments
 (0)