diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b106a961..837e91f03 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,8 +10,13 @@ - **Bugfix:** Prevent year 0 timestamp issue - `cdn`: [v1.7.1](services/cdn/CHANGELOG.md#v171) - **Bugfix:** Prevent year 0 timestamp issue -- `git`: [v0.5.1](services/git/CHANGELOG.md#v051) - - **Bugfix:** Prevent year 0 timestamp issue +- `git`: + - [v0.6.0](services/git/CHANGELOG.md#v060) + - **Feature:** Add support for list runner labels operation + - new API client methods `list_runner_labels` + - new model classes `RunnerLabel` and `ListRunnerLabels` + - [v0.5.1](services/git/CHANGELOG.md#v051) + - **Bugfix:** Prevent year 0 timestamp issue - `intake`: [v0.2.1](services/intake/CHANGELOG.md#v021) - **Bugfix:** Prevent year 0 timestamp issue - `kms`: [v0.4.1](services/kms/CHANGELOG.md#v041) diff --git a/services/git/CHANGELOG.md b/services/git/CHANGELOG.md index 2fd8732d7..1877ee1df 100644 --- a/services/git/CHANGELOG.md +++ b/services/git/CHANGELOG.md @@ -1,3 +1,8 @@ +## v0.6.0 +- **Feature:** Add support for list runner labels operation + - new API client methods `list_runner_labels` + - new model classes `RunnerLabel` and `ListRunnerLabels` + ## v0.5.1 - **Bugfix:** Prevent year 0 timestamp issue diff --git a/services/git/pyproject.toml b/services/git/pyproject.toml index f4f4f5bdd..18e31b426 100644 --- a/services/git/pyproject.toml +++ b/services/git/pyproject.toml @@ -3,7 +3,7 @@ name = "stackit-git" [tool.poetry] name = "stackit-git" -version = "v0.5.1" +version = "v0.6.0" authors = [ "STACKIT Developer Tools ", ] diff --git a/services/git/src/stackit/git/__init__.py b/services/git/src/stackit/git/__init__.py index 08fe1f1a9..25e74416c 100644 --- a/services/git/src/stackit/git/__init__.py +++ b/services/git/src/stackit/git/__init__.py @@ -36,7 +36,9 @@ "InternalServerErrorResponse", "ListFlavors", "ListInstances", + "ListRunnerLabels", "PatchOperation", + "RunnerLabel", "UnauthorizedResponse", ] @@ -68,7 +70,9 @@ ) from stackit.git.models.list_flavors import ListFlavors as ListFlavors from stackit.git.models.list_instances import ListInstances as ListInstances +from stackit.git.models.list_runner_labels import ListRunnerLabels as ListRunnerLabels from stackit.git.models.patch_operation import PatchOperation as PatchOperation +from stackit.git.models.runner_label import RunnerLabel as RunnerLabel from stackit.git.models.unauthorized_response import ( UnauthorizedResponse as UnauthorizedResponse, ) diff --git a/services/git/src/stackit/git/api/default_api.py b/services/git/src/stackit/git/api/default_api.py index be17aaa0e..b5d686d1d 100644 --- a/services/git/src/stackit/git/api/default_api.py +++ b/services/git/src/stackit/git/api/default_api.py @@ -30,6 +30,7 @@ from stackit.git.models.instance import Instance from stackit.git.models.list_flavors import ListFlavors from stackit.git.models.list_instances import ListInstances +from stackit.git.models.list_runner_labels import ListRunnerLabels from stackit.git.models.patch_operation import PatchOperation from stackit.git.rest import RESTResponseType @@ -1302,6 +1303,244 @@ def _list_instances_serialize( _request_auth=_request_auth, ) + @validate_call + def list_runner_labels( + self, + project_id: Annotated[str, Field(min_length=36, strict=True, max_length=36, description="Project identifier.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListRunnerLabels: + """Returns the details for the given STACKIT Git RunnerLabels. + + Type of runners we can use for running jobs. + + :param project_id: Project identifier. (required) + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_runner_labels_serialize( + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListRunnerLabels", + "400": "GenericErrorResponse", + "401": "UnauthorizedResponse", + "404": None, + "500": "GenericErrorResponse", + } + response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_runner_labels_with_http_info( + self, + project_id: Annotated[str, Field(min_length=36, strict=True, max_length=36, description="Project identifier.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListRunnerLabels]: + """Returns the details for the given STACKIT Git RunnerLabels. + + Type of runners we can use for running jobs. + + :param project_id: Project identifier. (required) + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_runner_labels_serialize( + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListRunnerLabels", + "400": "GenericErrorResponse", + "401": "UnauthorizedResponse", + "404": None, + "500": "GenericErrorResponse", + } + response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_runner_labels_without_preload_content( + self, + project_id: Annotated[str, Field(min_length=36, strict=True, max_length=36, description="Project identifier.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Returns the details for the given STACKIT Git RunnerLabels. + + Type of runners we can use for running jobs. + + :param project_id: Project identifier. (required) + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_runner_labels_serialize( + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListRunnerLabels", + "400": "GenericErrorResponse", + "401": "UnauthorizedResponse", + "404": None, + "500": "GenericErrorResponse", + } + response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) + return response_data.response + + def _list_runner_labels_serialize( + self, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params["projectId"] = project_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + + # authentication setting + _auth_settings: List[str] = [] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1beta/projects/{projectId}/runner-labels", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + @validate_call def patch_instance( self, diff --git a/services/git/src/stackit/git/models/__init__.py b/services/git/src/stackit/git/models/__init__.py index 30335b720..1757b9b46 100644 --- a/services/git/src/stackit/git/models/__init__.py +++ b/services/git/src/stackit/git/models/__init__.py @@ -24,5 +24,7 @@ ) from stackit.git.models.list_flavors import ListFlavors from stackit.git.models.list_instances import ListInstances +from stackit.git.models.list_runner_labels import ListRunnerLabels from stackit.git.models.patch_operation import PatchOperation +from stackit.git.models.runner_label import RunnerLabel from stackit.git.models.unauthorized_response import UnauthorizedResponse diff --git a/services/git/src/stackit/git/models/list_flavors.py b/services/git/src/stackit/git/models/list_flavors.py index 22ba5e1c1..babb918bd 100644 --- a/services/git/src/stackit/git/models/list_flavors.py +++ b/services/git/src/stackit/git/models/list_flavors.py @@ -26,7 +26,7 @@ class ListFlavors(BaseModel): """ - A list of STACKIT Git flavors. + A list of STACKIT Git Flavors. """ # noqa: E501 flavors: List[Flavor] diff --git a/services/git/src/stackit/git/models/list_runner_labels.py b/services/git/src/stackit/git/models/list_runner_labels.py new file mode 100644 index 000000000..040bc7c66 --- /dev/null +++ b/services/git/src/stackit/git/models/list_runner_labels.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + STACKIT Git API + + STACKIT Git management API. + + The version of the OpenAPI document: 1beta.0.4 + Contact: git@stackit.cloud + 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 +from typing_extensions import Self + +from stackit.git.models.runner_label import RunnerLabel + + +class ListRunnerLabels(BaseModel): + """ + A list of STACKIT Git RunnerLabels. + """ # noqa: E501 + + runner_labels: List[RunnerLabel] = Field(alias="runner-labels") + __properties: ClassVar[List[str]] = ["runner-labels"] + + 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 ListRunnerLabels 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, + ) + # override the default output from pydantic by calling `to_dict()` of each item in runner_labels (list) + _items = [] + if self.runner_labels: + for _item in self.runner_labels: + if _item: + _items.append(_item.to_dict()) + _dict["runner-labels"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListRunnerLabels from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "runner-labels": ( + [RunnerLabel.from_dict(_item) for _item in obj["runner-labels"]] + if obj.get("runner-labels") is not None + else None + ) + } + ) + return _obj diff --git a/services/git/src/stackit/git/models/runner_label.py b/services/git/src/stackit/git/models/runner_label.py new file mode 100644 index 000000000..aac476f6b --- /dev/null +++ b/services/git/src/stackit/git/models/runner_label.py @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + STACKIT Git API + + STACKIT Git management API. + + The version of the OpenAPI document: 1beta.0.4 + Contact: git@stackit.cloud + 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, StrictStr +from typing_extensions import Annotated, Self + + +class RunnerLabel(BaseModel): + """ + Describes a STACKIT Git RunnerLabel. + """ # noqa: E501 + + description: StrictStr = Field(description="RunnerLabel description.") + id: Annotated[str, Field(strict=True, max_length=36)] = Field(description="RunnerLabel id.") + label: Annotated[str, Field(strict=True, max_length=64)] = Field(description="RunnerLabel label.") + __properties: ClassVar[List[str]] = ["description", "id", "label"] + + 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 RunnerLabel 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 RunnerLabel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + {"description": obj.get("description"), "id": obj.get("id"), "label": obj.get("label")} + ) + return _obj