Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hemeryar committed Nov 14, 2024
1 parent 01d04c3 commit cf4c141
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions datadog/fwprovider/resource_datadog_rum_metric.go
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
Expand Down Expand Up @@ -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(),
Expand All @@ -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,
},
},
Expand All @@ -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,
},
},
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/rum_metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -65,24 +65,24 @@ 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`.


<a id="nestedblock--filter"></a>
### Nested Schema for `filter`

Optional:

- `query` (String) The search query - following the RUM search syntax.
- `query` (String) The search query. Follows RUM search syntax.


<a id="nestedblock--group_by"></a>
### Nested Schema for `group_by`

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.


<a id="nestedblock--uniqueness"></a>
Expand Down

0 comments on commit cf4c141

Please sign in to comment.