Skip to content

Commit c897d7b

Browse files
committed
✨ Automatic changes -> ✨ New server autogenerated files [ci skip]
1 parent cdce8b4 commit c897d7b

File tree

8 files changed

+371
-70
lines changed

8 files changed

+371
-70
lines changed

changes/20251128111914.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
@@ -153,6 +153,7 @@ Class | Method | HTTP request | Description
153153
*FPGAEntitlementsAPI* | [**UpdateFPGAEntitlement**](docs/FPGAEntitlementsAPI.md#updatefpgaentitlement) | **Put** /fpga-entitlements | Update an FPGA entitlement that defines which users are permitted to interact with an FPGA.
154154
*FPGAJobsAPI* | [**CancelFpgaJob**](docs/FPGAJobsAPI.md#cancelfpgajob) | **Post** /fpga-jobs/{jobName}/cancel | Cancel an FPGA job.
155155
*FPGAJobsAPI* | [**ClearFpgaJobArtefact**](docs/FPGAJobsAPI.md#clearfpgajobartefact) | **Delete** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Clear the job artefact.
156+
*FPGAJobsAPI* | [**CompleteFpgaJob**](docs/FPGAJobsAPI.md#completefpgajob) | **Post** /fpga-jobs/{jobName}/complete | Gracefully ends the job.
156157
*FPGAJobsAPI* | [**CreateFpgaJobArtefactManager**](docs/FPGAJobsAPI.md#createfpgajobartefactmanager) | **Post** /fpga-jobs/{jobName}/artefacts/ | Create a job artefact manager.
157158
*FPGAJobsAPI* | [**DeleteFpgaJob**](docs/FPGAJobsAPI.md#deletefpgajob) | **Delete** /fpga-jobs/{jobName} | Delete an FPGA job.
158159
*FPGAJobsAPI* | [**DownloadFpgaJobArtefact**](docs/FPGAJobsAPI.md#downloadfpgajobartefact) | **Get** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Download the artefact for the corresponding FPGA job.

client/api_fpga_jobs.go

Lines changed: 192 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

client/docs/FPGAJobItemLinks.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,18 @@ Name | Type | Description | Notes
1313
**Collection** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
1414
**Connect** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
1515
**Delete** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
16-
**Describedby** | [**HalLinkData**](HalLinkData.md) | |
16+
**Describedby** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
1717
**Details** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
1818
**Related** | [**HalLinkData**](HalLinkData.md) | |
1919
**Retain** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
2020
**Self** | [**HalLinkData**](HalLinkData.md) | |
21+
**Sunset** | Pointer to [**HalLinkData**](HalLinkData.md) | | [optional]
2122

2223
## Methods
2324

2425
### NewFPGAJobItemLinks
2526

26-
`func NewFPGAJobItemLinks(describedby HalLinkData, related HalLinkData, self HalLinkData, ) *FPGAJobItemLinks`
27+
`func NewFPGAJobItemLinks(related HalLinkData, self HalLinkData, ) *FPGAJobItemLinks`
2728

2829
NewFPGAJobItemLinks instantiates a new FPGAJobItemLinks object
2930
This constructor will assign default values to properties that have it defined,
@@ -182,6 +183,11 @@ and a boolean to check if the value has been set.
182183

183184
SetDescribedby sets Describedby field to given value.
184185

186+
### HasDescribedby
187+
188+
`func (o *FPGAJobItemLinks) HasDescribedby() bool`
189+
190+
HasDescribedby returns a boolean if a field has been set.
185191

186192
### GetDetails
187193

@@ -273,6 +279,31 @@ and a boolean to check if the value has been set.
273279
SetSelf sets Self field to given value.
274280

275281

282+
### GetSunset
283+
284+
`func (o *FPGAJobItemLinks) GetSunset() HalLinkData`
285+
286+
GetSunset returns the Sunset field if non-nil, zero value otherwise.
287+
288+
### GetSunsetOk
289+
290+
`func (o *FPGAJobItemLinks) GetSunsetOk() (*HalLinkData, bool)`
291+
292+
GetSunsetOk returns a tuple with the Sunset field if it's non-nil, zero value otherwise
293+
and a boolean to check if the value has been set.
294+
295+
### SetSunset
296+
297+
`func (o *FPGAJobItemLinks) SetSunset(v HalLinkData)`
298+
299+
SetSunset sets Sunset field to given value.
300+
301+
### HasSunset
302+
303+
`func (o *FPGAJobItemLinks) HasSunset() bool`
304+
305+
HasSunset returns a boolean if a field has been set.
306+
276307

277308
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
278309

client/docs/FPGAJobsAPI.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Method | HTTP request | Description
1010
------------- | ------------- | -------------
1111
[**CancelFpgaJob**](FPGAJobsAPI.md#CancelFpgaJob) | **Post** /fpga-jobs/{jobName}/cancel | Cancel an FPGA job.
1212
[**ClearFpgaJobArtefact**](FPGAJobsAPI.md#ClearFpgaJobArtefact) | **Delete** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Clear the job artefact.
13+
[**CompleteFpgaJob**](FPGAJobsAPI.md#CompleteFpgaJob) | **Post** /fpga-jobs/{jobName}/complete | Gracefully ends the job.
1314
[**CreateFpgaJobArtefactManager**](FPGAJobsAPI.md#CreateFpgaJobArtefactManager) | **Post** /fpga-jobs/{jobName}/artefacts/ | Create a job artefact manager.
1415
[**DeleteFpgaJob**](FPGAJobsAPI.md#DeleteFpgaJob) | **Delete** /fpga-jobs/{jobName} | Delete an FPGA job.
1516
[**DownloadFpgaJobArtefact**](FPGAJobsAPI.md#DownloadFpgaJobArtefact) | **Get** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Download the artefact for the corresponding FPGA job.
@@ -179,6 +180,78 @@ Name | Type | Description | Notes
179180
[[Back to README]](../README.md)
180181

181182

183+
## CompleteFpgaJob
184+
185+
> FPGAJobItem CompleteFpgaJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()
186+
187+
Gracefully ends the job.
188+
189+
190+
191+
### Example
192+
193+
```go
194+
package main
195+
196+
import (
197+
"context"
198+
"fmt"
199+
"os"
200+
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
201+
)
202+
203+
func main() {
204+
jobName := "jobName_example" // string | Unique ID of the FPGA job.
205+
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)
206+
207+
configuration := openapiclient.NewConfiguration()
208+
apiClient := openapiclient.NewAPIClient(configuration)
209+
resp, r, err := apiClient.FPGAJobsAPI.CompleteFpgaJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
210+
if err != nil {
211+
fmt.Fprintf(os.Stderr, "Error when calling `FPGAJobsAPI.CompleteFpgaJob``: %v\n", err)
212+
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
213+
}
214+
// response from `CompleteFpgaJob`: FPGAJobItem
215+
fmt.Fprintf(os.Stdout, "Response from `FPGAJobsAPI.CompleteFpgaJob`: %v\n", resp)
216+
}
217+
```
218+
219+
### Path Parameters
220+
221+
222+
Name | Type | Description | Notes
223+
------------- | ------------- | ------------- | -------------
224+
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
225+
**jobName** | **string** | Unique ID of the FPGA job. |
226+
227+
### Other Parameters
228+
229+
Other parameters are passed through a pointer to a apiCompleteFpgaJobRequest struct via the builder pattern
230+
231+
232+
Name | Type | Description | Notes
233+
------------- | ------------- | ------------- | -------------
234+
235+
**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. |
236+
237+
### Return type
238+
239+
[**FPGAJobItem**](FPGAJobItem.md)
240+
241+
### Authorization
242+
243+
[TokenAuth](../README.md#TokenAuth)
244+
245+
### HTTP request headers
246+
247+
- **Content-Type**: Not defined
248+
- **Accept**: application/json
249+
250+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
251+
[[Back to Model list]](../README.md#documentation-for-models)
252+
[[Back to README]](../README.md)
253+
254+
182255
## CreateFpgaJobArtefactManager
183256

184257
> ArtefactManagerItem CreateFpgaJobArtefactManager(ctx, jobName).ArtefactManagerItem(artefactManagerItem).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.135.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)