Skip to content

♻️ Refactors catalog's update_service operation #7181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 7, 2025
Merged

♻️ Refactors catalog's update_service operation #7181

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9f9dbb7
cleanup models-library
pcrespov Feb 6, 2025
4e3603b
catalog REST: rm patch
pcrespov Feb 6, 2025
71dc461
dv2 fix
pcrespov Feb 6, 2025
089b924
rm unused in web-server
pcrespov Feb 6, 2025
29c9e36
fix error
pcrespov Feb 6, 2025
995480e
minor
pcrespov Feb 6, 2025
3c15041
@bisgaard-itis: fixing openapi test
pcrespov Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 66 additions & 107 deletions packages/models-library/src/models_library/api_schemas_catalog/services.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

from models_library.rpc_pagination import PageRpc
from pydantic import BaseModel, ConfigDict, Field, HttpUrl, NonNegativeInt
from pydantic.config import JsonDict

from ..boot_options import BootOptions
from ..emails import LowerCaseEmailStr
Expand All @@ -21,60 +22,6 @@
from ..services_types import ServiceKey, ServiceVersion
from ..utils.change_case import snake_to_camel


class ServiceUpdate(ServiceMetaDataEditable, ServiceAccessRights):
model_config = ConfigDict(
json_schema_extra={
"example": {
# ServiceAccessRights
"accessRights": {
1: {
"execute_access": False,
"write_access": False,
}, # type: ignore[dict-item]
2: {
"execute_access": True,
"write_access": True,
}, # type: ignore[dict-item]
44: {
"execute_access": False,
"write_access": False,
}, # type: ignore[dict-item]
},
# ServiceMetaData = ServiceCommonData +
"name": "My Human Readable Service Name",
"thumbnail": None,
"description": "An interesting service that does something",
"classifiers": ["RRID:SCR_018997", "RRID:SCR_019001"],
"quality": {
"tsr": {
"r01": {"level": 3, "references": ""},
"r02": {"level": 2, "references": ""},
"r03": {"level": 0, "references": ""},
"r04": {"level": 0, "references": ""},
"r05": {"level": 2, "references": ""},
"r06": {"level": 0, "references": ""},
"r07": {"level": 0, "references": ""},
"r08": {"level": 1, "references": ""},
"r09": {"level": 0, "references": ""},
"r10": {"level": 0, "references": ""},
},
"enabled": True,
"annotations": {
"vandv": "",
"purpose": "",
"standards": "",
"limitations": "",
"documentation": "",
"certificationLink": "",
"certificationStatus": "Uncertified",
},
},
}
}
)


_EXAMPLE_FILEPICKER: dict[str, Any] = {
"name": "File Picker",
"thumbnail": None,
Expand Down Expand Up @@ -209,10 +156,14 @@ class ServiceGet(
description="None when the owner email cannot be found in the database"
)

@staticmethod
def _update_json_schema_extra(schema: JsonDict) -> None:
schema.update({"examples": [_EXAMPLE_FILEPICKER, _EXAMPLE_SLEEPER]})

model_config = ConfigDict(
extra="ignore",
populate_by_name=True,
json_schema_extra={"examples": [_EXAMPLE_FILEPICKER, _EXAMPLE_SLEEPER]},
json_schema_extra=_update_json_schema_extra,
)


Expand Down Expand Up @@ -254,62 +205,70 @@ class ServiceGetV2(BaseModel):
json_schema_extra={"default": []},
)

@staticmethod
def _update_json_schema_extra(schema: JsonDict) -> None:
schema.update(
{
"examples": [
{
**_EXAMPLE_SLEEPER, # v2.2.1 (latest)
"history": [
{
"version": _EXAMPLE_SLEEPER["version"],
"version_display": "Summer Release",
"released": "2024-07-20T15:00:00",
},
{
"version": "2.0.0",
"compatibility": {
"canUpdateTo": {
"version": _EXAMPLE_SLEEPER["version"]
},
},
},
{"version": "0.9.11"},
{"version": "0.9.10"},
{
"version": "0.9.8",
"compatibility": {
"canUpdateTo": {"version": "0.9.11"},
},
},
{
"version": "0.9.1",
"versionDisplay": "Matterhorn",
"released": "2024-01-20T18:49:17",
"compatibility": {
"can_update_to": {"version": "0.9.11"},
},
},
{
"version": "0.9.0",
"retired": "2024-07-20T15:00:00",
},
{"version": "0.8.0"},
{"version": "0.1.0"},
],
},
{
**_EXAMPLE_FILEPICKER_V2,
"history": [
{
"version": _EXAMPLE_FILEPICKER_V2["version"],
"version_display": "Odei Release",
"released": "2025-03-25T00:00:00",
}
],
},
]
}
)

model_config = ConfigDict(
extra="forbid",
populate_by_name=True,
alias_generator=snake_to_camel,
json_schema_extra={
"examples": [
{
**_EXAMPLE_SLEEPER, # v2.2.1 (latest)
"history": [
{
"version": _EXAMPLE_SLEEPER["version"],
"version_display": "Summer Release",
"released": "2024-07-20T15:00:00",
},
{
"version": "2.0.0",
"compatibility": {
"canUpdateTo": {"version": _EXAMPLE_SLEEPER["version"]},
},
},
{"version": "0.9.11"},
{"version": "0.9.10"},
{
"version": "0.9.8",
"compatibility": {
"canUpdateTo": {"version": "0.9.11"},
},
},
{
"version": "0.9.1",
"versionDisplay": "Matterhorn",
"released": "2024-01-20T18:49:17",
"compatibility": {
"can_update_to": {"version": "0.9.11"},
},
},
{
"version": "0.9.0",
"retired": "2024-07-20T15:00:00",
},
{"version": "0.8.0"},
{"version": "0.1.0"},
],
},
{
**_EXAMPLE_FILEPICKER_V2,
"history": [
{
"version": _EXAMPLE_FILEPICKER_V2["version"],
"version_display": "Odei Release",
"released": "2025-03-25T00:00:00",
}
],
},
]
},
json_schema_extra=_update_json_schema_extra,
)


Expand Down
Loading
Loading