All URIs are relative to https://all.api.keil.arm.com
| Method | HTTP request | Description |
|---|---|---|
| GetCmsisBuilder | Get /cmsis-builders/{builderName} | Return details of specific CMSIS Builders. |
| ListCmsisBuilders | Get /cmsis-builders/ | List available CMSIS Builders. |
| StartCmsisBuild | Post /cmsis-builders/{builderName} | Initiate a build using the specified CMSIS Builder. |
CmsisBuilderItem GetCmsisBuilder(ctx, builderName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
Return details of specific CMSIS Builders.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
builderName := "builderName_example" // string | The ID of the CMSIS Builder.
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)
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)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CMSISBuildersAPI.GetCmsisBuilder(context.Background(), builderName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CMSISBuildersAPI.GetCmsisBuilder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCmsisBuilder`: CmsisBuilderItem
fmt.Fprintf(os.Stdout, "Response from `CMSISBuildersAPI.GetCmsisBuilder`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| builderName | string | The ID of the CMSIS Builder. |
Other parameters are passed through a pointer to a apiGetCmsisBuilderRequest 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. | 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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CmsisBuilderCollection ListCmsisBuilders(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
List available CMSIS Builders.
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.CMSISBuildersAPI.ListCmsisBuilders(context.Background()).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CMSISBuildersAPI.ListCmsisBuilders``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListCmsisBuilders`: CmsisBuilderCollection
fmt.Fprintf(os.Stdout, "Response from `CMSISBuildersAPI.ListCmsisBuilders`: %v\n", resp)
}Other parameters are passed through a pointer to a apiListCmsisBuildersRequest 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]
BuildJobItem StartCmsisBuild(ctx, builderName).BuildJobItem(buildJobItem).AcceptVersion(acceptVersion).Execute()
Initiate a build using the specified CMSIS Builder.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
builderName := "builderName_example" // string | The ID of the CMSIS Builder.
buildJobItem := *openapiclient.NewBuildJobItem("TODO", "TODO", NullableInt32(50), NullableInt32(70), true, false, true, "332129b3-f14d-49d2-b9be-acd2abd80c6b", "workspace/debug-build.csolution.yaml", "INITIALISING", false) // BuildJobItem | A name of the CMSIS project to build.
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.CMSISBuildersAPI.StartCmsisBuild(context.Background(), builderName).BuildJobItem(buildJobItem).AcceptVersion(acceptVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CMSISBuildersAPI.StartCmsisBuild``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `StartCmsisBuild`: BuildJobItem
fmt.Fprintf(os.Stdout, "Response from `CMSISBuildersAPI.StartCmsisBuild`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| builderName | string | The ID of the CMSIS Builder. |
Other parameters are passed through a pointer to a apiStartCmsisBuildRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
buildJobItem | BuildJobItem | A name of the CMSIS project to build. | 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]