A Go SDK and Terraform provider for the Domeneshop API, generated from the OpenAPI spec under config/.
New specs can be found here: https://api.domeneshop.no/docs
The SDK is a thin client (sdk/) generated by OpenAPIGenerator, and the Terraform provider (provider/) is generated using tfplugingen-openapi and tfplugingen-framework
.
├── config/ # OpenAPI spec + generator configs
│ ├── openapi.json
│ ├── openapi_generator_config.yaml # openapi-generator (go client)
│ └── generator_config.yml # tfplugingen-openapi (provider scaffolding)
├── sdk/ # Go module: github.com/halvardssm/domeneshop-go/sdk
│ ├── go.mod
│ ├── api_*.go # generated API services (domains, dns, forwards, ...)
│ ├── model_*.go # generated models
│ └── test/ # generated API tests
├── provider/ # Go module: github.com/halvardssm/domeneshop-go/provider
│ ├── go.mod
│ ├── main.go # provider entrypoint
│ └── internal/provider/ # provider implementation (data sources & resources)
├── go.work # local development workspace
└── mise.toml # task runner & tool versions
- Go 1.22+
- mise (optional, but recommended — manages Go, Java, and the generators)
- openapi-generator-cli (for SDK generation)
Install tools via mise:
mise install# Generate the SDK and provider code from the OpenAPI spec
mise run gen
# Build everything
mise run build
# Run tests
mise run testAll generation is driven from config/openapi.json:
mise run gen # generates both the SDK and the provider scaffoldingUnder the hood:
mise run gen:sdkrunsopenapi-generator-cliusingconfig/openapi_generator_config.yaml→ outputs tosdk/mise run gen:configrunstfplugingen-openapiusingconfig/generator_config.yml→ producesconfig/provider_code_spec.jsonmise run gen:providerrunstfplugingen-framework→ outputs toprovider/internal/provider/
Generated files live alongside hand-written code. Regenerate after changing the OpenAPI spec.
import (
"context"
"github.com/halvardssm/domeneshop-go/sdk"
)
func main() {
cfg := sdk.NewConfiguration()
client := sdk.NewAPIClient(cfg)
ctx := context.WithValue(context.Background(), sdk.ContextBasicAuth, sdk.BasicAuth{
UserName: "your-token",
Password: "your-secret",
})
domains, _, err := client.DomainsAPI.GetDomains(ctx).Execute()
if err != nil {
panic(err)
}
// ...
}The provider is not yet on the Terraform Registry. For local development, build the binary and use dev_overrides:
cd provider
go build -o terraform-provider-domeneshop .~/.terraformrc:
provider_installation {
dev_overrides {
"registry.terraform.io/halvardssm/domeneshop" = "/absolute/path/to/domeneshop-go/provider"
}
direct {}
}terraform {
required_providers {
domeneshop = {
source = "registry.terraform.io/halvardssm/domeneshop"
}
}
}
provider "domeneshop" {
# token = "your-token"
# secret = "your-secret"
# or set env: DOMENESHOP_TOKEN, DOMENESHOP_SECRET
}
data "domeneshop_domains" "all" {}
output "domains" {
value = [for d in data.domeneshop_domains.all.domains : d.domain]
}export DOMENESHOP_TOKEN="your-api-token"
export DOMENESHOP_SECRET="your-api-secret"
# With dev_overrides, skip `terraform init` and run plan directly:
terraform plan| Type | Name | Description |
|---|---|---|
| Data source | domeneshop_domains |
List all domains |
| Data source | domeneshop_domain |
Get a single domain by ID |
| Data source | domeneshop_dns_records |
List DNS records for a domain |
| Data source | domeneshop_dns_record |
Get a single DNS record |
| Data source | domeneshop_forwards |
List HTTP forwards for a domain |
| Data source | domeneshop_forward |
Get a single HTTP forward |
| Resource | domeneshop_dns_record |
Manage DNS records |
| Resource | domeneshop_forward |
Manage HTTP forwards |
The Domeneshop API uses HTTP Basic Auth. Generate credentials at
domeneshop.no/admin?view=api.
The provider reads credentials from the provider block or environment variables:
| Source | Token | Secret |
|---|---|---|
| Provider block | token attribute |
secret attribute |
| Environment | DOMENESHOP_TOKEN |
DOMENESHOP_SECRET |
mise run fmt # format code
mise run vet # go vet both modules
mise run check # check formatting (CI gate)
mise run test # run tests
mise run build # build both modules
mise run tidy # go mod tidy both modulesThis repo contains two independently versioned Go modules:
| Module | Path | Tag format |
|---|---|---|
| SDK | github.com/halvardssm/domeneshop-go/sdk |
sdk/vX.Y.Z |
| Provider | github.com/halvardssm/domeneshop-go/provider |
provider/vX.Y.Z |
Tag with the prefix — bare vX.Y.Z tags will not resolve for submodule paths:
git tag sdk/v0.1.0
git push origin sdk/v0.1.0MIT © Halvard Mørstad