Skip to content

Commit a8703f0

Browse files
committed
feat(openapi): sync bundled specs with components (#523)
Refresh the bundled `reana_server`, `reana_workflow_controller` and `reana_job_controller` OpenAPI specs from the component repos, mostly to absorb the marshmallow 3 / apispec output changes introduced by the Flask 3.x and SQLAlchemy 2.x upgrade.
1 parent e6a18ce commit a8703f0

3 files changed

Lines changed: 11 additions & 12 deletions

File tree

reana_commons/openapi_specifications/reana_job_controller.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"definitions": {
33
"Job": {
4+
"additionalProperties": false,
45
"properties": {
56
"cmd": {
67
"type": "string"
@@ -16,11 +17,9 @@
1617
"type": "string"
1718
},
1819
"max_restart_count": {
19-
"format": "int32",
2020
"type": "integer"
2121
},
2222
"restart_count": {
23-
"format": "int32",
2423
"type": "integer"
2524
},
2625
"status": {
@@ -38,6 +37,7 @@
3837
"type": "object"
3938
},
4039
"JobRequest": {
40+
"additionalProperties": false,
4141
"properties": {
4242
"c4p_additional_requirements": {
4343
"type": "string"
@@ -63,6 +63,7 @@
6363
"type": "string"
6464
},
6565
"env_vars": {
66+
"additionalProperties": {},
6667
"default": {},
6768
"type": "object"
6869
},
@@ -85,7 +86,6 @@
8586
"type": "string"
8687
},
8788
"kubernetes_job_timeout": {
88-
"format": "int32",
8989
"type": "integer"
9090
},
9191
"kubernetes_memory_limit": {
@@ -95,7 +95,6 @@
9595
"type": "string"
9696
},
9797
"kubernetes_uid": {
98-
"format": "int32",
9998
"type": "integer"
10099
},
101100
"prettified_cmd": {
@@ -140,7 +139,7 @@
140139
"info": {
141140
"description": "REANA Job Controller API",
142141
"title": "reana-job-controller",
143-
"version": "0.95.0a3"
142+
"version": "0.95.0a4"
144143
},
145144
"paths": {
146145
"/apispec": {},
@@ -478,4 +477,4 @@
478477
}
479478
},
480479
"swagger": "2.0"
481-
}
480+
}

reana_commons/openapi_specifications/reana_server.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5267,7 +5267,7 @@
52675267
"type": "integer"
52685268
},
52695269
{
5270-
"description": "Filter workflow workspace files.",
5270+
"description": "Filter workflow workspace files by file name, size, or modification date.",
52715271
"in": "query",
52725272
"name": "search",
52735273
"required": false,
@@ -5315,10 +5315,10 @@
53155315
}
53165316
},
53175317
"400": {
5318-
"description": "Request failed. The incoming payload seems malformed.",
5318+
"description": "Request failed. The request parameters are invalid or the filtered result set exceeds the configured display limit.",
53195319
"examples": {
53205320
"application/json": {
5321-
"message": "Field 'size': Must be at least 1."
5321+
"message": "Too many files to display (e.g. limit=100000). Please use more specific filters to narrow the results. Available filters: file name, size, or last-modified."
53225322
}
53235323
},
53245324
"schema": {

reana_commons/openapi_specifications/reana_workflow_controller.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"info": {
33
"description": "Submit and manage workflows",
44
"title": "REANA Workflow Controller",
5-
"version": "0.95.0a5"
5+
"version": "0.95.0a6"
66
},
77
"paths": {
88
"/api/workflows": {
@@ -1658,7 +1658,7 @@
16581658
"type": "integer"
16591659
},
16601660
{
1661-
"description": "Filter workflow workspace files.",
1661+
"description": "Filter workflow workspace files by file name, size, or modification date.",
16621662
"in": "query",
16631663
"name": "search",
16641664
"required": false,
@@ -1706,7 +1706,7 @@
17061706
}
17071707
},
17081708
"400": {
1709-
"description": "Request failed. The incoming data specification seems malformed."
1709+
"description": "Request failed. The request parameters are invalid or the filtered result set exceeds the configured display limit."
17101710
},
17111711
"404": {
17121712
"description": "Request failed. Workflow does not exist.",

0 commit comments

Comments
 (0)