diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b3692380..d6a964cb8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,8 @@ - subscription products contain the plan id - `mongodbflex`: [1.0.0](services/mongodbflex/CHANGELOG.md#v100-2025-05-02) - **Breaking Change:** Introduce typed enum constants for status attributes +- `git`: [v0.3.2](services/git/CHANGELOG.md#v032-2025-05-02) + - **Bugfix**: Spelling corrections in documentation ## Release (2025-04-30) - `core`: [v0.17.1](core/CHANGELOG.md#v0171-2025-04-09) diff --git a/services/git/CHANGELOG.md b/services/git/CHANGELOG.md index 2c370e282..5f442b5e2 100644 --- a/services/git/CHANGELOG.md +++ b/services/git/CHANGELOG.md @@ -1,3 +1,6 @@ +## v0.3.2 (2025-05-02) +- **Bugfix**: Spelling corrections in documentation + ## v0.3.1 (2025-04-29) - **Bugfix:** Correctly handle empty payload in body diff --git a/services/git/api_default.go b/services/git/api_default.go index b9ad15634..8542c9b9f 100644 --- a/services/git/api_default.go +++ b/services/git/api_default.go @@ -155,9 +155,11 @@ func (r ApiCreateInstanceRequest) Execute() (*Instance, error) { } /* -CreateInstance: 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. +CreateInstance: 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId The STACKIT portal project UUID the STACKIT Git instance is part of. @@ -290,9 +292,11 @@ func (r ApiDeleteInstanceRequest) Execute() error { } /* -DeleteInstance: 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. +DeleteInstance: 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId The STACKIT portal project UUID the STACKIT Git instance is part of. @@ -439,9 +443,10 @@ func (r ApiGetInstanceRequest) Execute() (*Instance, error) { } /* -GetInstance: Provides detailed information about the state of an instance within the specified project including information about how to access the instance for further use. +GetInstance: 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId The STACKIT portal project UUID the STACKIT Git instance is part of. @@ -583,9 +588,11 @@ func (r ApiListInstancesRequest) Execute() (*ListInstances, error) { } /* -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. +ListInstances: 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId The STACKIT portal project UUID the STACKIT Git instance is part of. diff --git a/services/git/model_instance.go b/services/git/model_instance.go index 15c88ae5b..3886646c6 100644 --- a/services/git/model_instance.go +++ b/services/git/model_instance.go @@ -144,22 +144,22 @@ type InstanceGetVersionRetType = string // Instance Describes a STACKIT Git instance. type Instance struct { - // The date and time the creation of the STACKIT GIT instance was triggered. + // The date and time the creation of the STACKIT Git instance was triggered. // REQUIRED Created InstanceGetCreatedAttributeType `json:"created"` - // A auto generated unique id which identifies the STACKIT GIT instances. + // A auto generated unique id which identifies the STACKIT Git instances. // REQUIRED Id InstanceGetIdAttributeType `json:"id"` - // A user chosen name to distinguish multiple STACKIT GIT instances. + // A user chosen name to distinguish multiple STACKIT Git instances. // REQUIRED Name InstanceGetNameAttributeType `json:"name"` - // The current state of the STACKIT GIT instance. + // The current state of the STACKIT Git instance. // REQUIRED State InstanceGetStateAttributeType `json:"state"` - // The URL for reaching the STACKIT GIT instance. + // The URL for reaching the STACKIT Git instance. // REQUIRED Url InstanceGetUrlAttributeType `json:"url"` - // The current version of STACKIT GIT deployed to the instance. + // The current version of STACKIT Git deployed to the instance. // REQUIRED Version InstanceGetVersionAttributeType `json:"version"` }