Skip to content

Commit 0697c65

Browse files
wvangeitwvangeit
committed
Update openapi specs
1 parent 051eb45 commit 0697c65

File tree

1 file changed

+224
-1
lines changed

1 file changed

+224
-1
lines changed

‎services/api-server/openapi.json‎

Lines changed: 224 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5305,7 +5305,7 @@
53055305
"function_jobs"
53065306
],
53075307
"summary": "List Function Jobs",
5308-
"description": "List function jobs\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
5308+
"description": "List function jobs\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects\n\nAdded in *version 0.10*: add filter by `function_id`, `function_job_ids` and `function_job_collection_id`",
53095309
"operationId": "list_function_jobs",
53105310
"security": [
53115311
{
@@ -5335,6 +5335,66 @@
53355335
"default": 0,
53365336
"title": "Offset"
53375337
}
5338+
},
5339+
{
5340+
"name": "function_id",
5341+
"in": "query",
5342+
"required": false,
5343+
"schema": {
5344+
"anyOf": [
5345+
{
5346+
"type": "string",
5347+
"format": "uuid"
5348+
},
5349+
{
5350+
"type": "null"
5351+
}
5352+
],
5353+
"description": "Filter by function ID pattern",
5354+
"title": "Function Id"
5355+
},
5356+
"description": "Filter by function ID pattern"
5357+
},
5358+
{
5359+
"name": "function_job_ids",
5360+
"in": "query",
5361+
"required": false,
5362+
"schema": {
5363+
"anyOf": [
5364+
{
5365+
"type": "array",
5366+
"items": {
5367+
"type": "string",
5368+
"format": "uuid"
5369+
}
5370+
},
5371+
{
5372+
"type": "null"
5373+
}
5374+
],
5375+
"description": "Filter by function job IDs",
5376+
"title": "Function Job Ids"
5377+
},
5378+
"description": "Filter by function job IDs"
5379+
},
5380+
{
5381+
"name": "function_job_collection_id",
5382+
"in": "query",
5383+
"required": false,
5384+
"schema": {
5385+
"anyOf": [
5386+
{
5387+
"type": "string",
5388+
"format": "uuid"
5389+
},
5390+
{
5391+
"type": "null"
5392+
}
5393+
],
5394+
"description": "Filter by function job collection ID",
5395+
"title": "Function Job Collection Id"
5396+
},
5397+
"description": "Filter by function job collection ID"
53385398
}
53395399
],
53405400
"responses": {
@@ -6082,6 +6142,169 @@
60826142
}
60836143
}
60846144
},
6145+
"/v0/function_job_collections/{function_job_collection_id}/function_jobs/page": {
6146+
"get": {
6147+
"tags": [
6148+
"function_job_collections"
6149+
],
6150+
"summary": "Function Job Collection List Function Jobs Page",
6151+
"description": "Get the function jobs in function job collection\n\nNew in *version 0.10*",
6152+
"operationId": "function_job_collection_list_function_jobs_page",
6153+
"security": [
6154+
{
6155+
"HTTPBasic": []
6156+
}
6157+
],
6158+
"parameters": [
6159+
{
6160+
"name": "function_job_collection_id",
6161+
"in": "path",
6162+
"required": true,
6163+
"schema": {
6164+
"type": "string",
6165+
"format": "uuid",
6166+
"title": "Function Job Collection Id"
6167+
}
6168+
},
6169+
{
6170+
"name": "limit",
6171+
"in": "query",
6172+
"required": false,
6173+
"schema": {
6174+
"type": "integer",
6175+
"maximum": 50,
6176+
"minimum": 1,
6177+
"default": 20,
6178+
"title": "Limit"
6179+
}
6180+
},
6181+
{
6182+
"name": "offset",
6183+
"in": "query",
6184+
"required": false,
6185+
"schema": {
6186+
"type": "integer",
6187+
"minimum": 0,
6188+
"default": 0,
6189+
"title": "Offset"
6190+
}
6191+
}
6192+
],
6193+
"responses": {
6194+
"200": {
6195+
"description": "Successful Response",
6196+
"content": {
6197+
"application/json": {
6198+
"schema": {
6199+
"$ref": "#/components/schemas/Page_Annotated_Union_RegisteredProjectFunctionJob__RegisteredPythonCodeFunctionJob__RegisteredSolverFunctionJob___FieldInfo_annotation_NoneType__required_True__discriminator__function_class____"
6200+
}
6201+
}
6202+
}
6203+
},
6204+
"404": {
6205+
"description": "Function job collection not found",
6206+
"content": {
6207+
"application/json": {
6208+
"schema": {
6209+
"$ref": "#/components/schemas/ErrorGet"
6210+
}
6211+
}
6212+
}
6213+
},
6214+
"422": {
6215+
"description": "Validation Error",
6216+
"content": {
6217+
"application/json": {
6218+
"schema": {
6219+
"$ref": "#/components/schemas/HTTPValidationError"
6220+
}
6221+
}
6222+
}
6223+
}
6224+
}
6225+
}
6226+
},
6227+
"/v0/function_job_collections/{function_job_collection_id}/function_jobs/list": {
6228+
"get": {
6229+
"tags": [
6230+
"function_job_collections"
6231+
],
6232+
"summary": "Function Job Collection List Function Jobs List",
6233+
"description": "Get the function jobs in function job collection\n\nNew in *version 0.8.0*",
6234+
"operationId": "function_job_collection_list_function_jobs_list",
6235+
"security": [
6236+
{
6237+
"HTTPBasic": []
6238+
}
6239+
],
6240+
"parameters": [
6241+
{
6242+
"name": "function_job_collection_id",
6243+
"in": "path",
6244+
"required": true,
6245+
"schema": {
6246+
"type": "string",
6247+
"format": "uuid",
6248+
"title": "Function Job Collection Id"
6249+
}
6250+
}
6251+
],
6252+
"responses": {
6253+
"200": {
6254+
"description": "Successful Response",
6255+
"content": {
6256+
"application/json": {
6257+
"schema": {
6258+
"type": "array",
6259+
"items": {
6260+
"oneOf": [
6261+
{
6262+
"$ref": "#/components/schemas/RegisteredProjectFunctionJob"
6263+
},
6264+
{
6265+
"$ref": "#/components/schemas/RegisteredPythonCodeFunctionJob"
6266+
},
6267+
{
6268+
"$ref": "#/components/schemas/RegisteredSolverFunctionJob"
6269+
}
6270+
],
6271+
"discriminator": {
6272+
"propertyName": "function_class",
6273+
"mapping": {
6274+
"PROJECT": "#/components/schemas/RegisteredProjectFunctionJob",
6275+
"PYTHON_CODE": "#/components/schemas/RegisteredPythonCodeFunctionJob",
6276+
"SOLVER": "#/components/schemas/RegisteredSolverFunctionJob"
6277+
}
6278+
}
6279+
},
6280+
"title": "Response Function Job Collection List Function Jobs List V0 Function Job Collections Function Job Collection Id Function Jobs List Get"
6281+
}
6282+
}
6283+
}
6284+
},
6285+
"404": {
6286+
"description": "Function job collection not found",
6287+
"content": {
6288+
"application/json": {
6289+
"schema": {
6290+
"$ref": "#/components/schemas/ErrorGet"
6291+
}
6292+
}
6293+
}
6294+
},
6295+
"422": {
6296+
"description": "Validation Error",
6297+
"content": {
6298+
"application/json": {
6299+
"schema": {
6300+
"$ref": "#/components/schemas/HTTPValidationError"
6301+
}
6302+
}
6303+
}
6304+
}
6305+
}
6306+
}
6307+
},
60856308
"/v0/function_job_collections/{function_job_collection_id}/status": {
60866309
"get": {
60876310
"tags": [

0 commit comments

Comments
 (0)