All URIs are relative to https://all.api.keil.arm.com
| Method | HTTP request | Description |
|---|---|---|
| AddFPGAAdmin | Post /fpga-admins | Add a user to the FPGA admin group |
| ListFPGAAdmins | Get /fpga-admins | List all the members of the FPGA admin group |
| RemoveFPGAAdmin | Delete /fpga-admins/{fpgaAdminName} | Remove a user from the FPGA admin group |
FPGAAdminItem AddFPGAAdmin(ctx).FPGAAdminItem(fPGAAdminItem).AcceptVersion(acceptVersion).Execute()
Add a user to the FPGA admin group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
fPGAAdminItem := *openapiclient.NewFPGAAdminItem("TODO", "9a8f4eac-4c2b-4db5-88e4-42e05f9fca87") // FPGAAdminItem | Data required to add a user to the FPGA admin group.
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)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.FPGAAdminAPI.AddFPGAAdmin(context.Background()).FPGAAdminItem(fPGAAdminItem).AcceptVersion(acceptVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `FPGAAdminAPI.AddFPGAAdmin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AddFPGAAdmin`: FPGAAdminItem
fmt.Fprintf(os.Stdout, "Response from `FPGAAdminAPI.AddFPGAAdmin`: %v\n", resp)
}Other parameters are passed through a pointer to a apiAddFPGAAdminRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| fPGAAdminItem | FPGAAdminItem | Data required to add a user to the FPGA admin group. | |
| 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. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FPGAAdminCollection ListFPGAAdmins(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
List all the members of the FPGA admin group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
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)
embed := false // bool | Embedding: The whether or not to embed resources into the collection (rather than return links). (optional) (default to false)
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)
limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
offset := int32(0) // int32 | Paging: The index of the first item to return in the resource. (optional) (default to 0)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.FPGAAdminAPI.ListFPGAAdmins(context.Background()).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `FPGAAdminAPI.ListFPGAAdmins``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListFPGAAdmins`: FPGAAdminCollection
fmt.Fprintf(os.Stdout, "Response from `FPGAAdminAPI.ListFPGAAdmins`: %v\n", resp)
}Other parameters are passed through a pointer to a apiListFPGAAdminsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| 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. | |
| embed | bool | Embedding: The whether or not to embed resources into the collection (rather than return links). | [default to false] |
| 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. | |
| limit | int32 | Paging: The maximum number of items to return in a resource. | [default to 20] |
| offset | int32 | Paging: The index of the first item to return in the resource. | [default to 0] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveFPGAAdmin(ctx, fpgaAdminName).AcceptVersion(acceptVersion).Execute()
Remove a user from the FPGA admin group
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
fpgaAdminName := "fpgaAdminName_example" // string | Unique user ID a member of the FPGA admin group.
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)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.FPGAAdminAPI.RemoveFPGAAdmin(context.Background(), fpgaAdminName).AcceptVersion(acceptVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `FPGAAdminAPI.RemoveFPGAAdmin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| fpgaAdminName | string | Unique user ID a member of the FPGA admin group. |
Other parameters are passed through a pointer to a apiRemoveFPGAAdminRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]