Skip to content

Commit

Permalink
[minor_changes] documentation fixes for fvRemoteId
Browse files Browse the repository at this point in the history
  • Loading branch information
abrahammughal committed Jun 10, 2024
1 parent 330067f commit 0153650
Show file tree
Hide file tree
Showing 11 changed files with 781 additions and 739 deletions.
3 changes: 2 additions & 1 deletion docs/data-sources/associated_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Data source for Associated Site

* Class: [fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview)

* Supported in ACI versions: 3.0(1k) and later.

* Distinguished Name Formats:
- `uni/tn-{name}/BD-{name}/stAsc`
Expand Down Expand Up @@ -66,7 +67,7 @@ data "aci_associated_site" "example_bridge_domain" {
* `name_alias` (nameAlias) - (string) The name alias of the Associated Site object.
* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation.
* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object.
* `site_id` (siteId) - (string) Local Site ID.
* `site_id` (siteId) - (string) A number between 0 and 1000 to identify the primary site being associated.

* `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.
* `key` (key) - (string) The key used to uniquely identify this configuration object.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/remote_site_id_mappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ data "aci_remote_site_id_mappings" "example_associated_site" {

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
* `site_id` (siteId) - (string) Remote Site ID.
* `site_id` (siteId) - (string) A number between 0 and 1000 to identify the remote site being associated with the primary site.

### Read-Only ###

Expand Down
3 changes: 2 additions & 1 deletion docs/resources/associated_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Manages ACI Associated Site

* Class: [fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview)

* Supported in ACI versions: 3.0(1k) and later.

* Distinguished Name Formats:
- `uni/tn-{name}/BD-{name}/stAsc`
Expand Down Expand Up @@ -117,7 +118,7 @@ All examples for the Associated Site resource can be found in the [examples](htt
- The distinquised name (DN) of classes below can be used but currently there is no available resource for it:
- [vnsEpgDefXlate](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vnsEpgDefXlate/overview)

* `site_id` (siteId) - (string) Local Site ID.
* `site_id` (siteId) - (string) A number between 0 and 1000 to identify the primary site being associated.

### Read-Only ###

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/remote_site_id_mappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ All examples for the Remote Site Id Mappings resource can be found in the [examp

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
* `site_id` (siteId) - (string) Remote Site ID.
* `site_id` (siteId) - (string) A number between 0 and 1000 to identify the remote site being associated with the primary site.

### Read-Only ###

Expand Down
4 changes: 4 additions & 0 deletions gen/definitions/properties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,8 @@ fvFBRMember:
fvSiteAssociated:
overwrites:
siteId: "site_id"
documentation:
siteId: "A number between 0 and 1000 to identify the primary site being associated"
test_values:
all:
site_id: "0"
Expand All @@ -217,6 +219,8 @@ fvSiteAssociated:
fvRemoteId:
overwrites:
siteId: "site_id"
documentation:
siteId: "A number between 0 and 1000 to identify the remote site being associated with the primary site"
test_values:
all:
site_id: "0"
Expand Down
Loading

0 comments on commit 0153650

Please sign in to comment.