diff --git a/CHANGELOG.md b/CHANGELOG.md index 825bf3d6..84bcb742 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,8 @@ - `kms`: [v0.0.2](services/kms/CHANGELOG.md#v002-2025-05-05) - **Minor change:** Use stderr by default. - **Minor change:** Service update. +- `git`: [v0.1.1](services/git/CHANGELOG.md#v011-2025-05-05) + - **Bugfix**: Spelling corrections in documentation ## Release (2025-04-30) - `stackitmarketplace`: [v0.4.0](services/stackitmarketplace/CHANGELOG.md#v040-2025-04-16) diff --git a/services/git/CHANGELOG.md b/services/git/CHANGELOG.md index 092b22f2..596b3c61 100644 --- a/services/git/CHANGELOG.md +++ b/services/git/CHANGELOG.md @@ -1,3 +1,6 @@ +## v0.1.1 (2025-05-05) +- **Bugfix**: Spelling corrections in documentation + ## v0.1.0 (2025-04-23) - **New**: STACKIT Git module can be used to manage STACKIT Git diff --git a/services/git/src/stackit/git/api/default_api.py b/services/git/src/stackit/git/api/default_api.py index 75ec52c1..bec029b1 100644 --- a/services/git/src/stackit/git/api/default_api.py +++ b/services/git/src/stackit/git/api/default_api.py @@ -63,9 +63,9 @@ def create_instance( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> Instance: - """Users with write-access to a project may create a new STACKIT Git instance by posting the instance creation request to this endpoint, which will schedule the creation of a new STACKIT Git instance within that project. + """Creates a new STACKIT Git instance within the project. - Creates a new STACKIT Git instance within the project. + Users with write-access to a project may create a new STACKIT Git instance by posting the instance creation request to this endpoint, which will schedule the creation of a new STACKIT Git instance within that project. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -140,9 +140,9 @@ def create_instance_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[Instance]: - """Users with write-access to a project may create a new STACKIT Git instance by posting the instance creation request to this endpoint, which will schedule the creation of a new STACKIT Git instance within that project. + """Creates a new STACKIT Git instance within the project. - Creates a new STACKIT Git instance within the project. + Users with write-access to a project may create a new STACKIT Git instance by posting the instance creation request to this endpoint, which will schedule the creation of a new STACKIT Git instance within that project. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -217,9 +217,9 @@ def create_instance_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Users with write-access to a project may create a new STACKIT Git instance by posting the instance creation request to this endpoint, which will schedule the creation of a new STACKIT Git instance within that project. + """Creates a new STACKIT Git instance within the project. - Creates a new STACKIT Git instance within the project. + Users with write-access to a project may create a new STACKIT Git instance by posting the instance creation request to this endpoint, which will schedule the creation of a new STACKIT Git instance within that project. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -349,9 +349,9 @@ def delete_instance( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Allows a user with write-access to a project to schedule the deletion of a STACKIT Git instance, which will soon eliminate all repositories & user metadata associated with that instance. This is a destructive operation. + """Deletes the given STACKIT Git instance. - Deletes the given STACKIT Git instance. + Allows a user with write-access to a project to schedule the deletion of a STACKIT Git instance, which will soon eliminate all repositories & user metadata associated with that instance. This is a destructive operation. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -425,9 +425,9 @@ def delete_instance_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Allows a user with write-access to a project to schedule the deletion of a STACKIT Git instance, which will soon eliminate all repositories & user metadata associated with that instance. This is a destructive operation. + """Deletes the given STACKIT Git instance. - Deletes the given STACKIT Git instance. + Allows a user with write-access to a project to schedule the deletion of a STACKIT Git instance, which will soon eliminate all repositories & user metadata associated with that instance. This is a destructive operation. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -501,9 +501,9 @@ def delete_instance_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Allows a user with write-access to a project to schedule the deletion of a STACKIT Git instance, which will soon eliminate all repositories & user metadata associated with that instance. This is a destructive operation. + """Deletes the given STACKIT Git instance. - Deletes the given STACKIT Git instance. + Allows a user with write-access to a project to schedule the deletion of a STACKIT Git instance, which will soon eliminate all repositories & user metadata associated with that instance. This is a destructive operation. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -626,9 +626,9 @@ def get_instance( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> Instance: - """Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. + """Returns the details for the given STACKIT Git instance. - Returns the details for the given STACKIT Git instance. + Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -701,9 +701,9 @@ def get_instance_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[Instance]: - """Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. + """Returns the details for the given STACKIT Git instance. - Returns the details for the given STACKIT Git instance. + Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -776,9 +776,9 @@ def get_instance_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. + """Returns the details for the given STACKIT Git instance. - Returns the details for the given STACKIT Git instance. + Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -899,9 +899,9 @@ def list_instances( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ListInstances: - """STACKIT Git instances exist within a project, and a project may have zero or more instances. This endpoint allows a user with read-access to a project to list all instances that exist within the specified project. + """Returns a list of all STACKIT Git instances within the project. - Returns a list of all STACKIT Git instances within the project. + STACKIT Git instances exist within a project, and a project may have zero or more instances. This endpoint allows a user with read-access to a project to list all instances that exist within the specified project. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -969,9 +969,9 @@ def list_instances_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[ListInstances]: - """STACKIT Git instances exist within a project, and a project may have zero or more instances. This endpoint allows a user with read-access to a project to list all instances that exist within the specified project. + """Returns a list of all STACKIT Git instances within the project. - Returns a list of all STACKIT Git instances within the project. + STACKIT Git instances exist within a project, and a project may have zero or more instances. This endpoint allows a user with read-access to a project to list all instances that exist within the specified project. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str @@ -1039,9 +1039,9 @@ def list_instances_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """STACKIT Git instances exist within a project, and a project may have zero or more instances. This endpoint allows a user with read-access to a project to list all instances that exist within the specified project. + """Returns a list of all STACKIT Git instances within the project. - Returns a list of all STACKIT Git instances within the project. + STACKIT Git instances exist within a project, and a project may have zero or more instances. This endpoint allows a user with read-access to a project to list all instances that exist within the specified project. :param project_id: The STACKIT portal project UUID the STACKIT Git instance is part of. (required) :type project_id: str diff --git a/services/git/src/stackit/git/models/create_instance_payload.py b/services/git/src/stackit/git/models/create_instance_payload.py index b3d1c355..793f64da 100644 --- a/services/git/src/stackit/git/models/create_instance_payload.py +++ b/services/git/src/stackit/git/models/create_instance_payload.py @@ -36,8 +36,8 @@ class CreateInstancePayload(BaseModel): @field_validator("name") def 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-_]+$/") + if not re.match(r"^[a-z]([a-z0-9\-]){0,30}[a-z0-9]+$", value): + raise ValueError(r"must validate the regular expression /^[a-z]([a-z0-9\-]){0,30}[a-z0-9]+$/") return value model_config = ConfigDict( diff --git a/services/git/src/stackit/git/models/instance.py b/services/git/src/stackit/git/models/instance.py index 33f93667..f500b2d2 100644 --- a/services/git/src/stackit/git/models/instance.py +++ b/services/git/src/stackit/git/models/instance.py @@ -28,21 +28,21 @@ class Instance(BaseModel): Describes a STACKIT Git instance. """ - created: datetime = Field(description="The date and time the creation of the STACKIT GIT instance was triggered.") + created: datetime = Field(description="The date and time the creation of the STACKIT Git instance was triggered.") id: Annotated[str, Field(strict=True, max_length=36)] = Field( - description="A auto generated unique id which identifies the STACKIT GIT instances." + description="A auto generated unique id which identifies the STACKIT Git instances." ) name: Annotated[str, Field(strict=True, max_length=32)] = Field( - description="A user chosen name to distinguish multiple STACKIT GIT instances." + description="A user chosen name to distinguish multiple STACKIT Git instances." ) state: Annotated[str, Field(strict=True, max_length=32)] = Field( - description="The current state of the STACKIT GIT instance." + description="The current state of the STACKIT Git instance." ) url: Annotated[str, Field(strict=True, max_length=2048)] = Field( - description="The URL for reaching the STACKIT GIT instance." + description="The URL for reaching the STACKIT Git instance." ) version: Annotated[str, Field(strict=True, max_length=20)] = Field( - description="The current version of STACKIT GIT deployed to the instance." + description="The current version of STACKIT Git deployed to the instance." ) __properties: ClassVar[List[str]] = ["created", "id", "name", "state", "url", "version"]