Skip to content

Commit deee2ee

Browse files
wvangeitwvangeit
committed
Increase api version number
1 parent 1546739 commit deee2ee

File tree

10 files changed

+141
-84
lines changed

10 files changed

+141
-84
lines changed

‎services/api-server/openapi.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "osparc.io public API",
55
"description": "osparc-simcore public API specifications",
6-
"version": "0.8.0"
6+
"version": "0.9.0"
77
},
88
"paths": {
99
"/v0/meta": {
@@ -5286,7 +5286,7 @@
52865286
"function_jobs"
52875287
],
52885288
"summary": "List Function Jobs",
5289-
"description": "List function jobs\n\nNew in *version 0.8.0*",
5289+
"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",
52905290
"operationId": "list_function_jobs",
52915291
"security": [
52925292
{
@@ -5346,7 +5346,7 @@
53465346
"function_jobs"
53475347
],
53485348
"summary": "Register Function Job",
5349-
"description": "Create function job\n\nNew in *version 0.8.0*",
5349+
"description": "Create function job\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
53505350
"operationId": "register_function_job",
53515351
"security": [
53525352
{
@@ -5431,7 +5431,7 @@
54315431
"function_jobs"
54325432
],
54335433
"summary": "Get Function Job",
5434-
"description": "Get function job\n\nNew in *version 0.8.0*",
5434+
"description": "Get function job\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
54355435
"operationId": "get_function_job",
54365436
"security": [
54375437
{
@@ -6810,7 +6810,7 @@
68106810
"functions"
68116811
],
68126812
"summary": "Register Function",
6813-
"description": "Create function\n\nNew in *version 0.8.0*",
6813+
"description": "Create function\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
68146814
"operationId": "register_function",
68156815
"security": [
68166816
{
@@ -6903,7 +6903,7 @@
69036903
"functions"
69046904
],
69056905
"summary": "List Functions",
6906-
"description": "List functions\n\nNew in *version 0.8.0*",
6906+
"description": "List functions\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
69076907
"operationId": "list_functions",
69086908
"security": [
69096909
{
@@ -6965,7 +6965,7 @@
69656965
"functions"
69666966
],
69676967
"summary": "Get Function",
6968-
"description": "Get function\n\nNew in *version 0.8.0*",
6968+
"description": "Get function\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
69696969
"operationId": "get_function",
69706970
"security": [
69716971
{
@@ -7098,7 +7098,7 @@
70987098
"functions"
70997099
],
71007100
"summary": "List Function Jobs For Functionid",
7101-
"description": "List function jobs for a function\n\nNew in *version 0.8.0*",
7101+
"description": "List function jobs for a function\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
71027102
"operationId": "list_function_jobs_for_functionid",
71037103
"security": [
71047104
{
@@ -7170,7 +7170,7 @@
71707170
"functions"
71717171
],
71727172
"summary": "Update Function Title",
7173-
"description": "Update function\n\nNew in *version 0.8.0*",
7173+
"description": "Update function\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
71747174
"operationId": "update_function_title",
71757175
"security": [
71767176
{
@@ -7257,7 +7257,7 @@
72577257
"functions"
72587258
],
72597259
"summary": "Update Function Description",
7260-
"description": "Update function\n\nNew in *version 0.8.0*",
7260+
"description": "Update function\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
72617261
"operationId": "update_function_description",
72627262
"security": [
72637263
{
@@ -7568,7 +7568,7 @@
75687568
"functions"
75697569
],
75707570
"summary": "Run Function",
7571-
"description": "Run function\n\nNew in *version 0.8.0*",
7571+
"description": "Run function\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
75727572
"operationId": "run_function",
75737573
"security": [
75747574
{
@@ -7664,7 +7664,7 @@
76647664
"functions"
76657665
],
76667666
"summary": "Map Function",
7667-
"description": "Map function over input parameters\n\nNew in *version 0.8.0*",
7667+
"description": "Map function over input parameters\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
76687668
"operationId": "map_function",
76697669
"security": [
76707670
{

‎services/api-server/src/simcore_service_api_server/api/routes/function_job_collections_routes.py‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@
2424
)
2525
from ..dependencies.services import get_api_client
2626
from ..dependencies.webserver_rpc import get_wb_api_rpc_client
27-
from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION, create_route_description
27+
from ._constants import (
28+
FMSG_CHANGELOG_ADDED_IN_VERSION,
29+
FMSG_CHANGELOG_NEW_IN_VERSION,
30+
create_route_description,
31+
)
2832
from .function_jobs_routes import function_job_status, get_function_job
2933

3034
# pylint: disable=too-many-arguments
@@ -41,6 +45,30 @@
4145
},
4246
}
4347

48+
ENDPOINTS = [
49+
"list_function_job_collections",
50+
"register_function_job_collection",
51+
"get_function_job_collection",
52+
"delete_function_job_collection",
53+
]
54+
CHANGE_LOGS = {}
55+
for endpoint in ENDPOINTS:
56+
CHANGE_LOGS[endpoint] = [
57+
FMSG_CHANGELOG_NEW_IN_VERSION.format("0.8.0"),
58+
]
59+
if endpoint in [
60+
"list_function_job_collections",
61+
"register_function_job_collection",
62+
"get_function_job_collection",
63+
"function_job_collection_list_function_jobs",
64+
]:
65+
CHANGE_LOGS[endpoint].append(
66+
FMSG_CHANGELOG_ADDED_IN_VERSION.format(
67+
"0.9.0",
68+
"add `created_at` field in the registered function-related objects",
69+
)
70+
)
71+
4472

4573
@function_job_collections_router.get(
4674
"",

‎services/api-server/src/simcore_service_api_server/api/routes/function_jobs_routes.py‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@
3131
from ..dependencies.webserver_http import get_webserver_session
3232
from ..dependencies.webserver_rpc import get_wb_api_rpc_client
3333
from . import solvers_jobs, solvers_jobs_read, studies_jobs
34-
from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION, create_route_description
34+
from ._constants import (
35+
FMSG_CHANGELOG_ADDED_IN_VERSION,
36+
FMSG_CHANGELOG_NEW_IN_VERSION,
37+
create_route_description,
38+
)
3539

3640
# pylint: disable=too-many-arguments
3741
# pylint: disable=cyclic-import
@@ -46,15 +50,33 @@
4650
},
4751
}
4852

49-
FIRST_RELEASE_VERSION = "0.8.0"
53+
ENDPOINTS = [
54+
"list_function_jobs",
55+
"register_function_job",
56+
"get_function_job",
57+
"delete_function_job",
58+
"function_job_status",
59+
"function_job_outputs",
60+
]
61+
CHANGE_LOGS = {}
62+
for endpoint in ENDPOINTS:
63+
CHANGE_LOGS[endpoint] = [
64+
FMSG_CHANGELOG_NEW_IN_VERSION.format("0.8.0"),
65+
]
66+
if endpoint in ["list_function_jobs", "register_function_job", "get_function_job"]:
67+
CHANGE_LOGS[endpoint].append(
68+
FMSG_CHANGELOG_ADDED_IN_VERSION.format(
69+
"0.9.0",
70+
"add `created_at` field in the registered function-related objects",
71+
)
72+
)
5073

5174

5275
@function_job_router.get(
5376
"",
5477
response_model=Page[RegisteredFunctionJob],
5578
description=create_route_description(
56-
base="List function jobs",
57-
changelog=[FMSG_CHANGELOG_NEW_IN_VERSION.format(FIRST_RELEASE_VERSION)],
79+
base="List function jobs", changelog=CHANGE_LOGS["list_function_jobs"]
5880
),
5981
)
6082
async def list_function_jobs(
@@ -82,7 +104,7 @@ async def list_function_jobs(
82104
response_model=RegisteredFunctionJob,
83105
description=create_route_description(
84106
base="Create function job",
85-
changelog=[FMSG_CHANGELOG_NEW_IN_VERSION.format(FIRST_RELEASE_VERSION)],
107+
changelog=CHANGE_LOGS["register_function_job"],
86108
),
87109
)
88110
async def register_function_job(
@@ -102,7 +124,7 @@ async def register_function_job(
102124
responses={**_COMMON_FUNCTION_JOB_ERROR_RESPONSES},
103125
description=create_route_description(
104126
base="Get function job",
105-
changelog=[FMSG_CHANGELOG_NEW_IN_VERSION.format(FIRST_RELEASE_VERSION)],
127+
changelog=CHANGE_LOGS["get_function_job"],
106128
),
107129
)
108130
async def get_function_job(
@@ -122,7 +144,7 @@ async def get_function_job(
122144
responses={**_COMMON_FUNCTION_JOB_ERROR_RESPONSES},
123145
description=create_route_description(
124146
base="Delete function job",
125-
changelog=[FMSG_CHANGELOG_NEW_IN_VERSION.format(FIRST_RELEASE_VERSION)],
147+
changelog=CHANGE_LOGS["delete_function_job"],
126148
),
127149
)
128150
async def delete_function_job(
@@ -142,7 +164,7 @@ async def delete_function_job(
142164
responses={**_COMMON_FUNCTION_JOB_ERROR_RESPONSES},
143165
description=create_route_description(
144166
base="Get function job status",
145-
changelog=[FMSG_CHANGELOG_NEW_IN_VERSION.format(FIRST_RELEASE_VERSION)],
167+
changelog=CHANGE_LOGS["function_job_status"],
146168
),
147169
)
148170
async def function_job_status(
@@ -222,7 +244,7 @@ async def get_function_from_functionjobid(
222244
responses={**_COMMON_FUNCTION_JOB_ERROR_RESPONSES},
223245
description=create_route_description(
224246
base="Get function job outputs",
225-
changelog=[FMSG_CHANGELOG_NEW_IN_VERSION.format(FIRST_RELEASE_VERSION)],
247+
changelog=CHANGE_LOGS["function_job_outputs"],
226248
),
227249
)
228250
async def function_job_outputs(

0 commit comments

Comments
 (0)