rest-api: convert remaining models to api_model

Change-Id: Ib846ed650d701f16857343ca0146a4df5e34aa49

Author: ottermata

cmk/gui/inventory/_openapi/_get_inventory_trees.py

@@ -4,25 +4,24 @@
 # conditions defined in the file COPYING, which is part of this source code package.
 
 from collections.abc import Mapping, Sequence
-from dataclasses import dataclass
 from typing import Annotated, Literal
 
 from cmk.ccc.hostaddress import HostName
 from cmk.gui.openapi.framework import QueryParam
-from cmk.gui.openapi.framework.model import api_field
+from cmk.gui.openapi.framework.model import api_field, api_model
 from cmk.gui.openapi.framework.model.base_models import DomainObjectCollectionModel, LinkModel
 from cmk.gui.openapi.restful_objects.constructors import collection_href
 from cmk.utils.structured_data import ImmutableTree
 
 from .._tree import inventory_of_host
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class Attributes:
     pairs: dict[str, int | float | str | bool | None] = api_field(description="Key-value pairs")
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class Table:
     key_columns: Sequence[str] = api_field(
         description="The key columns which are used to identify a row"
@@ -32,7 +31,7 @@ class Table:
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class Tree:
     attributes: "Attributes" = api_field(description="A collection of key-value pairs")
     table: "Table" = api_field(description="A collection of rows")
@@ -55,7 +54,7 @@ def _transform_inventory_tree(tree: ImmutableTree) -> Tree:
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostInventoryTree:
     host_name: str = api_field(
         description="The HW/SW Inventory tree of the host",
@@ -65,7 +64,7 @@ class HostInventoryTree:
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class InventoryTreesCollectionModel(DomainObjectCollectionModel):
     domainType: Literal["inventory"] = api_field(
         description="The domain type of the objects in the collection",

cmk/gui/openapi/api_endpoints/host_config/create_host.py

@@ -2,7 +2,6 @@
 # Copyright (C) 2025 Checkmk GmbH - License: GNU General Public License v2
 # This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
 # conditions defined in the file COPYING, which is part of this source code package.
-from dataclasses import dataclass
 from typing import Annotated
 
 from cmk.ccc.hostaddress import HostName
@@ -13,7 +12,7 @@
 from cmk.gui.openapi.api_endpoints.models.host_attribute_models import HostUpdateAttributeModel
 from cmk.gui.openapi.framework import EndpointBehavior, QueryParam
 from cmk.gui.openapi.framework.api_config import APIVersion
-from cmk.gui.openapi.framework.model import api_field
+from cmk.gui.openapi.framework.model import api_field, api_model
 from cmk.gui.openapi.framework.model.common_fields import AnnotatedFolder
 from cmk.gui.openapi.framework.model.converter import HostConverter, TypedPlainValidator
 from cmk.gui.openapi.framework.versioned_endpoint import (
@@ -30,7 +29,7 @@
 from cmk.gui.watolib.hosts_and_folders import Host
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class CreateHostModel:
     host_name: Annotated[HostName, TypedPlainValidator(str, HostConverter.not_exists)] = api_field(
         description="The hostname or IP address of the host to be created.",

cmk/gui/openapi/api_endpoints/host_config/list_hosts.py

@@ -3,7 +3,6 @@
 # This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
 # conditions defined in the file COPYING, which is part of this source code package.
 from collections.abc import Iterable, Sequence
-from dataclasses import dataclass
 from typing import Annotated, Literal
 
 from cmk import trace
@@ -14,7 +13,7 @@
 from cmk.gui.openapi.api_endpoints.host_config.utils import serialize_host
 from cmk.gui.openapi.framework import QueryParam
 from cmk.gui.openapi.framework.api_config import APIVersion
-from cmk.gui.openapi.framework.model import api_field, ApiOmitted
+from cmk.gui.openapi.framework.model import api_field, api_model, ApiOmitted
 from cmk.gui.openapi.framework.model.base_models import DomainObjectCollectionModel, LinkModel
 from cmk.gui.openapi.framework.model.common_fields import FieldsFilterType
 from cmk.gui.openapi.framework.versioned_endpoint import (
@@ -32,7 +31,7 @@
 tracer = trace.get_tracer()
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostConfigCollectionModel(DomainObjectCollectionModel):
     domainType: Literal["host_config"] = api_field(
         description="The domain type of the objects in the collection",

cmk/gui/openapi/api_endpoints/host_config/models/response_models.py

@@ -3,14 +3,13 @@
 # This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
 # conditions defined in the file COPYING, which is part of this source code package.
 from collections.abc import Sequence
-from dataclasses import dataclass
 from typing import Annotated, Literal
 
 from pydantic import AfterValidator
 
 from cmk.gui.openapi.api_endpoints.models.folder_attribute_models import FolderViewAttributeModel
 from cmk.gui.openapi.api_endpoints.models.host_attribute_models import HostViewAttributeModel
-from cmk.gui.openapi.framework.model import api_field, ApiOmitted
+from cmk.gui.openapi.framework.model import api_field, api_model, ApiOmitted
 from cmk.gui.openapi.framework.model.base_models import (
     DomainObjectCollectionModel,
     DomainObjectModel,
@@ -22,7 +21,7 @@
 from cmk.gui.openapi.framework.model.converter import HostConverter
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostExtensionsModel:
     folder: AnnotatedFolder = api_field(description="The folder, in which this host resides.")
     attributes: HostViewAttributeModel = api_field(description="Attributes of this host.")
@@ -41,7 +40,7 @@ class HostExtensionsModel:
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class FolderMembersModel:
     hosts: ObjectCollectionMemberModel = api_field(
         description="A list of links pointing to the actual host-resources."
@@ -51,15 +50,15 @@ class FolderMembersModel:
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class FolderExtensionsModel:
     path: str = api_field(description="The full path of this folder, slash delimited.")
     attributes: FolderViewAttributeModel = api_field(
         description="The folder's attributes. Hosts placed in this folder will inherit these attributes."
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class FolderModel(LinkableModel):
     domainType: Literal["folder_config"] = api_field(
         description="The domain type of the object.",
@@ -72,7 +71,7 @@ class FolderModel(LinkableModel):
     extensions: FolderExtensionsModel = api_field(description="Data and Meta-Data of this object.")
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostMembersModel(DomainObjectModel):
     folder_config: FolderModel = api_field(
         description="The folder in which this host resides. It is represented by a hexadecimal "
@@ -81,7 +80,7 @@ class HostMembersModel(DomainObjectModel):
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostConfigModel(DomainObjectModel):
     domainType: Literal["host_config"] = api_field(description="The domain type of the object.")
     members: HostMembersModel | None = api_field(
@@ -92,7 +91,7 @@ class HostConfigModel(DomainObjectModel):
     )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostConfigCollectionModel(DomainObjectCollectionModel):
     domainType: Literal["host_config"] = api_field(
         description="The domain type of the objects in the collection",

cmk/gui/openapi/api_endpoints/models/attributes.py

@@ -22,7 +22,7 @@
     PrivacyProtocolType,
 )
 from cmk.gui.logged_in import user
-from cmk.gui.openapi.framework.model import api_field, ApiOmitted
+from cmk.gui.openapi.framework.model import api_field, api_model, ApiOmitted
 from cmk.gui.openapi.framework.model.common_fields import IPv4String, RegexString
 from cmk.gui.openapi.framework.model.converter import (
     GroupConverter,
@@ -43,7 +43,7 @@
 from cmk.utils.translations import TranslationOptionsSpec
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class HostContactGroupModel:
     groups: list[Annotated[str, AfterValidator(GroupConverter(group_type="host").exists)]] = (
         api_field(description="A list of contact groups.", example="all")
@@ -79,13 +79,13 @@ def to_internal(self) -> HostContactGroupSpec:
         }
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class SNMPCommunityModel:
     type: Literal["v1_v2_community"] = api_field(description="SNMP v1 or v2 with community")
     community: str = api_field(description="SNMP community (SNMP Versions 1 and 2c)")
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class SNMPv3NoAuthNoPrivacyModel:
     type: Literal["noAuthNoPriv"] = api_field(
         description="SNMPv3 without authentication or privacy"
@@ -103,7 +103,7 @@ def to_internal(self) -> tuple[Literal["noAuthNoPriv"], str]:
         return self.type, self.security_name
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class SNMPv3AuthNoPrivacyModel:
     type: Literal["authNoPriv"] = api_field(
         description="SNMPv3 with authentication, but without privacy"
@@ -132,7 +132,7 @@ def to_internal(self) -> tuple[Literal["authNoPriv"], str, str, str]:
         )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class SNMPv3AuthPrivacyModel:
     type: Literal["authPriv"] = api_field(description="SNMPv3 with authentication and privacy")
     auth_protocol: AuthProtocolType = api_field(description="Authentication protocol.")
@@ -211,7 +211,7 @@ def to_internal(field: SNMPCredentialsModel) -> str | tuple:
                 raise ValueError(f"Unknown SNMP credentials type: {field.type!r}")
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class IPAddressRangeModel:
     type: Literal["ip_range"] = api_field(description="Select a range of IP addresses")
     from_address: IPv4String = api_field(description="The first IPv4 address of this range.")
@@ -229,7 +229,7 @@ def to_internal(self) -> tuple[Literal["ip_range"], tuple[str, str]]:
         return self.type, (str(self.from_address), str(self.to_address))
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class IPNetworkModel:
     type: Literal["ip_network"] = api_field(description="Select an entire network")
     network: IPv4Network = api_field(
@@ -248,7 +248,7 @@ def to_internal(self) -> tuple[Literal["ip_network"], tuple[str, int]]:
         return self.type, (str(self.network.network_address), self.network.prefixlen)
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class IPAddressesModel:
     type: Literal["ip_list"] = api_field(description="Select multiple explicit IP addresses")
     addresses: list[IPv4String] = api_field(description="List of IPv4 addresses")
@@ -264,7 +264,7 @@ def to_internal(self) -> tuple[Literal["ip_list"], Sequence[HostAddress]]:
         return self.type, [HostAddress(x) for x in self.addresses]
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class IPRegexpModel:
     type: Literal["ip_regex_list"] = api_field(description="Deselect IP addresses with regexes")
     regexp_list: list[RegexString] = api_field(
@@ -306,7 +306,7 @@ def from_internal_exclude(value: ExcludeIPRange) -> IPRangeWithRegexpModel:
         return IPRangeConverter.from_internal(value)
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class TimeAllowedRangeModel:
     start: dt.time = api_field(
         description="The start time of day. Inclusive. Use ISO8601 format. Seconds are stripped."
@@ -334,7 +334,7 @@ def to_internal(self) -> tuple[_CheckmkTime, _CheckmkTime]:
         return (self.start.hour, self.start.minute), (self.end.hour, self.end.minute)
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class RegexpRewritesModel:
     search: Annotated[RegexString, MaxLen(30)] = api_field(
         description="The search regexp. May contain match-groups, conditional matches, etc. This follows the Python regular expression syntax.\n\nFor details see:\n\n * https://docs.python.org/3/library/re.html"
@@ -373,7 +373,7 @@ def to_internal(self) -> tuple[str, str]:
         return str(self.search), self.replace_with
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class DirectMappingModel:
     hostname: str = api_field(description="The host name to be replaced.")
     replace_with: str = api_field(description="The replacement string.")
@@ -389,7 +389,7 @@ def to_internal(self) -> tuple[str, str]:
         return self.hostname, self.replace_with
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class TranslateNamesModel:
     case: Literal["nop", "lower", "upper"] = api_field(
         serialization_alias="convert_case",
@@ -480,7 +480,7 @@ def to_internal(self) -> TranslationOptionsSpec:
         return spec
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class NetworkScanModel:
     ip_ranges: list[IPRangeModel] = api_field(
         serialization_alias="addresses", description="IPv4 addresses to include."
@@ -584,7 +584,7 @@ def to_internal(self) -> NetworkScanSpec:
         return spec
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class IPMIParametersModel:  # TODO: this is dumb (or at least the IPMICredentials are)
     username: str | ApiOmitted = api_field(description="IPMI username", default_factory=ApiOmitted)
     password: str | ApiOmitted = api_field(description="IPMI password", default_factory=ApiOmitted)
@@ -605,7 +605,7 @@ def to_internal(self) -> IPMICredentials:
         return spec
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class NetworkScanResultModel:
     start: dt.datetime | None = api_field(
         description="When the scan started",
@@ -640,7 +640,7 @@ def from_internal(cls, value: NetworkScanResult) -> "NetworkScanResultModel":
         )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class MetaDataModel:
     created_at: dt.datetime | ApiOmitted = api_field(
         description="When has this object been created.",
@@ -668,7 +668,7 @@ def from_internal(cls, value: MetaData) -> Self:
         )
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class LockedByModel:
     site_id: str = api_field(description="Site ID")
     program_id: str = api_field(description="Program ID")
@@ -689,7 +689,7 @@ def to_internal(self) -> Sequence[str]:
         return [self.site_id, self.program_id, self.instance_id]
 
 
-@dataclass(kw_only=True)
+@api_model
 class FolderCustomHostAttributesAndTagGroupsModel(WithDynamicFields):
     """Class for custom host attributes and tag groups."""
 

cmk/gui/openapi/api_endpoints/models/folder_attribute_models.py

@@ -2,7 +2,6 @@
 # Copyright (C) 2025 Checkmk GmbH - License: GNU General Public License v2
 # This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
 # conditions defined in the file COPYING, which is part of this source code package.
-from dataclasses import dataclass
 from typing import Annotated, Literal
 
 from pydantic import AfterValidator
@@ -19,12 +18,12 @@
     SNMPCredentialsModel,
 )
 from cmk.gui.openapi.api_endpoints.models.host_attribute_models import BaseHostTagGroupModel
-from cmk.gui.openapi.framework.model import api_field, ApiOmitted
+from cmk.gui.openapi.framework.model import api_field, api_model, ApiOmitted
 from cmk.gui.openapi.framework.model.converter import HostConverter
 from cmk.gui.watolib.builtin_attributes import HostAttributeLabels
 
 
-@dataclass(kw_only=True)
+@api_model(slots=False)
 class BaseFolderAttributeModel:
     """Base class for all folder attribute models."""
 
@@ -106,7 +105,7 @@ def management_protocol_from_internal(value: str | None) -> str:
         return value
 
 
-@dataclass(kw_only=True, slots=True)
+@api_model
 class FolderViewAttributeModel(
     BaseFolderAttributeModel,
     BaseHostTagGroupModel,