Skip to content

Commit 92a11c4

Browse files
acabarbayemonty-bot
authored andcommitted
✨ Automatic changes -> ✨ New server autogenerated files [ci skip]
1 parent e6874b4 commit 92a11c4

19 files changed

Lines changed: 499 additions & 111 deletions

changes/20250520013317.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/.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ docs/FPGAPayloadItemLinks.md
9191
docs/FPGAPayloadRepositories.md
9292
docs/FPGAPayloadsAPI.md
9393
docs/FPGATarget.md
94+
docs/FPGATargetID.md
9495
docs/FPGAWorkload.md
9596
docs/FPGAsAPI.md
9697
docs/FieldObject.md
@@ -224,6 +225,7 @@ model_fpga_payload_item.go
224225
model_fpga_payload_item_links.go
225226
model_fpga_payload_repositories.go
226227
model_fpga_target.go
228+
model_fpga_target_id.go
227229
model_fpga_workload.go
228230
model_generic_work_job_collection.go
229231
model_generic_work_job_item.go

client/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,7 @@ Class | Method | HTTP request | Description
297297
- [FPGAPayloadItemLinks](docs/FPGAPayloadItemLinks.md)
298298
- [FPGAPayloadRepositories](docs/FPGAPayloadRepositories.md)
299299
- [FPGATarget](docs/FPGATarget.md)
300+
- [FPGATargetID](docs/FPGATargetID.md)
300301
- [FPGAWorkload](docs/FPGAWorkload.md)
301302
- [FieldObject](docs/FieldObject.md)
302303
- [GenericWorkJobCollection](docs/GenericWorkJobCollection.md)

client/api_authorization.go

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

client/docs/AuthorizationAPI.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
238238

239239
## ListResourceInstanceEntitlements
240240

