stackit-kms 0.4.1__tar.gz → 0.6.0__tar.gz

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackit-kms
-Version: 0.4.1
+Version: 0.6.0
 Summary: STACKIT Key Management Service API
 License-File: LICENSE.md
 License-File: NOTICE.txt

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-kms"
 
 [tool.poetry]
 name = "stackit-kms"
-version = "v0.4.1"
+version = "v0.6.0"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/create_key_payload.py

@@ -15,6 +15,7 @@ from __future__ import annotations
 
 import json
 import pprint
+import re  # noqa: F401
 from typing import Any, ClassVar, Dict, List, Optional, Set
 
 from pydantic import (
@@ -23,6 +24,7 @@ from pydantic import (
     Field,
     StrictBool,
     StrictStr,
+    field_validator,
 )
 from typing_extensions import Annotated, Self
 
@@ -43,7 +45,8 @@ class CreateKeyPayload(BaseModel):
         default=None, description="A user chosen description to distinguish multiple keys."
     )
     display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
-        description="The display name to distinguish multiple keys.", alias="displayName"
+        description="The display name to distinguish multiple keys. Valid characters: letters, digits, underscores and hyphens.",
+        alias="displayName",
     )
     import_only: Optional[StrictBool] = Field(
         default=False, description="States whether versions can be created or only imported.", alias="importOnly"
@@ -60,6 +63,13 @@ class CreateKeyPayload(BaseModel):
         "purpose",
     ]
 
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9_-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_-]+$/")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/create_key_ring_payload.py

@@ -15,9 +15,10 @@ from __future__ import annotations
 
 import json
 import pprint
+import re  # noqa: F401
 from typing import Any, ClassVar, Dict, List, Optional, Set
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing_extensions import Annotated, Self
 
 
@@ -30,10 +31,18 @@ class CreateKeyRingPayload(BaseModel):
         default=None, description="A user chosen description to distinguish multiple key rings."
     )
     display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
-        description="The display name to distinguish multiple key rings.", alias="displayName"
+        description="The display name to distinguish multiple key rings. Valid characters: letters, digits, underscores and hyphens.",
+        alias="displayName",
     )
     __properties: ClassVar[List[str]] = ["description", "displayName"]
 
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9_-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_-]+$/")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/create_wrapping_key_payload.py

@@ -15,9 +15,10 @@ from __future__ import annotations
 
 import json
 import pprint
+import re  # noqa: F401
 from typing import Any, ClassVar, Dict, List, Optional, Set
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing_extensions import Annotated, Self
 
 from stackit.kms.models.access_scope import AccessScope
@@ -37,7 +38,8 @@ class CreateWrappingKeyPayload(BaseModel):
         default=None, description="A user chosen description to distinguish multiple wrapping keys."
     )
     display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
-        description="The display name to distinguish multiple wrapping keys.", alias="displayName"
+        description="The display name to distinguish multiple wrapping keys. Valid characters: letters, digits, underscores and hyphens.",
+        alias="displayName",
     )
     protection: Protection
     purpose: WrappingPurpose
@@ -50,6 +52,13 @@ class CreateWrappingKeyPayload(BaseModel):
         "purpose",
     ]
 
+    @field_validator("display_name")
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9_-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_-]+$/")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/key.py

@@ -50,15 +50,15 @@ class Key(BaseModel):
         description="This date is set when a key is pending deletion and refers to the scheduled date of deletion",
         alias="deletionDate",
     )
-    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
-        default=None, description="A user chosen description to distinguish multiple keys."
+    description: Annotated[str, Field(strict=True, max_length=256)] = Field(
+        description="A user chosen description to distinguish multiple keys."
     )
     display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
         description="The display name to distinguish multiple keys.", alias="displayName"
     )
     id: StrictStr = Field(description="A auto generated unique id which identifies the keys.")
-    import_only: Optional[StrictBool] = Field(
-        default=False, description="States whether versions can be created or only imported.", alias="importOnly"
+    import_only: StrictBool = Field(
+        description="States whether versions can be created or only imported.", alias="importOnly"
     )
     key_ring_id: StrictStr = Field(
         description="The unique id of the key ring this key is assigned to.", alias="keyRingId"

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/key_ring.py

@@ -31,8 +31,8 @@ class KeyRing(BaseModel):
     created_at: datetime = Field(
         description="The date and time the creation of the key ring was triggered.", alias="createdAt"
     )
-    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
-        default=None, description="A user chosen description to distinguish multiple key rings."
+    description: Annotated[str, Field(strict=True, max_length=256)] = Field(
+        description="A user chosen description to distinguish multiple key rings."
     )
     display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
         description="The display name to distinguish multiple key rings.", alias="displayName"

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/version.py

@@ -44,7 +44,7 @@ class Version(BaseModel):
         description="The scheduled date when a version's key material will be erased completely from the backend",
         alias="destroyDate",
     )
-    disabled: Optional[StrictBool] = Field(default=False, description="States whether versions is enabled or disabled.")
+    disabled: StrictBool = Field(description="States whether versions is enabled or disabled.")
     key_id: StrictStr = Field(description="The unique id of the key this version is assigned to.", alias="keyId")
     key_ring_id: StrictStr = Field(
         description="The unique id of the key ring the key of this version is assigned to.", alias="keyRingId"

{stackit_kms-0.4.1 → stackit_kms-0.6.0}/src/stackit/kms/models/wrapping_key.py

@@ -38,8 +38,8 @@ class WrappingKey(BaseModel):
     created_at: datetime = Field(
         description="The date and time the creation of the wrapping key was triggered.", alias="createdAt"
     )
-    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
-        default=None, description="A user chosen description to distinguish multiple wrapping keys."
+    description: Annotated[str, Field(strict=True, max_length=256)] = Field(
+        description="A user chosen description to distinguish multiple wrapping keys."
     )
     display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
         description="The display name to distinguish multiple wrapping keys.", alias="displayName"
@@ -50,9 +50,7 @@ class WrappingKey(BaseModel):
         description="The unique id of the key ring this wrapping key is assigned to.", alias="keyRingId"
     )
     protection: Protection
-    public_key: Optional[StrictStr] = Field(
-        default=None, description="The public key of the wrapping key.", alias="publicKey"
-    )
+    public_key: StrictStr = Field(description="The public key of the wrapping key.", alias="publicKey")
     purpose: WrappingPurpose
     state: StrictStr = Field(description="The current state of the wrapping key.")
     __properties: ClassVar[List[str]] = [
@@ -134,8 +132,13 @@ class WrappingKey(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * OpenAPI `readOnly` fields are excluded.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "public_key",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,