Skip to content

Commit b00b58c

Browse files
akinrosslhercot
authored andcommitted
[ignore] fix read-only attributes to be set in the read-only section of resource documentation
1 parent aa319e6 commit b00b58c

File tree

4 files changed

+19
-11
lines changed

4 files changed

+19
-11
lines changed

docs/resources/application_epg.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,9 @@ All examples for the Application EPG resource can be found in the [examples](htt
413413
### Read-Only ###
414414

415415
* `id` - (string) The distinguished name (DN) of the Application EPG object.
416+
* `pc_tag` (pcTag) - (string) The classification tag used for policy enforcement and zoning.
417+
* `scope` (scope) - (string) The scope ID (L3-VNI) of the Application EPG object.
418+
- Default: `0`
416419

417420
### Optional ###
418421

@@ -439,15 +442,12 @@ All examples for the Application EPG resource can be found in the [examples](htt
439442
* `intra_epg_isolation` (pcEnfPref) - (string) Parameter used to determine whether communication between endpoints within the EPG is blocked.
440443
- Default: `unenforced`
441444
- Valid Values: `enforced`, `unenforced`.
442-
* `pc_tag` (pcTag) - (string) The classification tag used for policy enforcement and zoning.
443445
* `preferred_group_member` (prefGrMemb) - (string) Parameter used to determine whether the EPG is part of the preferred group. Members of this group are allowed to communicate without contracts.
444446
- Default: `exclude`
445447
- Valid Values: `exclude`, `include`.
446448
* `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.
447449
- Default: `unspecified`
448450
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.
449-
* `scope` (scope) - (string) The scope ID (L3-VNI) of the Application EPG object.
450-
- Default: `0`
451451
* `admin_state` (shutdown) - (string) Withdraw AEPg Configuration from all Nodes in the Fabric.
452452
- Default: `no`
453453
- Valid Values: `no`, `yes`.

docs/resources/bridge_domain.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,10 @@ All examples for the Bridge Domain resource can be found in the [examples](https
331331
### Read-Only ###
332332

333333
* `id` - (string) The distinguished name (DN) of the Bridge Domain object.
334+
* `pc_tag` (pcTag) - (string) The classification tag used for policy enforcement and zoning.
335+
* `scope` (scope) - (string) The scope ID (L3-VNI) of the Bridge Domain object.
336+
- Default: `0`
337+
* `segment` (seg) - (string) The segment ID (L2-VNI) of the Bridge Domain object.
334338

335339
### Optional ###
336340

@@ -384,10 +388,6 @@ All examples for the Bridge Domain resource can be found in the [examples](https
384388
* `name_alias` (nameAlias) - (string) The name alias of the Bridge Domain object.
385389
* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation.
386390
* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object.
387-
* `pc_tag` (pcTag) - (string) The classification tag used for policy enforcement and zoning.
388-
* `scope` (scope) - (string) The scope ID (L3-VNI) of the Bridge Domain object.
389-
- Default: `0`
390-
* `segment` (seg) - (string) The segment ID (L2-VNI) of the Bridge Domain object.
391391
* `service_bd_routing_disable` (serviceBdRoutingDisable) - (string) Disable Routing on service BD.
392392
- Default: `no`
393393
- Valid Values: `no`, `yes`.

docs/resources/endpoint_security_group.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,9 @@ All examples for the Endpoint Security Group resource can be found in the [examp
196196
### Read-Only ###
197197

198198
* `id` - (string) The distinguished name (DN) of the Endpoint Security Group object.
199+
* `pc_tag` (pcTag) - (string) The classification tag used for policy enforcement and zoning.
200+
* `scope` (scope) - (string) The scope ID (L3-VNI) of the Endpoint Security Group object.
201+
- Default: `0`
199202

200203
### Optional ###
201204

@@ -210,12 +213,9 @@ All examples for the Endpoint Security Group resource can be found in the [examp
210213
* `intra_esg_isolation` (pcEnfPref) - (string) Parameter used to determine whether communication between endpoints within the ESG is blocked.
211214
- Default: `unenforced`
212215
- Valid Values: `enforced`, `unenforced`.
213-
* `pc_tag` (pcTag) - (string) The classification tag used for policy enforcement and zoning.
214216
* `preferred_group_member` (prefGrMemb) - (string) Parameter used to determine whether the ESG is part of the preferred group. Members of this group are allowed to communicate without contracts.
215217
- Default: `exclude`
216218
- Valid Values: `exclude`, `include`.
217-
* `scope` (scope) - (string) The scope ID (L3-VNI) of the Endpoint Security Group object.
218-
- Default: `0`
219219
* `admin_state` (shutdown) - (string) Withdraw the ESG configuration from all nodes in the fabric.
220220
- Default: `no`
221221
- Valid Values: `no`, `yes`.

gen/templates/resource.md.tmpl

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,14 @@ All examples for the {{.ResourceNameAsDescription}} resource can be found in the
9090
### Read-Only ###
9191

9292
* `id` - (string) The distinguished name (DN) of the {{.ResourceNameAsDescription}} object.
93+
{{- range .Properties}}
94+
{{- if .ReadOnly}}
95+
* `{{- overwriteProperty .PkgName .SnakeCaseName $.Definitions}}` ({{- .PropertyName}}) - (string) {{.Comment}}{{if and (ne $.Versions .Versions) (ne .Versions "")}} This attribute is supported in ACI versions: {{ .Versions}}{{- end}}
96+
{{- if .DefaultValue }}
97+
- Default: `{{ .DefaultValue }}`
98+
{{- end}}
99+
{{- end }}
100+
{{- end }}
93101
{{- if .HasOptionalProperties}}
94102

95103
### Optional ###
@@ -101,7 +109,7 @@ All examples for the {{.ResourceNameAsDescription}} resource can be found in the
101109
- Default: `{{ getDefaultValues .PkgName "parent_dn" $.Definitions}}`
102110
{{- end}}
103111
{{- range .Properties}}
104-
{{- if and (not .IsNaming) (not .IsRequired)}}
112+
{{- if and (and (not .IsNaming) (not .IsRequired)) (not .ReadOnly)}}
105113
{{- if eq .ValueType "bitmask"}}
106114
* `{{- overwriteProperty .PkgName .SnakeCaseName $.Definitions}}` ({{- .PropertyName}}) - (list) {{.Comment}}{{if and (ne $.Versions .Versions) (ne .Versions "")}} This attribute is supported in ACI versions: {{ .Versions}}{{- end}}
107115
{{- if .DefaultValue }}

0 commit comments

Comments
 (0)