phoenixnap/go-sdk-bmc

Go SDK for the Bare Metal Cloud API

go-sdk-bmc's Issues

Fix Version Information and examples in generated README files

The current generated module readme files (example) contain incorrect Package version details. Additionally, the examples in these Readme files should ideally contain an explanation to how an auth token can be generated.

This can be achieved by modifying the opeanpi-generator templates used to generate these files: https://openapi-generator.tech/docs/templating

Publish BMC GO SDK v2 in pkg.go.dev

[https://github.com/phoenixnap/go-sdk-bmc]

[https://pkg.go.dev/github.com/phoenixnap/go-sdk-bmc/bmcapi#section-readme]

The latest version of GO SDK BMC is on v2.1.0. However, Go Package Index is showing v1.1.0 as the latest version. Go suggests a special approach when it comes to major version releases from v2 and onwards. More details can be found in

• https://go.dev/blog/v2-go-modules
• https://donatstudios.com/Go-v2-Modules.

Fix Version Information in Package Sources

openapi-generator is currently hard coding package versions in the generated code, using the version information provided at generation.

In this case, we need to specify the version at release time, rather than at generation. For this reason the generation templates should be updated to read version information from a resource file within the code itself, that will be manually maintained to correspond to the actual version being released.

This version information will also be needed for sending the X-Powered-by and User-Agent headers

Adding Generation Workflow

This issue involves the introduction of a generation workflow to this repository, that will download API specs and generate, build, and test update versions of this SDK periodically, prior to pushing any changes to develop.

Set default header for X-Powered-By

Configure requests coming from GO SDK BMC with default X-Powered-By header