241-
> InstancePermissionCollection ListResourceInstanceEntitlements(ctx, resourceType, userName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Execute()
241+
> InstancePermissionCollection ListResourceInstanceEntitlements(ctx, resourceType, userName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
242242
243243
List the user's permissions for all instances of a resource type.
244244

@@ -262,10 +262,12 @@ func main() {
262262
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)
263263
embed := false // bool | Embedding: The whether or not to embed resources into the collection (rather than return links). (optional) (default to false)
264264
ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
265+
limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
266+
offset := int32(0) // int32 | Paging: The index of the first item to return in the resource. (optional) (default to 0)
265267

266268
configuration := openapiclient.NewConfiguration()
267269
apiClient := openapiclient.NewAPIClient(configuration)
268-
resp, r, err := apiClient.AuthorizationAPI.ListResourceInstanceEntitlements(context.Background(), resourceType, userName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Execute()
270+
resp, r, err := apiClient.AuthorizationAPI.ListResourceInstanceEntitlements(context.Background(), resourceType, userName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
269271
if err != nil {
270272
fmt.Fprintf(os.Stderr, "Error when calling `AuthorizationAPI.ListResourceInstanceEntitlements``: %v\n", err)
271273
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -296,6 +298,8 @@ Name | Type | Description | Notes
296298
**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. |
297299
**embed** | **bool** | Embedding: The whether or not to embed resources into the collection (rather than return links). | [default to false]
298300
**ifNoneMatch** | **string** | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. |
301+
**limit** | **int32** | Paging: The maximum number of items to return in a resource. | [default to 20]
302+
**offset** | **int32** | Paging: The index of the first item to return in the resource. | [default to 0]
299303

300304
### Return type
301305

client/docs/FPGAItem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
1717
**Deprecated** | **bool** | True if this FPGA is scheduled to be removed from the service. | [readonly]
1818
**DeprecationInfo** | Pointer to [**DeprecationInfo**](DeprecationInfo.md) | | [optional]
1919
**Description** | **string** | Description of the FPGA configuration | [readonly]
20-
**ExtraMetadata** | Pointer to **map[string]string** | Extra metadata to include for FPGAs. | [optional]
20+
**ExtraMetadata** | Pointer to **map[string]string** | Extra metadata describing FPGAs. | [optional]
2121
**Name** | **string** | Unique ID of this FPGA | [readonly]
2222
**Ready** | **bool** | True if this FPGA is ready to accept jobs to run. | [readonly]
2323
**Repositories** | Pointer to [**FPGAPayloadRepositories**](FPGAPayloadRepositories.md) | | [optional]

client/docs/FPGAJobItem.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
2323
**StepsTotal** | **NullableInt32** | The total number of steps that will need to be performed to complete the job. Please note: - This value also includes additional service orchestration steps, that are outside the core process, so may differ from the job progress indicated within job messages. - This value will only be available after the job has been started. | [readonly]
2424
**Success** | **bool** | True if the job was successful (this should be used in conjunction with the `done` property). | [readonly]
2525
**SupportConnection** | **bool** | True when the job allows direct connection to the job instance (application running on the FPGA). | [readonly]
26-
**Target** | [**FPGATarget**](FPGATarget.md) | |
26+
**Target** | [**FPGATargetID**](FPGATargetID.md) | |
2727
**Timeout** | Pointer to **int64** | The maximum time (in seconds) that the job will be allowed to run. After the timeout has expired the job will be aborted and reported as a failure. The timeout does not include any time the request spent being queued, waiting for the job to be started. | [optional] [default to 300]
2828
**Title** | Pointer to **NullableString** | Optional human-readable name of the FPGA job. | [optional]
2929
**Workload** | [**FPGAWorkload**](FPGAWorkload.md) | |
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
3232

3333
### NewFPGAJobItem
3434

35-
`func NewFPGAJobItem(links NullableFPGAJobItemLinks, metadata NullableCommonMetadata, connected bool, done bool, error_ bool, failure bool, name string, queued bool, readyForConnection bool, status string, stepsCompleted NullableInt32, stepsTotal NullableInt32, success bool, supportConnection bool, target FPGATarget, workload FPGAWorkload, ) *FPGAJobItem`
35+
`func NewFPGAJobItem(links NullableFPGAJobItemLinks, metadata NullableCommonMetadata, connected bool, done bool, error_ bool, failure bool, name string, queued bool, readyForConnection bool, status string, stepsCompleted NullableInt32, stepsTotal NullableInt32, success bool, supportConnection bool, target FPGATargetID, workload FPGAWorkload, ) *FPGAJobItem`
3636

3737
NewFPGAJobItem instantiates a new FPGAJobItem object
3838
This constructor will assign default values to properties that have it defined,
@@ -404,20 +404,20 @@ SetSupportConnection sets SupportConnection field to given value.
404404

405405
### GetTarget
406406

407-
`func (o *FPGAJobItem) GetTarget() FPGATarget`
407+
`func (o *FPGAJobItem) GetTarget() FPGATargetID`
408408

409409
GetTarget returns the Target field if non-nil, zero value otherwise.
410410

411411
### GetTargetOk
412412

413-
`func (o *FPGAJobItem) GetTargetOk() (*FPGATarget, bool)`
413+
`func (o *FPGAJobItem) GetTargetOk() (*FPGATargetID, bool)`
414414

415415
GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise
416416
and a boolean to check if the value has been set.
417417

418418
### SetTarget
419419

420-
`func (o *FPGAJobItem) SetTarget(v FPGATarget)`
420+
`func (o *FPGAJobItem) SetTarget(v FPGATargetID)`
421421

422422
SetTarget sets Target field to given value.
423423

client/docs/FPGAJobsAPI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1262,7 +1262,7 @@ import (
12621262

12631263
func main() {
12641264
fpgaName := "fpgaName_example" // string | Unique ID of an FPGA.
1265-
fPGAJobItem := *openapiclient.NewFPGAJobItem("TODO", "TODO", true, true, false, true, "332129b3-f14d-49d2-b9be-acd2abd80c6b", false, true, "INITIALISING", NullableInt32(50), NullableInt32(70), false, true, *openapiclient.NewFPGATarget("HardwareImage_example", "SoftwareImage_example"), *openapiclient.NewFPGAWorkload("payload0001", "./helloworld/sayhello")) // FPGAJobItem | A FPGA job to start.
1265+
fPGAJobItem := *openapiclient.NewFPGAJobItem("TODO", "TODO", true, true, false, true, "332129b3-f14d-49d2-b9be-acd2abd80c6b", false, true, "INITIALISING", NullableInt32(50), NullableInt32(70), false, true, *openapiclient.NewFPGATargetID("HardwareImage_example", "SoftwareImage_example"), *openapiclient.NewFPGAWorkload("payload0001", "./helloworld/sayhello")) // FPGAJobItem | A FPGA job to start.
12661266
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)
12671267

12681268
configuration := openapiclient.NewConfiguration()

client/docs/FPGATarget.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ SPDX-License-Identifier: Apache-2.0
99
Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
1111
**Description** | Pointer to **NullableString** | a human-readable description of the target | [optional]
12-
**HardwareImage** | **string** | identifier of the hardware image |
13-
**SoftwareImage** | **string** | identifier of the software image |
12+
**Details** | Pointer to **map[string]string** | Extra metadata describing FPGA targets | [optional]
13+
**Identifier** | [**FPGATargetID**](FPGATargetID.md) | |
1414
**Title** | Pointer to **string** | a human-readable name for the target | [optional]
1515

1616
## Methods
1717

1818
### NewFPGATarget
1919

20-
`func NewFPGATarget(hardwareImage string, softwareImage string, ) *FPGATarget`
20+
`func NewFPGATarget(identifier FPGATargetID, ) *FPGATarget`
2121

2222
NewFPGATarget instantiates a new FPGATarget object
2323
This constructor will assign default values to properties that have it defined,
@@ -67,44 +67,49 @@ HasDescription returns a boolean if a field has been set.
6767
`func (o *FPGATarget) UnsetDescription()`
6868

6969
UnsetDescription ensures that no value is present for Description, not even an explicit nil
70-
### GetHardwareImage
70+
### GetDetails
7171

72-
`func (o *FPGATarget) GetHardwareImage() string`
72+
`func (o *FPGATarget) GetDetails() map[string]string`
7373

74-
GetHardwareImage returns the HardwareImage field if non-nil, zero value otherwise.
74+
GetDetails returns the Details field if non-nil, zero value otherwise.
7575

76-
### GetHardwareImageOk
76+
### GetDetailsOk
7777

78-
`func (o *FPGATarget) GetHardwareImageOk() (*string, bool)`
78+
`func (o *FPGATarget) GetDetailsOk() (*map[string]string, bool)`
7979

80-
GetHardwareImageOk returns a tuple with the HardwareImage field if it's non-nil, zero value otherwise
80+
GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise
8181
and a boolean to check if the value has been set.
8282

83-
### SetHardwareImage
83+
### SetDetails
8484

85-
`func (o *FPGATarget) SetHardwareImage(v string)`
85+
`func (o *FPGATarget) SetDetails(v map[string]string)`
8686

87-
SetHardwareImage sets HardwareImage field to given value.
87+
SetDetails sets Details field to given value.
8888

89+
### HasDetails
8990

90-
### GetSoftwareImage
91+
`func (o *FPGATarget) HasDetails() bool`
9192

92-
`func (o *FPGATarget) GetSoftwareImage() string`
93+
HasDetails returns a boolean if a field has been set.
9394

94-
GetSoftwareImage returns the SoftwareImage field if non-nil, zero value otherwise.
95+
### GetIdentifier
9596

96-
### GetSoftwareImageOk
97+
`func (o *FPGATarget) GetIdentifier() FPGATargetID`
9798

98-
`func (o *FPGATarget) GetSoftwareImageOk() (*string, bool)`
99+
GetIdentifier returns the Identifier field if non-nil, zero value otherwise.
99100

100-
GetSoftwareImageOk returns a tuple with the SoftwareImage field if it's non-nil, zero value otherwise
101+
### GetIdentifierOk
102+
103+
`func (o *FPGATarget) GetIdentifierOk() (*FPGATargetID, bool)`
104+
105+
GetIdentifierOk returns a tuple with the Identifier field if it's non-nil, zero value otherwise
101106
and a boolean to check if the value has been set.
102107

103-
### SetSoftwareImage
108+
### SetIdentifier
104109

105-
`func (o *FPGATarget) SetSoftwareImage(v string)`
110+
`func (o *FPGATarget) SetIdentifier(v FPGATargetID)`
106111

107-
SetSoftwareImage sets SoftwareImage field to given value.
112+
SetIdentifier sets Identifier field to given value.
108113

109114

110115
### GetTitle

client/docs/FPGATargetID.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!--
2+
Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
3+
SPDX-License-Identifier: Apache-2.0
4+
-->
5+
# FPGATargetID
6+
7+
## Properties
8+
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**ExtraKeys** | Pointer to **map[string]string** | Additional keys which may be required to differentiate between targets when software and hardware images are not enough. | [optional]
12+
**HardwareImage** | **string** | identifier of the hardware image |
13+
**SoftwareImage** | **string** | identifier of the software image |
14+
15+
## Methods
16+
17+
### NewFPGATargetID
18+
19+
`func NewFPGATargetID(hardwareImage string, softwareImage string, ) *FPGATargetID`
20+
21+
NewFPGATargetID instantiates a new FPGATargetID object
22+
This constructor will assign default values to properties that have it defined,
23+
and makes sure properties required by API are set, but the set of arguments
24+
will change when the set of required properties is changed
25+
26+
### NewFPGATargetIDWithDefaults
27+
28+
`func NewFPGATargetIDWithDefaults() *FPGATargetID`
29+
30+
NewFPGATargetIDWithDefaults instantiates a new FPGATargetID object
31+
This constructor will only assign default values to properties that have it defined,
32+
but it doesn't guarantee that properties required by API are set
33+
34+
### GetExtraKeys
35+
36+
`func (o *FPGATargetID) GetExtraKeys() map[string]string`
37+
38+
GetExtraKeys returns the ExtraKeys field if non-nil, zero value otherwise.
39+
40+
### GetExtraKeysOk
41+
42+
`func (o *FPGATargetID) GetExtraKeysOk() (*map[string]string, bool)`
43+
44+
GetExtraKeysOk returns a tuple with the ExtraKeys field if it's non-nil, zero value otherwise
45+
and a boolean to check if the value has been set.
46+
47+
### SetExtraKeys
48+
49+
`func (o *FPGATargetID) SetExtraKeys(v map[string]string)`
50+
51+
SetExtraKeys sets ExtraKeys field to given value.
52+
53+
### HasExtraKeys
54+
55+
`func (o *FPGATargetID) HasExtraKeys() bool`
56+
57+
HasExtraKeys returns a boolean if a field has been set.
58+
59+
### SetExtraKeysNil
60+
61+
`func (o *FPGATargetID) SetExtraKeysNil(b bool)`
62+
63+
SetExtraKeysNil sets the value for ExtraKeys to be an explicit nil
64+
65+
### UnsetExtraKeys
66+
`func (o *FPGATargetID) UnsetExtraKeys()`
67+
68+
UnsetExtraKeys ensures that no value is present for ExtraKeys, not even an explicit nil
69+
### GetHardwareImage
70+
71+
`func (o *FPGATargetID) GetHardwareImage() string`
72+
73+
GetHardwareImage returns the HardwareImage field if non-nil, zero value otherwise.
74+
75+
### GetHardwareImageOk
76+
77+
`func (o *FPGATargetID) GetHardwareImageOk() (*string, bool)`
78+
79+
GetHardwareImageOk returns a tuple with the HardwareImage field if it's non-nil, zero value otherwise
80+
and a boolean to check if the value has been set.
81+
82+
### SetHardwareImage
83+
84+
`func (o *FPGATargetID) SetHardwareImage(v string)`
85+
86+
SetHardwareImage sets HardwareImage field to given value.
87+
88+
89+
### GetSoftwareImage
90+
91+
`func (o *FPGATargetID) GetSoftwareImage() string`
92+
93+
GetSoftwareImage returns the SoftwareImage field if non-nil, zero value otherwise.
94+
95+
### GetSoftwareImageOk
96+
97+
`func (o *FPGATargetID) GetSoftwareImageOk() (*string, bool)`
98+
99+
GetSoftwareImageOk returns a tuple with the SoftwareImage field if it's non-nil, zero value otherwise
100+
and a boolean to check if the value has been set.
101+
102+
### SetSoftwareImage
103+
104+
`func (o *FPGATargetID) SetSoftwareImage(v string)`
105+
106+
SetSoftwareImage sets SoftwareImage field to given value.
107+
108+
109+
110+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
111+
112+

0 commit comments

Comments
 (0)