stackit-dev-tools/terraform-provider-stackitprivatepreview
2
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Improve description for default fields (#369)

Browse source
This commit is contained in:
Vicente Pinto 2024-05-21 11:14:16 +01:00 • committed by GitHub
parent e4bbcfd50a
commit e2e5f19a29
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 26 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

10
stackit/internal/services/argus/scrapeconfig/resource.go
View file

@ -203,13 +203,13 @@ func (r *scrapeConfigResource) Schema(_ context.Context, _ resource.SchemaReques
},
"scheme": schema.StringAttribute{
Description: "Specifies the http scheme. E.g. `https`.",
Description: "Specifies the http scheme. Defaults to `https`.",
Optional: true,
Computed: true,
Default: stringdefault.StaticString(DefaultScheme),
},
"scrape_interval": schema.StringAttribute{
Description: "Specifies the scrape interval as duration string. E.g. `5m`.",
Description: "Specifies the scrape interval as duration string. Defaults to `5m`.",
Optional: true,
Computed: true,
Validators: []validator.String{
@ -218,7 +218,7 @@ func (r *scrapeConfigResource) Schema(_ context.Context, _ resource.SchemaReques
Default: stringdefault.StaticString(DefaultScrapeInterval),
},
"scrape_timeout": schema.StringAttribute{
Description: "Specifies the scrape timeout as duration string. E.g.`2m`.",
Description: "Specifies the scrape timeout as duration string. Defaults to `2m`.",
Optional: true,
Computed: true,
Validators: []validator.String{
@ -227,7 +227,7 @@ func (r *scrapeConfigResource) Schema(_ context.Context, _ resource.SchemaReques
Default: stringdefault.StaticString(DefaultScrapeTimeout),
},
"sample_limit": schema.Int64Attribute{
Description: "Specifies the scrape sample limit. Upper limit depends on the service plan. Default is `5000`.",
Description: "Specifies the scrape sample limit. Upper limit depends on the service plan. Defaults to `5000`.",
Optional: true,
Computed: true,
Validators: []validator.Int64{
@ -251,7 +251,7 @@ func (r *scrapeConfigResource) Schema(_ context.Context, _ resource.SchemaReques
),
Attributes: map[string]schema.Attribute{
"enable_url_parameters": schema.BoolAttribute{
Description: "Specifies if URL parameters are enabled.",
Description: "Specifies if URL parameters are enabled. Defaults to `true`",
Optional: true,
Computed: true,
Default: booldefault.StaticBool(DefaultSAML2EnableURLParameters),

2
stackit/internal/services/dns/recordset/resource.go
View file

@ -184,7 +184,7 @@ func (r *recordSetResource) Schema(_ context.Context, _ resource.SchemaRequest,
},
},
"active": schema.BoolAttribute{
Description: "Specifies if the record set is active or not.",
Description: "Specifies if the record set is active or not. Defaults to `true`",
Optional: true,
Computed: true,
Default: booldefault.StaticBool(true),

4
stackit/internal/services/dns/zone/resource.go
View file

@ -211,7 +211,7 @@ func (r *zoneResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
},
},
"is_reverse_zone": schema.BoolAttribute{
Description: "Specifies, if the zone is a reverse zone or not.",
Description: "Specifies, if the zone is a reverse zone or not. Defaults to `false`",
Optional: true,
Computed: true,
Default: booldefault.StaticBool(false),
@ -254,7 +254,7 @@ func (r *zoneResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
},
},
"type": schema.StringAttribute{
Description: "Zone type. E.g. `primary`",
Description: "Zone type. Defaults to `primary`",
Optional: true,
Computed: true,
Default: stringdefault.StaticString("primary"),

8
stackit/internal/services/ske/cluster/resource.go
View file

@ -375,7 +375,7 @@ func (r *clusterResource) Schema(_ context.Context, _ resource.SchemaRequest, re
},
},
"os_name": schema.StringAttribute{
Description: "The name of the OS image. E.g. `flatcar`.",
Description: "The name of the OS image. Defaults to `flatcar`.",
Optional: true,
Computed: true,
Default: stringdefault.StaticString(DefaultOSName),
@ -397,13 +397,13 @@ func (r *clusterResource) Schema(_ context.Context, _ resource.SchemaRequest, re
Computed: true,
},
"volume_type": schema.StringAttribute{
Description: "Specifies the volume type. E.g. `storage_premium_perf1`.",
Description: "Specifies the volume type. Defaults to `storage_premium_perf1`.",
Optional: true,
Computed: true,
Default: stringdefault.StaticString(DefaultVolumeType),
},
"volume_size": schema.Int64Attribute{
Description: "The volume size in GB. E.g. `20`",
Description: "The volume size in GB. Defaults to `20`",
Optional: true,
Computed: true,
Default: int64default.StaticInt64(DefaultVolumeSizeGB),
@ -441,7 +441,7 @@ func (r *clusterResource) Schema(_ context.Context, _ resource.SchemaRequest, re
},
},
"cri": schema.StringAttribute{
Description: "Specifies the container runtime. E.g. `containerd`",
Description: "Specifies the container runtime. Defaults to `containerd`",
Optional: true,
Computed: true,
Default: stringdefault.StaticString(DefaultCRI),

2
stackit/internal/services/ske/kubeconfig/resource.go
View file

@ -105,7 +105,7 @@ func (r *kubeconfigResource) Schema(_ context.Context, _ resource.SchemaRequest,
"cluster_name": "Name of the SKE cluster.",
"project_id": "STACKIT project ID to which the cluster is associated.",
"kube_config": "Raw short-lived admin kubeconfig.",
"expiration": "Expiration time of the kubeconfig, in seconds.",
"expiration": "Expiration time of the kubeconfig, in seconds. Defaults to `3600`",
"expires_at": "Timestamp when the kubeconfig expires",
"refresh": "If set to true, the provider will check if the kubeconfig has expired and will generated a new valid one in-place",
}