diff --git a/CHANGELOG.md b/CHANGELOG.md index b40ed2633..e4ab45aad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,7 @@ ## Release (2026-xx-xx) +- `secretsmanager` [v0.4.0](services/secretsmanager/CHANGELOG.md#v040) + - **Feature:** added KmsKey model + - **Feature:** added KmsKey to Instance, CreateInstancePayload and UpdateInstancePayload - `sfs`: [v0.1.0](services/sfs/CHANGELOG.md#v010) - **New:** STACKIT File Storage (SFS) service - `alb` [v0.7.0](services/alb/CHANGELOG.md#v070) diff --git a/services/secretsmanager/CHANGELOG.md b/services/secretsmanager/CHANGELOG.md index 9f4f24d98..a2fddb1f4 100644 --- a/services/secretsmanager/CHANGELOG.md +++ b/services/secretsmanager/CHANGELOG.md @@ -1,3 +1,7 @@ +## v0.4.0 +- **Feature:** added KmsKey model +- **Feature:** added KmsKey to Instance, CreateInstancePayload and UpdateInstancePayload + ## v0.3.0 - **Version**: Minimal version is now python 3.9 diff --git a/services/secretsmanager/pyproject.toml b/services/secretsmanager/pyproject.toml index d141b4f2e..6511b2db3 100644 --- a/services/secretsmanager/pyproject.toml +++ b/services/secretsmanager/pyproject.toml @@ -3,7 +3,7 @@ name = "stackit-secretsmanager" [tool.poetry] name = "stackit-secretsmanager" -version = "v0.3.0" +version = "v0.4.0" authors = [ "STACKIT Developer Tools ", ] diff --git a/services/secretsmanager/src/stackit/secretsmanager/__init__.py b/services/secretsmanager/src/stackit/secretsmanager/__init__.py index 0e7992c83..15600ad30 100644 --- a/services/secretsmanager/src/stackit/secretsmanager/__init__.py +++ b/services/secretsmanager/src/stackit/secretsmanager/__init__.py @@ -35,6 +35,7 @@ "CreateInstancePayload", "CreateUserPayload", "Instance", + "KmsKeyPayload", "ListACLsResponse", "ListInstancesResponse", "ListUsersResponse", @@ -74,6 +75,7 @@ CreateUserPayload as CreateUserPayload, ) from stackit.secretsmanager.models.instance import Instance as Instance +from stackit.secretsmanager.models.kms_key_payload import KmsKeyPayload as KmsKeyPayload from stackit.secretsmanager.models.list_acls_response import ( ListACLsResponse as ListACLsResponse, ) diff --git a/services/secretsmanager/src/stackit/secretsmanager/api/default_api.py b/services/secretsmanager/src/stackit/secretsmanager/api/default_api.py index ae0f6d75c..9e2443cc0 100644 --- a/services/secretsmanager/src/stackit/secretsmanager/api/default_api.py +++ b/services/secretsmanager/src/stackit/secretsmanager/api/default_api.py @@ -113,6 +113,7 @@ def create_acl( "400": "BadRequest", "401": "str", "404": "NotFound", + "409": "Conflict", "500": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -187,6 +188,7 @@ def create_acl_with_http_info( "400": "BadRequest", "401": "str", "404": "NotFound", + "409": "Conflict", "500": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -261,6 +263,7 @@ def create_acl_without_preload_content( "400": "BadRequest", "401": "str", "404": "NotFound", + "409": "Conflict", "500": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -3626,6 +3629,7 @@ def update_acls( "400": "BadRequest", "401": "str", "404": "NotFound", + "409": "Conflict", "500": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -3700,6 +3704,7 @@ def update_acls_with_http_info( "400": "BadRequest", "401": "str", "404": "NotFound", + "409": "Conflict", "500": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -3774,6 +3779,7 @@ def update_acls_without_preload_content( "400": "BadRequest", "401": "str", "404": "NotFound", + "409": "Conflict", "500": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) diff --git a/services/secretsmanager/src/stackit/secretsmanager/models/__init__.py b/services/secretsmanager/src/stackit/secretsmanager/models/__init__.py index e2399a01f..3e493c787 100644 --- a/services/secretsmanager/src/stackit/secretsmanager/models/__init__.py +++ b/services/secretsmanager/src/stackit/secretsmanager/models/__init__.py @@ -21,6 +21,7 @@ from stackit.secretsmanager.models.create_instance_payload import CreateInstancePayload from stackit.secretsmanager.models.create_user_payload import CreateUserPayload from stackit.secretsmanager.models.instance import Instance +from stackit.secretsmanager.models.kms_key_payload import KmsKeyPayload from stackit.secretsmanager.models.list_acls_response import ListACLsResponse from stackit.secretsmanager.models.list_instances_response import ListInstancesResponse from stackit.secretsmanager.models.list_users_response import ListUsersResponse diff --git a/services/secretsmanager/src/stackit/secretsmanager/models/create_instance_payload.py b/services/secretsmanager/src/stackit/secretsmanager/models/create_instance_payload.py index 03a170e3d..9efcc63a0 100644 --- a/services/secretsmanager/src/stackit/secretsmanager/models/create_instance_payload.py +++ b/services/secretsmanager/src/stackit/secretsmanager/models/create_instance_payload.py @@ -20,14 +20,17 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing_extensions import Self +from stackit.secretsmanager.models.kms_key_payload import KmsKeyPayload + class CreateInstancePayload(BaseModel): """ CreateInstancePayload """ # noqa: E501 + kms_key: Optional[KmsKeyPayload] = Field(default=None, alias="kmsKey") name: StrictStr = Field(description="A user chosen name to distinguish multiple secrets manager instances.") - __properties: ClassVar[List[str]] = ["name"] + __properties: ClassVar[List[str]] = ["kmsKey", "name"] model_config = ConfigDict( populate_by_name=True, @@ -66,6 +69,9 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of kms_key + if self.kms_key: + _dict["kmsKey"] = self.kms_key.to_dict() return _dict @classmethod @@ -77,5 +83,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if not isinstance(obj, dict): return cls.model_validate(obj) - _obj = cls.model_validate({"name": obj.get("name")}) + _obj = cls.model_validate( + { + "kmsKey": KmsKeyPayload.from_dict(obj["kmsKey"]) if obj.get("kmsKey") is not None else None, + "name": obj.get("name"), + } + ) return _obj diff --git a/services/secretsmanager/src/stackit/secretsmanager/models/instance.py b/services/secretsmanager/src/stackit/secretsmanager/models/instance.py index 5447b4967..d9ccb149d 100644 --- a/services/secretsmanager/src/stackit/secretsmanager/models/instance.py +++ b/services/secretsmanager/src/stackit/secretsmanager/models/instance.py @@ -20,6 +20,8 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing_extensions import Self +from stackit.secretsmanager.models.kms_key_payload import KmsKeyPayload + class Instance(BaseModel): """ @@ -37,6 +39,7 @@ class Instance(BaseModel): alias="creationStartDate", ) id: StrictStr = Field(description="A auto generated unique id which identifies the secrets manager instances.") + kms_key: Optional[KmsKeyPayload] = Field(default=None, alias="kmsKey") name: StrictStr = Field(description="A user chosen name to distinguish multiple secrets manager instances.") secret_count: StrictInt = Field( description="The number of secrets currently stored inside of the instance. This value will be updated once per hour.", @@ -51,6 +54,7 @@ class Instance(BaseModel): "creationFinishedDate", "creationStartDate", "id", + "kmsKey", "name", "secretCount", "secretsEngine", @@ -96,6 +100,9 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of kms_key + if self.kms_key: + _dict["kmsKey"] = self.kms_key.to_dict() return _dict @classmethod @@ -113,6 +120,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "creationFinishedDate": obj.get("creationFinishedDate"), "creationStartDate": obj.get("creationStartDate"), "id": obj.get("id"), + "kmsKey": KmsKeyPayload.from_dict(obj["kmsKey"]) if obj.get("kmsKey") is not None else None, "name": obj.get("name"), "secretCount": obj.get("secretCount"), "secretsEngine": obj.get("secretsEngine"), diff --git a/services/secretsmanager/src/stackit/secretsmanager/models/kms_key_payload.py b/services/secretsmanager/src/stackit/secretsmanager/models/kms_key_payload.py new file mode 100644 index 000000000..7d031a74e --- /dev/null +++ b/services/secretsmanager/src/stackit/secretsmanager/models/kms_key_payload.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + STACKIT Secrets Manager API + + This API provides endpoints for managing the Secrets-Manager. + + The version of the OpenAPI document: 1.4.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations + +import json +import pprint +from typing import Any, ClassVar, Dict, List, Optional, Set + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing_extensions import Self + + +class KmsKeyPayload(BaseModel): + """ + The key for secret encryption and decryption. + """ # noqa: E501 + + key_id: StrictStr = Field(description="The key UUID.", alias="keyId") + key_ring_id: StrictStr = Field(description="The key ring UUID the key is part of.", alias="keyRingId") + key_version: StrictInt = Field(description="The Key version number.", alias="keyVersion") + service_account_email: StrictStr = Field( + description="The Service account email that will consume the key. Must be in the same project as the Secrets Manager instance.", + alias="serviceAccountEmail", + ) + __properties: ClassVar[List[str]] = ["keyId", "keyRingId", "keyVersion", "serviceAccountEmail"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KmsKeyPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KmsKeyPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "keyId": obj.get("keyId"), + "keyRingId": obj.get("keyRingId"), + "keyVersion": obj.get("keyVersion"), + "serviceAccountEmail": obj.get("serviceAccountEmail"), + } + ) + return _obj diff --git a/services/secretsmanager/src/stackit/secretsmanager/models/update_instance_payload.py b/services/secretsmanager/src/stackit/secretsmanager/models/update_instance_payload.py index a3b88307c..8ab8f5f5a 100644 --- a/services/secretsmanager/src/stackit/secretsmanager/models/update_instance_payload.py +++ b/services/secretsmanager/src/stackit/secretsmanager/models/update_instance_payload.py @@ -20,14 +20,17 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing_extensions import Self +from stackit.secretsmanager.models.kms_key_payload import KmsKeyPayload + class UpdateInstancePayload(BaseModel): """ UpdateInstancePayload """ # noqa: E501 + kms_key: Optional[KmsKeyPayload] = Field(default=None, alias="kmsKey") name: StrictStr = Field(description="A user chosen name to distinguish multiple secrets manager instances.") - __properties: ClassVar[List[str]] = ["name"] + __properties: ClassVar[List[str]] = ["kmsKey", "name"] model_config = ConfigDict( populate_by_name=True, @@ -66,6 +69,9 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of kms_key + if self.kms_key: + _dict["kmsKey"] = self.kms_key.to_dict() return _dict @classmethod @@ -77,5 +83,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if not isinstance(obj, dict): return cls.model_validate(obj) - _obj = cls.model_validate({"name": obj.get("name")}) + _obj = cls.model_validate( + { + "kmsKey": KmsKeyPayload.from_dict(obj["kmsKey"]) if obj.get("kmsKey") is not None else None, + "name": obj.get("name"), + } + ) return _obj