Skip to content

Commit

Permalink
✨ Automatic changes -> ✨ New server autogenerated files [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
acabarbaye authored and monty-bot committed Dec 23, 2023
1 parent acf4af4 commit ef4d842
Show file tree
Hide file tree
Showing 74 changed files with 1,612 additions and 1,444 deletions.
1 change: 1 addition & 0 deletions changes/20231223012541.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated client due to schema changes
2 changes: 1 addition & 1 deletion client/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.1.0
7.2.0
16 changes: 8 additions & 8 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,20 @@ For more information, please visit [https://www.keil.com/](https://www.keil.com/

Install the following dependencies:

```shell
```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```golang
```go
import client "github.com/ARM-software/embedded-development-services-client/client"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang
```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

Expand All @@ -69,15 +69,15 @@ Default configuration comes with `Servers` field that contains server objects as

For using other server than the one defined on index 0 set context value `client.ContextServerIndex` of type `int`.

```golang
```go
ctx := context.WithValue(context.Background(), client.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `client.ContextServerVariables` of type `map[string]string`.

```golang
```go
ctx := context.WithValue(context.Background(), client.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Expand All @@ -91,7 +91,7 @@ Each operation can use different server URL defined using `OperationServers` map
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `client.ContextOperationServerIndices` and `client.ContextOperationServerVariables` context maps.

```golang
```go
ctx := context.WithValue(context.Background(), client.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
Expand Down Expand Up @@ -265,7 +265,7 @@ Authentication schemes defined for the API:

Example

```golang
```go
auth := context.WithValue(context.Background(), client.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```
Expand All @@ -276,7 +276,7 @@ r, err := client.Service.Operation(auth, args)

Example

```golang
```go
auth := context.WithValue(context.Background(), client.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```
Expand Down
388 changes: 194 additions & 194 deletions client/docs/BuildJobsAPI.md

Large diffs are not rendered by default.

106 changes: 53 additions & 53 deletions client/docs/CMSISBuildersAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,26 @@ Return details of specific CMSIS Builders.
package main

import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
"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)
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)
}
```

Expand Down Expand Up @@ -102,28 +102,28 @@ List available CMSIS Builders.
package main

import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
"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)
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)
}
```

Expand Down Expand Up @@ -176,26 +176,26 @@ Initiate a build using the specified CMSIS Builder.
package main

import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
"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)
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)
}
```

Expand Down
Loading

0 comments on commit ef4d842

Please sign in to comment.