From cf4c1411df9db04a392567fafce95991ea6a60c7 Mon Sep 17 00:00:00 2001 From: Arthur Hemery Date: Thu, 14 Nov 2024 17:22:44 +0100 Subject: [PATCH] Update doc --- datadog/fwprovider/resource_datadog_rum_metric.go | 10 +++++----- docs/resources/rum_metric.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/datadog/fwprovider/resource_datadog_rum_metric.go b/datadog/fwprovider/resource_datadog_rum_metric.go index ba3754c6b..979a040c5 100644 --- a/datadog/fwprovider/resource_datadog_rum_metric.go +++ b/datadog/fwprovider/resource_datadog_rum_metric.go @@ -73,7 +73,7 @@ func (r *rumMetricResource) Schema(_ context.Context, _ resource.SchemaRequest, Description: "Provides a Datadog RumMetric resource. This can be used to create and manage Datadog rum_metric.", Attributes: map[string]schema.Attribute{ "name": schema.StringAttribute{ - Description: "The name of the rum-based metric. This field can't be updated after creation.", + Description: "The name of the RUM-based metric. This field can't be updated after creation.", Required: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), @@ -103,7 +103,7 @@ func (r *rumMetricResource) Schema(_ context.Context, _ resource.SchemaRequest, Optional: true, }, "path": schema.StringAttribute{ - Description: "The path to the value the rum-based metric will aggregate on. Only present when `aggregation_type` is `distribution`.", + Description: "The path to the value the RUM-based metric will aggregate on. Only present when `aggregation_type` is `distribution`.", Optional: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), @@ -114,7 +114,7 @@ func (r *rumMetricResource) Schema(_ context.Context, _ resource.SchemaRequest, "filter": schema.SingleNestedBlock{ Attributes: map[string]schema.Attribute{ "query": schema.StringAttribute{ - Description: "The search query - following the RUM search syntax.", + Description: "The search query. Follows RUM search syntax.", Optional: true, }, }, @@ -123,11 +123,11 @@ func (r *rumMetricResource) Schema(_ context.Context, _ resource.SchemaRequest, NestedObject: schema.NestedBlockObject{ Attributes: map[string]schema.Attribute{ "path": schema.StringAttribute{ - Description: "The path to the value the rum-based metric will be aggregated over.", + Description: "The path to the value the RUM-based metric will be aggregated over.", Optional: true, }, "tag_name": schema.StringAttribute{ - Description: "Eventual name of the tag that gets created. By default, `path` is used as the tag name.", + Description: "Name of the tag that gets created. By default, `path` is used as the tag name.", Optional: true, }, }, diff --git a/docs/resources/rum_metric.md b/docs/resources/rum_metric.md index 63f2b8531..40997b787 100644 --- a/docs/resources/rum_metric.md +++ b/docs/resources/rum_metric.md @@ -42,7 +42,7 @@ resource "datadog_rum_metric" "testing_rum_metric" { ### Required - `event_type` (String) The type of RUM events to filter on. -- `name` (String) The name of the rum-based metric. This field can't be updated after creation. +- `name` (String) The name of the RUM-based metric. This field can't be updated after creation. ### Optional @@ -65,7 +65,7 @@ Required: Optional: - `include_percentiles` (Boolean) Toggle to include or exclude percentile aggregations for distribution metrics. Only present when `aggregation_type` is `distribution`. -- `path` (String) The path to the value the rum-based metric will aggregate on. Only present when `aggregation_type` is `distribution`. +- `path` (String) The path to the value the RUM-based metric will aggregate on. Only present when `aggregation_type` is `distribution`. @@ -73,7 +73,7 @@ Optional: Optional: -- `query` (String) The search query - following the RUM search syntax. +- `query` (String) The search query. Follows RUM search syntax. @@ -81,8 +81,8 @@ Optional: Optional: -- `path` (String) The path to the value the rum-based metric will be aggregated over. -- `tag_name` (String) Eventual name of the tag that gets created. By default, `path` is used as the tag name. +- `path` (String) The path to the value the RUM-based metric will be aggregated over. +- `tag_name` (String) Name of the tag that gets created. By default, `path` is used as the tag name.