From 76d99ba2c67d5eabbacc46347f49487a8d20b910 Mon Sep 17 00:00:00 2001 From: akinross Date: Wed, 20 Nov 2024 08:02:08 +0100 Subject: [PATCH] [ignore] Change description for target attribute of qosDot1PClass and qosDscpClass --- docs/data-sources/custom_qos_policy.md | 4 ++-- docs/data-sources/dot1p_classifier.md | 2 +- docs/data-sources/dscp_to_priority_map.md | 2 +- docs/resources/custom_qos_policy.md | 4 ++-- docs/resources/dot1p_classifier.md | 2 +- docs/resources/dscp_to_priority_map.md | 2 +- gen/definitions/properties.yaml | 4 ++++ internal/provider/data_source_aci_custom_qos_policy.go | 4 ++-- internal/provider/data_source_aci_dot1p_classifier.go | 2 +- internal/provider/data_source_aci_dscp_to_priority_map.go | 2 +- internal/provider/resource_aci_custom_qos_policy.go | 4 ++-- internal/provider/resource_aci_dot1p_classifier.go | 2 +- internal/provider/resource_aci_dscp_to_priority_map.go | 2 +- 13 files changed, 20 insertions(+), 16 deletions(-) diff --git a/docs/data-sources/custom_qos_policy.md b/docs/data-sources/custom_qos_policy.md index 5632e7815..1863e8803 100644 --- a/docs/data-sources/custom_qos_policy.md +++ b/docs/data-sources/custom_qos_policy.md @@ -61,7 +61,7 @@ data "aci_custom_qos_policy" "example_tenant" { * `name` (name) - (string) The name of the Dot1p Classifier object. * `name_alias` (nameAlias) - (string) The name alias of the Dot1p Classifier object. * `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles. - * `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. + * `target` (target) - (string) The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. * `target_cos` (targetCos) - (string) Target COS to be driven based on the range of input values of DSCP coming into the fabric. * `to` (to) - (string) The Dot1p priority range ending value. @@ -72,7 +72,7 @@ data "aci_custom_qos_policy" "example_tenant" { * `name` (name) - (string) The name of the DSCP to Priority Map object. * `name_alias` (nameAlias) - (string) The name alias of the DSCP to Priority Map object. * `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles. - * `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. + * `target` (target) - (string) The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. * `target_cos` (targetCos) - (string) Target COS to be driven based on the range of input values of DSCP coming into the fabric. * `to` (to) - (string) The DSCP range ending value. diff --git a/docs/data-sources/dot1p_classifier.md b/docs/data-sources/dot1p_classifier.md index a21400068..22987faf0 100644 --- a/docs/data-sources/dot1p_classifier.md +++ b/docs/data-sources/dot1p_classifier.md @@ -57,7 +57,7 @@ data "aci_dot1p_classifier" "example_custom_qos_policy" { * `name` (name) - (string) The name of the Dot1p Classifier object. * `name_alias` (nameAlias) - (string) The name alias of the Dot1p Classifier object. * `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles. -* `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. +* `target` (target) - (string) The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. * `target_cos` (targetCos) - (string) Target COS to be driven based on the range of input values of DSCP coming into the fabric. * `annotations` - (list) A list of Annotations (ACI object [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. diff --git a/docs/data-sources/dscp_to_priority_map.md b/docs/data-sources/dscp_to_priority_map.md index 25fdf665a..2028aa3c1 100644 --- a/docs/data-sources/dscp_to_priority_map.md +++ b/docs/data-sources/dscp_to_priority_map.md @@ -57,7 +57,7 @@ data "aci_dscp_to_priority_map" "example_custom_qos_policy" { * `name` (name) - (string) The name of the DSCP to Priority Map object. * `name_alias` (nameAlias) - (string) The name alias of the DSCP to Priority Map object. * `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles. -* `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. +* `target` (target) - (string) The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. * `target_cos` (targetCos) - (string) Target COS to be driven based on the range of input values of DSCP coming into the fabric. * `annotations` - (list) A list of Annotations (ACI object [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. diff --git a/docs/resources/custom_qos_policy.md b/docs/resources/custom_qos_policy.md index 01bda4adc..b9161a51e 100644 --- a/docs/resources/custom_qos_policy.md +++ b/docs/resources/custom_qos_policy.md @@ -136,7 +136,7 @@ All examples for the Custom Qos Policy resource can be found in the [examples](h * `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles. - Default: `unspecified` - Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`. - * `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. + * `target` (target) - (string) The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. - Default: `unspecified` - Valid Values: `AF11`, `AF12`, `AF13`, `AF21`, `AF22`, `AF23`, `AF31`, `AF32`, `AF33`, `AF41`, `AF42`, `AF43`, `CS0`, `CS1`, `CS2`, `CS3`, `CS4`, `CS5`, `CS6`, `CS7`, `EF`, `VA`, `unspecified`. * `target_cos` (targetCos) - (string) Target COS to be driven based on the range of input values of DSCP coming into the fabric. @@ -160,7 +160,7 @@ All examples for the Custom Qos Policy resource can be found in the [examples](h * `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles. - Default: `unspecified` - Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`. - * `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. + * `target` (target) - (string) The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. - Default: `unspecified` - Valid Values: `AF11`, `AF12`, `AF13`, `AF21`, `AF22`, `AF23`, `AF31`, `AF32`, `AF33`, `AF41`, `AF42`, `AF43`, `CS0`, `CS1`, `CS2`, `CS3`, `CS4`, `CS5`, `CS6`, `CS7`, `EF`, `VA`, `unspecified`. * `target_cos` (targetCos) - (string) Target COS to be driven based on the range of input values of DSCP coming into the fabric. diff --git a/docs/resources/dot1p_classifier.md b/docs/resources/dot1p_classifier.md index d4b4a8a34..4af72d00b 100644 --- a/docs/resources/dot1p_classifier.md +++ b/docs/resources/dot1p_classifier.md @@ -107,7 +107,7 @@ All examples for the Dot1p Classifier resource can be found in the [examples](ht - Valid Values: * `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`. * Or a value in the range of `0` to `9`. -* `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. +* `target` (target) - (string) The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. - Default: `unspecified` - Valid Values: * `AF11`, `AF12`, `AF13`, `AF21`, `AF22`, `AF23`, `AF31`, `AF32`, `AF33`, `AF41`, `AF42`, `AF43`, `CS0`, `CS1`, `CS2`, `CS3`, `CS4`, `CS5`, `CS6`, `CS7`, `EF`, `VA`, `unspecified`. diff --git a/docs/resources/dscp_to_priority_map.md b/docs/resources/dscp_to_priority_map.md index 5c82417aa..131b99bee 100644 --- a/docs/resources/dscp_to_priority_map.md +++ b/docs/resources/dscp_to_priority_map.md @@ -107,7 +107,7 @@ All examples for the DSCP to Priority Map resource can be found in the [examples - Valid Values: * `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`. * Or a value in the range of `0` to `9`. -* `target` (target) - (string) Our Fabric only supports DSCP mutation. Dot1P mutation is not supported. +* `target` (target) - (string) The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported. - Default: `unspecified` - Valid Values: * `AF11`, `AF12`, `AF13`, `AF21`, `AF22`, `AF23`, `AF31`, `AF32`, `AF33`, `AF41`, `AF42`, `AF43`, `CS0`, `CS1`, `CS2`, `CS3`, `CS4`, `CS5`, `CS6`, `CS7`, `EF`, `VA`, `unspecified`. diff --git a/gen/definitions/properties.yaml b/gen/definitions/properties.yaml index 779e347a4..49d16959c 100644 --- a/gen/definitions/properties.yaml +++ b/gen/definitions/properties.yaml @@ -918,6 +918,8 @@ qosDscpClass: - class_name: "qosCustomPol" parent_dependency: "fvTenant" parent_dn: "aci_custom_qos_policy.test.id" + documentation: + target: "The target of the %s object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported." test_values: default: from: "AF11" @@ -940,6 +942,8 @@ qosDot1PClass: - class_name: "qosCustomPol" parent_dependency: "fvTenant" parent_dn: "aci_custom_qos_policy.test.id" + documentation: + target: "The target of the %s object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported." test_values: default: from: "1" diff --git a/internal/provider/data_source_aci_custom_qos_policy.go b/internal/provider/data_source_aci_custom_qos_policy.go index 727cb5f01..88f81cefc 100644 --- a/internal/provider/data_source_aci_custom_qos_policy.go +++ b/internal/provider/data_source_aci_custom_qos_policy.go @@ -107,7 +107,7 @@ func (d *QosCustomPolDataSource) Schema(ctx context.Context, req datasource.Sche "target": schema.StringAttribute{ CustomType: customTypes.QosDot1PClassTargetStringType{}, Computed: true, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDot1PClassTargetCosStringType{}, @@ -156,7 +156,7 @@ func (d *QosCustomPolDataSource) Schema(ctx context.Context, req datasource.Sche "target": schema.StringAttribute{ CustomType: customTypes.QosDscpClassTargetStringType{}, Computed: true, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDscpClassTargetCosStringType{}, diff --git a/internal/provider/data_source_aci_dot1p_classifier.go b/internal/provider/data_source_aci_dot1p_classifier.go index d2f21677d..4725de36e 100644 --- a/internal/provider/data_source_aci_dot1p_classifier.go +++ b/internal/provider/data_source_aci_dot1p_classifier.go @@ -78,7 +78,7 @@ func (d *QosDot1PClassDataSource) Schema(ctx context.Context, req datasource.Sch "target": schema.StringAttribute{ CustomType: customTypes.QosDot1PClassTargetStringType{}, Computed: true, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDot1PClassTargetCosStringType{}, diff --git a/internal/provider/data_source_aci_dscp_to_priority_map.go b/internal/provider/data_source_aci_dscp_to_priority_map.go index df39aa013..1961aa96e 100644 --- a/internal/provider/data_source_aci_dscp_to_priority_map.go +++ b/internal/provider/data_source_aci_dscp_to_priority_map.go @@ -78,7 +78,7 @@ func (d *QosDscpClassDataSource) Schema(ctx context.Context, req datasource.Sche "target": schema.StringAttribute{ CustomType: customTypes.QosDscpClassTargetStringType{}, Computed: true, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDscpClassTargetCosStringType{}, diff --git a/internal/provider/resource_aci_custom_qos_policy.go b/internal/provider/resource_aci_custom_qos_policy.go index bdb564ad2..0a2fa6b6d 100644 --- a/internal/provider/resource_aci_custom_qos_policy.go +++ b/internal/provider/resource_aci_custom_qos_policy.go @@ -384,7 +384,7 @@ func (r *QosCustomPolResource) Schema(ctx context.Context, req resource.SchemaRe validators.InBetweenFromString(0, 64), ), }, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDot1PClassTargetCosStringType{}, @@ -501,7 +501,7 @@ func (r *QosCustomPolResource) Schema(ctx context.Context, req resource.SchemaRe validators.InBetweenFromString(0, 64), ), }, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDscpClassTargetCosStringType{}, diff --git a/internal/provider/resource_aci_dot1p_classifier.go b/internal/provider/resource_aci_dot1p_classifier.go index d38d3ac3f..e2fcbf352 100644 --- a/internal/provider/resource_aci_dot1p_classifier.go +++ b/internal/provider/resource_aci_dot1p_classifier.go @@ -254,7 +254,7 @@ func (r *QosDot1PClassResource) Schema(ctx context.Context, req resource.SchemaR validators.InBetweenFromString(0, 64), ), }, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the Dot1p Classifier object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDot1PClassTargetCosStringType{}, diff --git a/internal/provider/resource_aci_dscp_to_priority_map.go b/internal/provider/resource_aci_dscp_to_priority_map.go index 02dc52b11..2d0ba99dd 100644 --- a/internal/provider/resource_aci_dscp_to_priority_map.go +++ b/internal/provider/resource_aci_dscp_to_priority_map.go @@ -254,7 +254,7 @@ func (r *QosDscpClassResource) Schema(ctx context.Context, req resource.SchemaRe validators.InBetweenFromString(0, 64), ), }, - MarkdownDescription: `Our Fabric only supports DSCP mutation. Dot1P mutation is not supported.`, + MarkdownDescription: `The target of the DSCP to Priority Map object. This Fabric only supports DSCP mutation, Dot1P mutation is not supported.`, }, "target_cos": schema.StringAttribute{ CustomType: customTypes.QosDscpClassTargetCosStringType{},