Skip to content

Commit b95e87d

Browse files
committed
✨ Automatic changes -> ✨ New server autogenerated files [ci skip]
1 parent 40af677 commit b95e87d

File tree

8 files changed

+343
-52
lines changed

8 files changed

+343
-52
lines changed

changes/20251216145904.feature

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Updated client due to schema changes

client/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ Class | Method | HTTP request | Description
193193
*FPGAsAPI* | [**ListFPGAWorkers**](docs/FPGAsAPI.md#listfpgaworkers) | **Get** /fpgas/ | List available FPGAs.
194194
*FPGAsAPI* | [**UpdateFpga**](docs/FPGAsAPI.md#updatefpga) | **Put** /fpgas/{fpgaName} | Update the status of the FPGA.
195195
*GenericWorkJobsAPI* | [**CancelGenericWorkJob**](docs/GenericWorkJobsAPI.md#cancelgenericworkjob) | **Post** /generic-work-jobs/{jobName}/cancel | Cancel a generic job.
196+
*GenericWorkJobsAPI* | [**CompleteGenericWorkJob**](docs/GenericWorkJobsAPI.md#completegenericworkjob) | **Post** /generic-work-jobs/{jobName}/complete | Stop a generic job gracefully.
196197
*GenericWorkJobsAPI* | [**DeleteGenericWorkJob**](docs/GenericWorkJobsAPI.md#deletegenericworkjob) | **Delete** /generic-work-jobs/{jobName} | Delete a generic job.
197198
*GenericWorkJobsAPI* | [**GetGenericWorkJob**](docs/GenericWorkJobsAPI.md#getgenericworkjob) | **Get** /generic-work-jobs/{jobName} | Return the status of a Generic Work Job.
198199
*GenericWorkJobsAPI* | [**GetGenericWorkJobArtefactManager**](docs/GenericWorkJobsAPI.md#getgenericworkjobartefactmanager) | **Get** /generic-work-jobs/{jobName}/artefacts/{artefactName} | Get the job's artefact manager for the artefact named `artefactName`.

client/api_generic_work_jobs.go

Lines changed: 189 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

client/docs/GenericWorkJobItem.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
1111
**Links** | [**NullableGenericWorkJobItemLinks**](GenericWorkJobItemLinks.md) | |
1212
**Metadata** | [**NullableCommonMetadata**](CommonMetadata.md) | |
13+
**CompleteGracePeriod** | Pointer to **int32** | The maximum time (in seconds) to use in the event that a graceful shutdown is requested. A graceful shutdown consists of a SIGINT being sent to the process, waiting the specified duration, and then finally sending a SIGKILL to the process. This should be chosen such that any cleanup actions have time to occur. | [optional] [default to 30]
1314
**Configuration** | Pointer to **map[string]string** | Configuration map for jobs that require it. These could be environment variables. This is job implementation dependent and job documentation should describe it. | [optional]
1415
**Done** | **bool** | True when the job has completed (this does not necessarily indicate success). | [readonly]
1516
**Error** | **bool** | True if there was an error in the service while attempting the job. | [readonly]
@@ -106,6 +107,31 @@ SetMetadata sets Metadata field to given value.
106107
`func (o *GenericWorkJobItem) UnsetMetadata()`
107108

108109
UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil
110+
### GetCompleteGracePeriod
111+
112+
`func (o *GenericWorkJobItem) GetCompleteGracePeriod() int32`
113+
114+
GetCompleteGracePeriod returns the CompleteGracePeriod field if non-nil, zero value otherwise.
115+
116+
### GetCompleteGracePeriodOk
117+
118+
`func (o *GenericWorkJobItem) GetCompleteGracePeriodOk() (*int32, bool)`
119+
120+
GetCompleteGracePeriodOk returns a tuple with the CompleteGracePeriod field if it's non-nil, zero value otherwise
121+
and a boolean to check if the value has been set.
122+
123+
### SetCompleteGracePeriod
124+
125+
`func (o *GenericWorkJobItem) SetCompleteGracePeriod(v int32)`
126+
127+
SetCompleteGracePeriod sets CompleteGracePeriod field to given value.
128+
129+
### HasCompleteGracePeriod
130+
131+
`func (o *GenericWorkJobItem) HasCompleteGracePeriod() bool`
132+
133+
HasCompleteGracePeriod returns a boolean if a field has been set.
134+
109135
### GetConfiguration
110136

111137
`func (o *GenericWorkJobItem) GetConfiguration() map[string]string`

client/docs/GenericWorkJobsAPI.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All URIs are relative to *https://all.api.keil.arm.com*
99
Method | HTTP request | Description
1010
------------- | ------------- | -------------
1111
[**CancelGenericWorkJob**](GenericWorkJobsAPI.md#CancelGenericWorkJob) | **Post** /generic-work-jobs/{jobName}/cancel | Cancel a generic job.
12+
[**CompleteGenericWorkJob**](GenericWorkJobsAPI.md#CompleteGenericWorkJob) | **Post** /generic-work-jobs/{jobName}/complete | Stop a generic job gracefully.
1213
[**DeleteGenericWorkJob**](GenericWorkJobsAPI.md#DeleteGenericWorkJob) | **Delete** /generic-work-jobs/{jobName} | Delete a generic job.
1314
[**GetGenericWorkJob**](GenericWorkJobsAPI.md#GetGenericWorkJob) | **Get** /generic-work-jobs/{jobName} | Return the status of a Generic Work Job.
1415
[**GetGenericWorkJobArtefactManager**](GenericWorkJobsAPI.md#GetGenericWorkJobArtefactManager) | **Get** /generic-work-jobs/{jobName}/artefacts/{artefactName} | Get the job's artefact manager for the artefact named `artefactName`.
@@ -92,6 +93,78 @@ Name | Type | Description | Notes
9293
[[Back to README]](../README.md)
9394

9495

96+
## CompleteGenericWorkJob
97+
98+
> GenericWorkJobItem CompleteGenericWorkJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()
99+
100+
Stop a generic job gracefully.
101+
102+
103+
104+
### Example
105+
106+
```go
107+
package main
108+
109+
import (
110+
"context"
111+
"fmt"
112+
"os"
113+
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
114+
)
115+
116+
func main() {
117+
jobName := "jobName_example" // string | Unique ID of the generic work Job.
118+
acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
119+
120+
configuration := openapiclient.NewConfiguration()
121+
apiClient := openapiclient.NewAPIClient(configuration)
122+
resp, r, err := apiClient.GenericWorkJobsAPI.CompleteGenericWorkJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
123+
if err != nil {
124+
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.CompleteGenericWorkJob``: %v\n", err)
125+
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
126+
}
127+
// response from `CompleteGenericWorkJob`: GenericWorkJobItem
128+
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.CompleteGenericWorkJob`: %v\n", resp)
129+
}
130+
```
131+
132+
### Path Parameters
133+
134+
135+
Name | Type | Description | Notes
136+
------------- | ------------- | ------------- | -------------
137+
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
138+
**jobName** | **string** | Unique ID of the generic work Job. |
139+
140+
### Other Parameters
141+
142+
Other parameters are passed through a pointer to a apiCompleteGenericWorkJobRequest struct via the builder pattern
143+
144+
145+
Name | Type | Description | Notes
146+
------------- | ------------- | ------------- | -------------
147+
148+
**acceptVersion** | **string** | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. |
149+
150+
### Return type
151+
152+
[**GenericWorkJobItem**](GenericWorkJobItem.md)
153+
154+
### Authorization
155+
156+
[TokenAuth](../README.md#TokenAuth)
157+
158+
### HTTP request headers
159+
160+
- **Content-Type**: Not defined
161+
- **Accept**: application/json
162+
163+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
164+
[[Back to Model list]](../README.md#documentation-for-models)
165+
[[Back to README]](../README.md)
166+
167+
95168
## DeleteGenericWorkJob
96169

97170
> DeleteGenericWorkJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()

client/go.mod

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
11
module github.com/ARM-software/embedded-development-services-client/client
22

3-
go 1.25
3+
go 1.23
44

55
require (
6-
github.com/ARM-software/golang-utils/utils v1.136.0
7-
github.com/stretchr/testify v1.11.1
8-
)
9-
10-
require (
11-
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
12-
github.com/deckarep/golang-set/v2 v2.8.0 // indirect
13-
github.com/go-faker/faker/v4 v4.6.1 // indirect
14-
github.com/hashicorp/errwrap v1.0.0 // indirect
15-
github.com/hashicorp/go-multierror v1.1.1 // indirect
16-
github.com/petermattis/goid v0.0.0-20250813065127-a731cc31b4fe // indirect
17-
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
18-
github.com/sasha-s/go-deadlock v0.3.6 // indirect
19-
go.uber.org/atomic v1.11.0 // indirect
20-
golang.org/x/sync v0.16.0 // indirect
21-
golang.org/x/text v0.28.0 // indirect
22-
gopkg.in/yaml.v3 v3.0.1 // indirect
236
)

0 commit comments

Comments
 (0)