diff --git a/apstra/constants.go b/apstra/constants.go index 989beda8..12b94948 100644 --- a/apstra/constants.go +++ b/apstra/constants.go @@ -16,4 +16,12 @@ const ( errTemplateTypeInvalidElement = "template '%s' has type '%s' which never permits '%s' to be set" errDataSourceReadFail = "Data Source Read() failure'" errResourceReadFail = "Resource Read() failure'" + + docCategorySeparator = " --- " + docCategoryDesign = "Design" + docCategorySeparator + docCategoryResources = "Resources" + docCategorySeparator + docCategoryDatacenter = "RefDesign: Datacenter" + docCategorySeparator + docCategoryFreeform = "RefDesign: Freeform" + docCategorySeparator + docCategoryRefDesignAny = "RefDesign: Any" + docCategorySeparator + docCategoryDevices = "Devices" + docCategorySeparator ) diff --git a/apstra/data_source_agent.go b/apstra/data_source_agent.go index 8a86bfce..06859853 100644 --- a/apstra/data_source_agent.go +++ b/apstra/data_source_agent.go @@ -26,7 +26,7 @@ func (o *dataSourceAgent) Configure(ctx context.Context, req datasource.Configur func (o *dataSourceAgent) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource returns details of a Managed Device Agent.", + MarkdownDescription: docCategoryDevices + "This resource returns details of a Managed Device Agent.", Attributes: systemAgents.ManagedDevice{}.DataSourceAttributes(), } } diff --git a/apstra/data_source_agent_profile.go b/apstra/data_source_agent_profile.go index 8ab7e05f..2b257762 100644 --- a/apstra/data_source_agent_profile.go +++ b/apstra/data_source_agent_profile.go @@ -27,7 +27,7 @@ func (o *dataSourceAgentProfile) Configure(ctx context.Context, req datasource.C func (o *dataSourceAgentProfile) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source looks up details of an Agent Profile\n\n" + + MarkdownDescription: docCategoryDevices + "This data source looks up details of an Agent Profile\n\n" + "At least one optional attribute is required.", Attributes: agentProfile{}.dataSourceAttributes(), } diff --git a/apstra/data_source_agent_profiles.go b/apstra/data_source_agent_profiles.go index 4a860c15..80a49756 100644 --- a/apstra/data_source_agent_profiles.go +++ b/apstra/data_source_agent_profiles.go @@ -27,7 +27,7 @@ func (o *dataSourceAgentProfiles) Configure(ctx context.Context, req datasource. func (o *dataSourceAgentProfiles) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Agent Profiles.", + MarkdownDescription: docCategoryDevices + "This data source returns the ID numbers of all Agent Profiles.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_agents.go b/apstra/data_source_agents.go index b3edb4b2..20108251 100644 --- a/apstra/data_source_agents.go +++ b/apstra/data_source_agents.go @@ -29,7 +29,7 @@ func (o *dataSourceAgents) Configure(ctx context.Context, req datasource.Configu func (o *dataSourceAgents) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the IDs of Managed Device Agents. " + + MarkdownDescription: docCategoryDevices + "This data source returns the IDs of Managed Device Agents. " + "All of the `filter` attributes are optional.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ diff --git a/apstra/data_source_anomalies.go b/apstra/data_source_anomalies.go index 12200078..dbaf4393 100644 --- a/apstra/data_source_anomalies.go +++ b/apstra/data_source_anomalies.go @@ -25,7 +25,7 @@ func (o *dataSourceAnomalies) Configure(ctx context.Context, req datasource.Conf func (o *dataSourceAnomalies) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides per-node summary, " + + MarkdownDescription: docCategoryRefDesignAny + "This data source provides per-node summary, " + "per-service summary and full details of anomalies in the specified Blueprint.", Attributes: blueprint.Anomalies{}.DataSourceAttributes(), } diff --git a/apstra/data_source_asn_pool.go b/apstra/data_source_asn_pool.go index c77fcd10..573e0e2d 100644 --- a/apstra/data_source_asn_pool.go +++ b/apstra/data_source_asn_pool.go @@ -28,7 +28,7 @@ func (o *dataSourceAsnPool) Configure(ctx context.Context, req datasource.Config func (o *dataSourceAsnPool) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific ASN Pool.\n\n" + + MarkdownDescription: docCategoryResources + "This data source provides details of a specific ASN Pool.\n\n" + "At least one optional attribute is required.", Attributes: resources.AsnPool{}.DataSourceAttributes(), } diff --git a/apstra/data_source_asn_pools.go b/apstra/data_source_asn_pools.go index 1af8cc1d..2acf66cb 100644 --- a/apstra/data_source_asn_pools.go +++ b/apstra/data_source_asn_pools.go @@ -24,7 +24,7 @@ func (o *dataSourceAsnPools) Configure(ctx context.Context, req datasource.Confi func (o *dataSourceAsnPools) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all ASN Pools.", + MarkdownDescription: docCategoryResources + "This data source returns the ID numbers of all ASN Pools.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_blueprint_deployment.go b/apstra/data_source_blueprint_deployment.go index 0e77213d..a476eb2b 100644 --- a/apstra/data_source_blueprint_deployment.go +++ b/apstra/data_source_blueprint_deployment.go @@ -25,7 +25,7 @@ func (o *dataSourceBlueprintDeploy) Configure(ctx context.Context, req datasourc func (o *dataSourceBlueprintDeploy) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the deployment status of a Blueprint.", + MarkdownDescription: docCategoryRefDesignAny + "This data source returns the deployment status of a Blueprint.", Attributes: blueprint.Deploy{}.DataSourceAttributes(), } } diff --git a/apstra/data_source_blueprint_iba_dashboard.go b/apstra/data_source_blueprint_iba_dashboard.go index 18908c2e..bdeed31f 100644 --- a/apstra/data_source_blueprint_iba_dashboard.go +++ b/apstra/data_source_blueprint_iba_dashboard.go @@ -27,7 +27,7 @@ func (o *dataSourceBlueprintIbaDashboard) Configure(ctx context.Context, req dat func (o *dataSourceBlueprintIbaDashboard) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific IBA Dashboard in a Blueprint." + + MarkdownDescription: docCategoryRefDesignAny + "This data source provides details of a specific IBA Dashboard in a Blueprint." + "\n\n" + "At least one optional attribute is required.", Attributes: iba.Dashboard{}.DataSourceAttributes(), diff --git a/apstra/data_source_blueprint_iba_dashboards.go b/apstra/data_source_blueprint_iba_dashboards.go index de28709c..135f545f 100644 --- a/apstra/data_source_blueprint_iba_dashboards.go +++ b/apstra/data_source_blueprint_iba_dashboards.go @@ -29,7 +29,7 @@ func (o *dataSourceBlueprintIbaDashboards) Configure(ctx context.Context, req da func (o *dataSourceBlueprintIbaDashboards) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all IBA Dashboards in a Blueprint.", + MarkdownDescription: docCategoryRefDesignAny + "This data source returns the ID numbers of all IBA Dashboards in a Blueprint.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ MarkdownDescription: "Apstra Blueprint ID. " + diff --git a/apstra/data_source_blueprint_iba_predefined_probe.go b/apstra/data_source_blueprint_iba_predefined_probe.go index 7ee101c6..5f332025 100644 --- a/apstra/data_source_blueprint_iba_predefined_probe.go +++ b/apstra/data_source_blueprint_iba_predefined_probe.go @@ -27,7 +27,7 @@ func (o *dataSourceBlueprintIbaPredefinedProbe) Configure(ctx context.Context, r func (o *dataSourceBlueprintIbaPredefinedProbe) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific IBA Predefined Probe in a Blueprint.", + MarkdownDescription: docCategoryRefDesignAny + "This data source provides details of a specific IBA Predefined Probe in a Blueprint.", Attributes: iba.PredefinedProbe{}.DataSourceAttributes(), } } diff --git a/apstra/data_source_blueprint_iba_widget.go b/apstra/data_source_blueprint_iba_widget.go index 53b0f7de..4ed48ab6 100644 --- a/apstra/data_source_blueprint_iba_widget.go +++ b/apstra/data_source_blueprint_iba_widget.go @@ -27,7 +27,7 @@ func (o *dataSourceBlueprintIbaWidget) Configure(ctx context.Context, req dataso func (o *dataSourceBlueprintIbaWidget) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific IBA Widget in a Blueprint." + + MarkdownDescription: docCategoryRefDesignAny + "This data source provides details of a specific IBA Widget in a Blueprint." + "\n\n" + "At least one optional attribute is required.", Attributes: iba.Widget{}.DataSourceAttributes(), diff --git a/apstra/data_source_blueprints.go b/apstra/data_source_blueprints.go index b006ba04..551414a0 100644 --- a/apstra/data_source_blueprints.go +++ b/apstra/data_source_blueprints.go @@ -35,7 +35,7 @@ func (o *dataSourceBlueprints) Configure(ctx context.Context, req datasource.Con func (o *dataSourceBlueprints) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of Blueprints.", + MarkdownDescription: docCategoryRefDesignAny + "This data source returns the ID numbers of Blueprints.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_configlet.go b/apstra/data_source_configlet.go index 7e9d6463..ef804eb2 100644 --- a/apstra/data_source_configlet.go +++ b/apstra/data_source_configlet.go @@ -28,7 +28,7 @@ func (o *dataSourceConfiglet) Configure(ctx context.Context, req datasource.Conf func (o *dataSourceConfiglet) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Configlet.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific Configlet.\n\n" + "At least one optional attribute is required.", Attributes: design.Configlet{}.DataSourceAttributes(), } diff --git a/apstra/data_source_configlets.go b/apstra/data_source_configlets.go index 31063f50..b232a17b 100644 --- a/apstra/data_source_configlets.go +++ b/apstra/data_source_configlets.go @@ -29,7 +29,7 @@ func (o *dataSourceConfiglets) Configure(ctx context.Context, req datasource.Con func (o *dataSourceConfiglets) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Configlets.", + MarkdownDescription: docCategoryDesign + "This data source returns the ID numbers of all Configlets.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_datacenter_blueprint.go b/apstra/data_source_datacenter_blueprint.go index dcf25025..5a04cda3 100644 --- a/apstra/data_source_datacenter_blueprint.go +++ b/apstra/data_source_datacenter_blueprint.go @@ -27,7 +27,7 @@ func (o *dataSourceDatacenterBlueprint) Configure(ctx context.Context, req datas func (o *dataSourceDatacenterBlueprint) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source looks up summary details of a Datacenter Blueprint.\n\n" + + MarkdownDescription: docCategoryDatacenter + "This data source looks up summary details of a Datacenter Blueprint.\n\n" + "At least one optional attribute is required.", Attributes: blueprint.Blueprint{}.DataSourceAttributes(), } diff --git a/apstra/data_source_datacenter_configlet.go b/apstra/data_source_datacenter_configlet.go index 8cf5bdaf..c536440a 100644 --- a/apstra/data_source_datacenter_configlet.go +++ b/apstra/data_source_datacenter_configlet.go @@ -28,7 +28,7 @@ func (o *dataSourceDatacenterConfiglet) Configure(ctx context.Context, req datas func (o *dataSourceDatacenterConfiglet) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Configlet imported into a Blueprint." + + MarkdownDescription: docCategoryDatacenter + "This data source provides details of a specific Configlet imported into a Blueprint." + "\n\n" + "At least one optional attribute is required.", Attributes: blueprint.DatacenterConfiglet{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_configlets.go b/apstra/data_source_datacenter_configlets.go index e2183b00..a65e03ee 100644 --- a/apstra/data_source_datacenter_configlets.go +++ b/apstra/data_source_datacenter_configlets.go @@ -29,7 +29,7 @@ func (o *dataSourceDatacenterConfiglets) Configure(ctx context.Context, req data func (o *dataSourceDatacenterConfiglets) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Configlets in a Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This data source returns the ID numbers of all Configlets in a Blueprint.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ MarkdownDescription: "Apstra Blueprint ID. Used to identify the Blueprint that the Configlet belongs to.", diff --git a/apstra/data_source_datacenter_ct_bgp_peering_generic_system.go b/apstra/data_source_datacenter_ct_bgp_peering_generic_system.go index 464326bb..9a537489 100644 --- a/apstra/data_source_datacenter_ct_bgp_peering_generic_system.go +++ b/apstra/data_source_datacenter_ct_bgp_peering_generic_system.go @@ -19,7 +19,7 @@ func (o *dataSourceDatacenterCtBgpPeeringGenericSystem) Metadata(_ context.Conte func (o *dataSourceDatacenterCtBgpPeeringGenericSystem) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.BgpPeeringGenericSystem{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_bgp_peering_ip_endpoint.go b/apstra/data_source_datacenter_ct_bgp_peering_ip_endpoint.go index 3f80d700..c4d805a1 100644 --- a/apstra/data_source_datacenter_ct_bgp_peering_ip_endpoint.go +++ b/apstra/data_source_datacenter_ct_bgp_peering_ip_endpoint.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtBgpPeeringIpEndpoint) Metadata(_ context.Context, func (o *dataSourceDatacenterCtBgpPeeringIpEndpoint) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.BgpPeeringIpEndpoint{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_custom_static_route.go b/apstra/data_source_datacenter_ct_custom_static_route.go index 2fca4ae1..d80403e7 100644 --- a/apstra/data_source_datacenter_ct_custom_static_route.go +++ b/apstra/data_source_datacenter_ct_custom_static_route.go @@ -22,7 +22,7 @@ func (o *dataSourceDatacenterCtCustomStaticRoute) Metadata(_ context.Context, re func (o *dataSourceDatacenterCtCustomStaticRoute) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.CustomStaticRoute{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_dynamic_bgp_peering.go b/apstra/data_source_datacenter_ct_dynamic_bgp_peering.go index 8e780668..fbe911fd 100644 --- a/apstra/data_source_datacenter_ct_dynamic_bgp_peering.go +++ b/apstra/data_source_datacenter_ct_dynamic_bgp_peering.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtDynamicBgpPeering) Metadata(_ context.Context, re func (o *dataSourceDatacenterCtDynamicBgpPeering) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.DynamicBgpPeering{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_ip_link.go b/apstra/data_source_datacenter_ct_ip_link.go index 91febcac..711f325f 100644 --- a/apstra/data_source_datacenter_ct_ip_link.go +++ b/apstra/data_source_datacenter_ct_ip_link.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtIpLink) Metadata(_ context.Context, req datasourc func (o *dataSourceDatacenterCtIpLink) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.IpLink{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_routing_policy.go b/apstra/data_source_datacenter_ct_routing_policy.go index e8a44428..c1a81a18 100644 --- a/apstra/data_source_datacenter_ct_routing_policy.go +++ b/apstra/data_source_datacenter_ct_routing_policy.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtRoutingPolicy) Metadata(_ context.Context, req da func (o *dataSourceDatacenterCtRoutingPolicy) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.RoutingPolicy{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_routing_zone_constraint.go b/apstra/data_source_datacenter_ct_routing_zone_constraint.go index 767d411c..8e3c0ed5 100644 --- a/apstra/data_source_datacenter_ct_routing_zone_constraint.go +++ b/apstra/data_source_datacenter_ct_routing_zone_constraint.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtRoutingZoneConstraint) Metadata(_ context.Context func (o *dataSourceDatacenterCtRoutingZoneConstraint) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.RoutingZoneConstraint{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_static_route.go b/apstra/data_source_datacenter_ct_static_route.go index 8750fe55..2c6fe603 100644 --- a/apstra/data_source_datacenter_ct_static_route.go +++ b/apstra/data_source_datacenter_ct_static_route.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtStaticRoute) Metadata(_ context.Context, req data func (o *dataSourceDatacenterCtStaticRoute) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.StaticRoute{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_virtual_network_multiple.go b/apstra/data_source_datacenter_ct_virtual_network_multiple.go index a763e84b..6f84f16d 100644 --- a/apstra/data_source_datacenter_ct_virtual_network_multiple.go +++ b/apstra/data_source_datacenter_ct_virtual_network_multiple.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtVnMultiple) Metadata(_ context.Context, req datas func (o *dataSourceDatacenterCtVnMultiple) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.VnMultiple{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_ct_virtual_network_single.go b/apstra/data_source_datacenter_ct_virtual_network_single.go index 64a1f155..4c3ddc1a 100644 --- a/apstra/data_source_datacenter_ct_virtual_network_single.go +++ b/apstra/data_source_datacenter_ct_virtual_network_single.go @@ -18,7 +18,7 @@ func (o *dataSourceDatacenterCtVnSingle) Metadata(_ context.Context, req datasou func (o *dataSourceDatacenterCtVnSingle) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source composes a Connectivity Template Primitive as a JSON string, " + + MarkdownDescription: docCategoryDatacenter + "This data source composes a Connectivity Template Primitive as a JSON string, " + "suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` " + "resource or the `child_primitives` attribute of a Different Connectivity Template Primitive.", Attributes: connectivitytemplate.VnSingle{}.DataSourceAttributes(), diff --git a/apstra/data_source_datacenter_interfaces_by_link_tag.go b/apstra/data_source_datacenter_interfaces_by_link_tag.go index bdbce706..2e7dce79 100644 --- a/apstra/data_source_datacenter_interfaces_by_link_tag.go +++ b/apstra/data_source_datacenter_interfaces_by_link_tag.go @@ -27,7 +27,7 @@ func (o *dataSourceInterfacesByLinkTag) Configure(ctx context.Context, req datas func (o *dataSourceInterfacesByLinkTag) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the IDs of Interfaces by Link Tag.", + MarkdownDescription: docCategoryDatacenter + "This data source returns the IDs of Interfaces by Link Tag.", Attributes: blueprint.InterfacesByLinkTag{}.DataSourceAttributes(), } } diff --git a/apstra/data_source_datacenter_interfaces_by_system.go b/apstra/data_source_datacenter_interfaces_by_system.go index 19dee5e6..2da3bc37 100644 --- a/apstra/data_source_datacenter_interfaces_by_system.go +++ b/apstra/data_source_datacenter_interfaces_by_system.go @@ -27,7 +27,7 @@ func (o *dataSourceInterfacesBySystem) Configure(ctx context.Context, req dataso func (o *dataSourceInterfacesBySystem) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns a map of Interface IDs keyed by Interface Name for the given System ID.", + MarkdownDescription: docCategoryDatacenter + "This data source returns a map of Interface IDs keyed by Interface Name for the given System ID.", Attributes: blueprint.InterfacesBySystem{}.DataSourceAttributes(), } } diff --git a/apstra/data_source_datacenter_property_set.go b/apstra/data_source_datacenter_property_set.go index bb16240a..cd129948 100644 --- a/apstra/data_source_datacenter_property_set.go +++ b/apstra/data_source_datacenter_property_set.go @@ -27,7 +27,7 @@ func (o *dataSourceDatacenterPropertySet) Configure(ctx context.Context, req dat func (o *dataSourceDatacenterPropertySet) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Property Set imported into a Blueprint.\n\n" + + MarkdownDescription: docCategoryRefDesignAny + "This data source provides details of a specific Property Set imported into a Blueprint.\n\n" + "At least one optional attribute is required.", Attributes: blueprint.DatacenterPropertySet{}.DataSourceAttributes(), } diff --git a/apstra/data_source_datacenter_property_sets.go b/apstra/data_source_datacenter_property_sets.go index 71b16187..96c31fe1 100644 --- a/apstra/data_source_datacenter_property_sets.go +++ b/apstra/data_source_datacenter_property_sets.go @@ -29,7 +29,7 @@ func (o *dataSourceDatacenterPropertySets) Configure(ctx context.Context, req da func (o *dataSourceDatacenterPropertySets) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Property Sets in the Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This data source returns the ID numbers of all Property Sets in the Blueprint.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ MarkdownDescription: "Apstra Blueprint ID.", diff --git a/apstra/data_source_datacenter_routing_policies.go b/apstra/data_source_datacenter_routing_policies.go index cb5701d2..f3fca087 100644 --- a/apstra/data_source_datacenter_routing_policies.go +++ b/apstra/data_source_datacenter_routing_policies.go @@ -32,7 +32,7 @@ func (o *dataSourceDatacenterRoutingPolicies) Configure(ctx context.Context, req func (o *dataSourceDatacenterRoutingPolicies) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns Graph DB node IDs of *routing_policy* nodes within a Blueprint.\n\n" + + MarkdownDescription: docCategoryDatacenter + "This data source returns Graph DB node IDs of *routing_policy* nodes within a Blueprint.\n\n" + "Optional `filters` can be used select only interesting nodes.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ diff --git a/apstra/data_source_datacenter_routing_policy.go b/apstra/data_source_datacenter_routing_policy.go index b9fb9677..1611e843 100644 --- a/apstra/data_source_datacenter_routing_policy.go +++ b/apstra/data_source_datacenter_routing_policy.go @@ -28,7 +28,7 @@ func (o *dataSourceDatacenterRoutingPolicy) Configure(ctx context.Context, req d func (o *dataSourceDatacenterRoutingPolicy) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns details of a Datacenter Routing Policy.\n\n" + + MarkdownDescription: docCategoryDatacenter + "This data source returns details of a Datacenter Routing Policy.\n\n" + "At least one optional attribute is required.", Attributes: blueprint.DatacenterRoutingPolicy{}.DataSourceAttributes(), } diff --git a/apstra/data_source_datacenter_routing_zone.go b/apstra/data_source_datacenter_routing_zone.go index 60c630eb..6f416150 100644 --- a/apstra/data_source_datacenter_routing_zone.go +++ b/apstra/data_source_datacenter_routing_zone.go @@ -28,7 +28,7 @@ func (o *dataSourceDatacenterRoutingZone) Configure(ctx context.Context, req dat func (o *dataSourceDatacenterRoutingZone) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource returns details of a Routing Zone within a Datacenter Blueprint.\n\n" + + MarkdownDescription: docCategoryDatacenter + "This resource returns details of a Routing Zone within a Datacenter Blueprint.\n\n" + "At least one optional attribute is required.", Attributes: blueprint.DatacenterRoutingZone{}.DataSourceAttributes(), } diff --git a/apstra/data_source_datacenter_routing_zones.go b/apstra/data_source_datacenter_routing_zones.go index 88d3bc96..c2e0e79a 100644 --- a/apstra/data_source_datacenter_routing_zones.go +++ b/apstra/data_source_datacenter_routing_zones.go @@ -29,7 +29,7 @@ func (o *dataSourceDatacenterRoutingZones) Configure(ctx context.Context, req da func (o *dataSourceDatacenterRoutingZones) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the IDs of Routing Zones within the specified Blueprint. " + + MarkdownDescription: docCategoryDatacenter + "This data source returns the IDs of Routing Zones within the specified Blueprint. " + "All of the `filter` attributes are optional.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ diff --git a/apstra/data_source_datacenter_svi_map.go b/apstra/data_source_datacenter_svi_map.go index 7be45a89..59b7370c 100644 --- a/apstra/data_source_datacenter_svi_map.go +++ b/apstra/data_source_datacenter_svi_map.go @@ -28,7 +28,7 @@ func (o *dataSourceDatacenterSvis) Configure(ctx context.Context, req datasource func (o *dataSourceDatacenterSvis) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns a maps of Sets of SVI info keyed by Virtual Network ID, System ID and SVI ID.", + MarkdownDescription: docCategoryDatacenter + "This data source returns a maps of Sets of SVI info keyed by Virtual Network ID, System ID and SVI ID.", Attributes: blueprint.DatacenterSvis{}.DataSourceAttributes(), } } diff --git a/apstra/data_source_datacenter_system.go b/apstra/data_source_datacenter_system.go index 376e4270..369c2376 100644 --- a/apstra/data_source_datacenter_system.go +++ b/apstra/data_source_datacenter_system.go @@ -25,7 +25,7 @@ func (o *dataSourceDatacenterSystemNode) Configure(ctx context.Context, req data func (o *dataSourceDatacenterSystemNode) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns details of a specific *system* Graph DB node within a Blueprint.\n\n" + + MarkdownDescription: docCategoryDatacenter + "This data source returns details of a specific *system* Graph DB node within a Blueprint.\n\n" + "At least one optional attribute is required.", Attributes: blueprint.NodeTypeSystem{}.DataSourceAttributes(), } diff --git a/apstra/data_source_datacenter_systems.go b/apstra/data_source_datacenter_systems.go index afbb6fdb..9640d5ee 100644 --- a/apstra/data_source_datacenter_systems.go +++ b/apstra/data_source_datacenter_systems.go @@ -24,7 +24,7 @@ func (o *dataSourceDatacenterSystemNodes) Configure(ctx context.Context, req dat func (o *dataSourceDatacenterSystemNodes) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns Graph DB node IDs of *system* nodes within a Blueprint.\n\n" + + MarkdownDescription: docCategoryDatacenter + "This data source returns Graph DB node IDs of *system* nodes within a Blueprint.\n\n" + "Optional `filters` can be used to select only interesting nodes.", Attributes: blueprint.NodesTypeSystem{}.DataSourceAttributes(), } diff --git a/apstra/data_source_datacenter_virtual_network_binding_constructor.go b/apstra/data_source_datacenter_virtual_network_binding_constructor.go index 840ecf91..3a88d032 100644 --- a/apstra/data_source_datacenter_virtual_network_binding_constructor.go +++ b/apstra/data_source_datacenter_virtual_network_binding_constructor.go @@ -25,7 +25,7 @@ func (o *dataSourceVirtualNetworkBindingConstructor) Configure(ctx context.Conte func (o *dataSourceVirtualNetworkBindingConstructor) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source can be used to calculate the " + + MarkdownDescription: docCategoryDatacenter + "This data source can be used to calculate the " + "`bindings` data required by `apstra_datacenter_virtual_network`." + "\n\n" + "Given a list of switch node IDSs, it determines whether they're " + diff --git a/apstra/data_source_datacenter_virtual_networks.go b/apstra/data_source_datacenter_virtual_networks.go index a981fc4f..5e16dbcf 100644 --- a/apstra/data_source_datacenter_virtual_networks.go +++ b/apstra/data_source_datacenter_virtual_networks.go @@ -34,7 +34,7 @@ func (o *dataSourceDatacenterVirtualNetworks) Configure(ctx context.Context, req func (o *dataSourceDatacenterVirtualNetworks) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the IDs of Virtual Networks within the specified Blueprint. " + + MarkdownDescription: docCategoryDatacenter + "This data source returns the IDs of Virtual Networks within the specified Blueprint. " + "All of the `filter` attributes are optional.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ diff --git a/apstra/data_source_iba_widgets.go b/apstra/data_source_iba_widgets.go index 868d1274..9120f0eb 100644 --- a/apstra/data_source_iba_widgets.go +++ b/apstra/data_source_iba_widgets.go @@ -29,7 +29,7 @@ func (o *dataSourceBlueprintIbaWidgets) Configure(ctx context.Context, req datas func (o *dataSourceBlueprintIbaWidgets) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the IDs of the IBA Widgets in a Blueprint.", + MarkdownDescription: docCategoryRefDesignAny + "This data source returns the IDs of the IBA Widgets in a Blueprint.", Attributes: map[string]schema.Attribute{ "blueprint_id": schema.StringAttribute{ MarkdownDescription: "Apstra Blueprint ID. " + diff --git a/apstra/data_source_integer_pool.go b/apstra/data_source_integer_pool.go index 3ae69dd4..e88c04ed 100644 --- a/apstra/data_source_integer_pool.go +++ b/apstra/data_source_integer_pool.go @@ -28,7 +28,7 @@ func (o *dataSourceIntegerPool) Configure(ctx context.Context, req datasource.Co func (o *dataSourceIntegerPool) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Integer Pool.\n\n" + + MarkdownDescription: docCategoryResources + "This data source provides details of a specific Integer Pool.\n\n" + "At least one optional attribute is required.", Attributes: resources.IntegerPool{}.DataSourceAttributes(), } diff --git a/apstra/data_source_integer_pools.go b/apstra/data_source_integer_pools.go index 574cfc89..79e4d203 100644 --- a/apstra/data_source_integer_pools.go +++ b/apstra/data_source_integer_pools.go @@ -24,7 +24,7 @@ func (o *dataSourceIntegerPools) Configure(ctx context.Context, req datasource.C func (o *dataSourceIntegerPools) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Integer Pools.", + MarkdownDescription: docCategoryResources + "This data source returns the ID numbers of all Integer Pools.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_interface_map.go b/apstra/data_source_interface_map.go index 4219bb8f..73a5826c 100644 --- a/apstra/data_source_interface_map.go +++ b/apstra/data_source_interface_map.go @@ -28,7 +28,7 @@ func (o *dataSourceInterfaceMap) Configure(ctx context.Context, req datasource.C func (o *dataSourceInterfaceMap) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Interface Map.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific Interface Map.\n\n" + "At least one optional attribute is required.", Attributes: design.InterfaceMap{}.DataSourceAttributes(), } diff --git a/apstra/data_source_interface_maps.go b/apstra/data_source_interface_maps.go index 8f5df4a2..1b427e4d 100644 --- a/apstra/data_source_interface_maps.go +++ b/apstra/data_source_interface_maps.go @@ -28,7 +28,7 @@ func (o *dataSourceInterfaceMaps) Configure(ctx context.Context, req datasource. func (o *dataSourceInterfaceMaps) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of Interface Maps.", + MarkdownDescription: docCategoryDesign + "This data source returns the ID numbers of Interface Maps.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_ipv4_pool.go b/apstra/data_source_ipv4_pool.go index 06f4b8f2..749dd538 100644 --- a/apstra/data_source_ipv4_pool.go +++ b/apstra/data_source_ipv4_pool.go @@ -27,7 +27,7 @@ func (o *dataSourceIpv4Pool) Configure(ctx context.Context, req datasource.Confi func (o *dataSourceIpv4Pool) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific IPv4 Pool.\n\n" + + MarkdownDescription: docCategoryResources + "This data source provides details of a specific IPv4 Pool.\n\n" + "At least one optional attribute is required.", Attributes: resources.Ipv4Pool{}.DataSourceAttributes(), } diff --git a/apstra/data_source_ipv4_pools.go b/apstra/data_source_ipv4_pools.go index ea7d9b15..36640dd9 100644 --- a/apstra/data_source_ipv4_pools.go +++ b/apstra/data_source_ipv4_pools.go @@ -24,7 +24,7 @@ func (o *dataSourceIpv4Pools) Configure(ctx context.Context, req datasource.Conf func (o *dataSourceIpv4Pools) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all IPv4 Pools", + MarkdownDescription: docCategoryResources + "This data source returns the ID numbers of all IPv4 Pools", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_ipv6_pool.go b/apstra/data_source_ipv6_pool.go index 884f715c..e1d8a537 100644 --- a/apstra/data_source_ipv6_pool.go +++ b/apstra/data_source_ipv6_pool.go @@ -27,7 +27,7 @@ func (o *dataSourceIpv6Pool) Configure(ctx context.Context, req datasource.Confi func (o *dataSourceIpv6Pool) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific IPv6 Pool.\n\n" + + MarkdownDescription: docCategoryResources + "This data source provides details of a specific IPv6 Pool.\n\n" + "At least one optional attribute is required.", Attributes: resources.Ipv6Pool{}.DataSourceAttributes(), } diff --git a/apstra/data_source_ipv6_pools.go b/apstra/data_source_ipv6_pools.go index 4c12de86..358a8df8 100644 --- a/apstra/data_source_ipv6_pools.go +++ b/apstra/data_source_ipv6_pools.go @@ -24,7 +24,7 @@ func (o *dataSourceIpv6Pools) Configure(ctx context.Context, req datasource.Conf func (o *dataSourceIpv6Pools) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all IPv6 Pools", + MarkdownDescription: docCategoryResources + "This data source returns the ID numbers of all IPv6 Pools", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_logical_device.go b/apstra/data_source_logical_device.go index 01a45701..4ed46388 100644 --- a/apstra/data_source_logical_device.go +++ b/apstra/data_source_logical_device.go @@ -28,7 +28,7 @@ func (o *dataSourceLogicalDevice) Configure(ctx context.Context, req datasource. func (o *dataSourceLogicalDevice) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Logical Device.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific Logical Device.\n\n" + "At least one optional attribute is required.", Attributes: design.LogicalDevice{}.DataSourceAttributes(), } diff --git a/apstra/data_source_property_set.go b/apstra/data_source_property_set.go index 801b4e6e..b14a35c1 100644 --- a/apstra/data_source_property_set.go +++ b/apstra/data_source_property_set.go @@ -28,7 +28,7 @@ func (o *dataSourcePropertySet) Configure(ctx context.Context, req datasource.Co func (o *dataSourcePropertySet) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific PropertySet.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific PropertySet.\n\n" + "At least one optional attribute is required.", Attributes: design.PropertySet{}.DataSourceAttributes(), } diff --git a/apstra/data_source_property_sets.go b/apstra/data_source_property_sets.go index 8931ff04..65d3b1e2 100644 --- a/apstra/data_source_property_sets.go +++ b/apstra/data_source_property_sets.go @@ -24,7 +24,7 @@ func (o *dataSourcePropertySets) Configure(ctx context.Context, req datasource.C func (o *dataSourcePropertySets) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Property Sets.", + MarkdownDescription: docCategoryDesign + "This data source returns the ID numbers of all Property Sets.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_rack_type.go b/apstra/data_source_rack_type.go index d67f1464..8bd5750e 100644 --- a/apstra/data_source_rack_type.go +++ b/apstra/data_source_rack_type.go @@ -28,7 +28,7 @@ func (o *dataSourceRackType) Configure(ctx context.Context, req datasource.Confi func (o *dataSourceRackType) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Rack Type.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific Rack Type.\n\n" + "At least one optional attribute is required.", Attributes: design.RackType{}.DataSourceAttributes(), } diff --git a/apstra/data_source_rack_types.go b/apstra/data_source_rack_types.go index e3daf6ce..6ad0afe2 100644 --- a/apstra/data_source_rack_types.go +++ b/apstra/data_source_rack_types.go @@ -24,7 +24,7 @@ func (o *dataSourceRackTypes) Configure(ctx context.Context, req datasource.Conf func (o *dataSourceRackTypes) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all Rack Types.", + MarkdownDescription: docCategoryDesign + "This data source returns the ID numbers of all Rack Types.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_tag.go b/apstra/data_source_tag.go index 32797638..1cac2587 100644 --- a/apstra/data_source_tag.go +++ b/apstra/data_source_tag.go @@ -28,7 +28,7 @@ func (o *dataSourceTag) Configure(ctx context.Context, req datasource.ConfigureR func (o *dataSourceTag) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Tag.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific Tag.\n\n" + "At least one optional attribute is required.", Attributes: design.Tag{}.DataSourceAttributes(), } diff --git a/apstra/data_source_template_rack_based.go b/apstra/data_source_template_rack_based.go index 64219f28..e76749bc 100644 --- a/apstra/data_source_template_rack_based.go +++ b/apstra/data_source_template_rack_based.go @@ -27,7 +27,7 @@ func (o *dataSourceTemplateRackBased) Configure(ctx context.Context, req datasou func (o *dataSourceTemplateRackBased) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific Rack Based (3 stage) Template.\n\n" + + MarkdownDescription: docCategoryDesign + "This data source provides details of a specific Rack Based (3 stage) Template.\n\n" + "At least one optional attribute is required.", Attributes: design.TemplateRackBased{}.DataSourceAttributes(), } diff --git a/apstra/data_source_templates.go b/apstra/data_source_templates.go index bc0ca89e..0f426d61 100644 --- a/apstra/data_source_templates.go +++ b/apstra/data_source_templates.go @@ -28,7 +28,7 @@ func (o *dataSourceTemplates) Configure(ctx context.Context, req datasource.Conf func (o *dataSourceTemplates) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of Templates.", + MarkdownDescription: docCategoryDesign + "This data source returns the ID numbers of Templates.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/data_source_vni_pool.go b/apstra/data_source_vni_pool.go index 5a3c963f..ec863592 100644 --- a/apstra/data_source_vni_pool.go +++ b/apstra/data_source_vni_pool.go @@ -28,7 +28,7 @@ func (o *dataSourceVniPool) Configure(ctx context.Context, req datasource.Config func (o *dataSourceVniPool) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source provides details of a specific VNI Pool.\n\n" + + MarkdownDescription: docCategoryResources + "This data source provides details of a specific VNI Pool.\n\n" + "At least one optional attribute is required.", Attributes: resources.VniPool{}.DataSourceAttributes(), } diff --git a/apstra/data_source_vni_pools.go b/apstra/data_source_vni_pools.go index 9bd85d9b..d4584756 100644 --- a/apstra/data_source_vni_pools.go +++ b/apstra/data_source_vni_pools.go @@ -24,7 +24,7 @@ func (o *dataSourceVniPools) Configure(ctx context.Context, req datasource.Confi func (o *dataSourceVniPools) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This data source returns the ID numbers of all VNI Pools.", + MarkdownDescription: docCategoryResources + "This data source returns the ID numbers of all VNI Pools.", Attributes: map[string]schema.Attribute{ "ids": schema.SetAttribute{ MarkdownDescription: "A set of Apstra object ID numbers.", diff --git a/apstra/devices_agent_profile.go b/apstra/devices_agent_profile.go index c7e1e7c7..4dc3ce5f 100644 --- a/apstra/devices_agent_profile.go +++ b/apstra/devices_agent_profile.go @@ -30,7 +30,7 @@ type agentProfile struct { func (o agentProfile) dataSourceAttributes() map[string]dataSourceSchema.Attribute { return map[string]dataSourceSchema.Attribute{ "id": dataSourceSchema.StringAttribute{ - MarkdownDescription: "Apstra ID of the Agent Profile. Required when `name` is omitted.", + MarkdownDescription: docCategoryDevices + "Apstra ID of the Agent Profile. Required when `name` is omitted.", Optional: true, Computed: true, Validators: []validator.String{ diff --git a/apstra/resource_agent_profile.go b/apstra/resource_agent_profile.go index 7414df9c..76435317 100644 --- a/apstra/resource_agent_profile.go +++ b/apstra/resource_agent_profile.go @@ -26,7 +26,7 @@ func (o *resourceAgentProfile) Configure(ctx context.Context, req resource.Confi func (o *resourceAgentProfile) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an Agent Profile. Note that credentials (username/password) " + + MarkdownDescription: docCategoryDevices + "This resource creates an Agent Profile. Note that credentials (username/password) " + "cannot be set using this resource because (a) Apstra doesn't allow them to be retrieved, so it's " + "impossible for terraform to detect drift and because (b) leaving credentials in the configuration/state " + "isn't a safe practice.", diff --git a/apstra/resource_asn_pool.go b/apstra/resource_asn_pool.go index b91d5215..284f742c 100644 --- a/apstra/resource_asn_pool.go +++ b/apstra/resource_asn_pool.go @@ -29,7 +29,7 @@ func (o *resourceAsnPool) Configure(ctx context.Context, req resource.ConfigureR func (o *resourceAsnPool) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an ASN resource pool", + MarkdownDescription: docCategoryResources + "This resource creates an ASN resource pool", Attributes: resources.AsnPool{}.ResourceAttributes(), } } diff --git a/apstra/resource_blueprint_deployment.go b/apstra/resource_blueprint_deployment.go index e1419894..fb33e915 100644 --- a/apstra/resource_blueprint_deployment.go +++ b/apstra/resource_blueprint_deployment.go @@ -35,7 +35,7 @@ func (o *resourceBlueprintDeploy) Configure(ctx context.Context, req resource.Co func (o *resourceBlueprintDeploy) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource commits a staging Blueprint after checking for build errors.", + MarkdownDescription: docCategoryRefDesignAny + "This resource commits a staging Blueprint after checking for build errors.", Attributes: blueprint.Deploy{}.ResourceAttributes(), } } diff --git a/apstra/resource_blueprint_iba_dashboard.go b/apstra/resource_blueprint_iba_dashboard.go index 5eda7284..b7b8a05b 100644 --- a/apstra/resource_blueprint_iba_dashboard.go +++ b/apstra/resource_blueprint_iba_dashboard.go @@ -26,7 +26,7 @@ func (o *resourceBlueprintIbaDashboard) Configure(ctx context.Context, req resou func (o *resourceBlueprintIbaDashboard) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a IBA Dashboard.", + MarkdownDescription: docCategoryRefDesignAny + "This resource creates a IBA Dashboard.", Attributes: iba.Dashboard{}.ResourceAttributes(), } } diff --git a/apstra/resource_blueprint_iba_probe.go b/apstra/resource_blueprint_iba_probe.go index 3f441d72..1b0301fd 100644 --- a/apstra/resource_blueprint_iba_probe.go +++ b/apstra/resource_blueprint_iba_probe.go @@ -26,7 +26,7 @@ func (o *resourceBlueprintIbaProbe) Configure(ctx context.Context, req resource. func (o *resourceBlueprintIbaProbe) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an IBA Probe within a Blueprint.", + MarkdownDescription: docCategoryRefDesignAny + "This resource creates an IBA Probe within a Blueprint.", Attributes: iba.Probe{}.ResourceAttributes(), } } diff --git a/apstra/resource_blueprint_iba_widget.go b/apstra/resource_blueprint_iba_widget.go index 6e3960f6..9f19b9ff 100644 --- a/apstra/resource_blueprint_iba_widget.go +++ b/apstra/resource_blueprint_iba_widget.go @@ -27,7 +27,7 @@ func (o *resourceBlueprintIbaWidget) Configure(ctx context.Context, req resource func (o *resourceBlueprintIbaWidget) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an IBA Widget.", + MarkdownDescription: docCategoryRefDesignAny + "This resource creates an IBA Widget.", Attributes: iba.Widget{}.ResourceAttributes(), } } diff --git a/apstra/resource_configlet.go b/apstra/resource_configlet.go index 84a2a952..b3451c7e 100644 --- a/apstra/resource_configlet.go +++ b/apstra/resource_configlet.go @@ -31,7 +31,7 @@ func (o *resourceConfiglet) Configure(ctx context.Context, req resource.Configur func (o *resourceConfiglet) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a specific Configlet.\n\n", + MarkdownDescription: docCategoryDatacenter + "This resource creates a specific Configlet.\n\n", Attributes: design.Configlet{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_blueprint.go b/apstra/resource_datacenter_blueprint.go index 526de2d1..ab3551bf 100644 --- a/apstra/resource_datacenter_blueprint.go +++ b/apstra/resource_datacenter_blueprint.go @@ -37,7 +37,7 @@ func (o *resourceDatacenterBlueprint) Configure(ctx context.Context, req resourc func (o *resourceDatacenterBlueprint) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource instantiates a Datacenter Blueprint from a template.", + MarkdownDescription: docCategoryDatacenter + "This resource instantiates a Datacenter Blueprint from a template.", Attributes: blueprint.Blueprint{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_configlet.go b/apstra/resource_datacenter_configlet.go index 5fd0e2de..e5ede5a5 100644 --- a/apstra/resource_datacenter_configlet.go +++ b/apstra/resource_datacenter_configlet.go @@ -31,7 +31,7 @@ func (o *resourceDatacenterConfiglet) Configure(ctx context.Context, req resourc func (o *resourceDatacenterConfiglet) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource imports a Configlet into a Blueprint.", + MarkdownDescription: docCategoryDesign + "This resource imports a Configlet into a Blueprint.", Attributes: blueprint.DatacenterConfiglet{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_connectivity_template.go b/apstra/resource_datacenter_connectivity_template.go index 20d32516..5a098f24 100644 --- a/apstra/resource_datacenter_connectivity_template.go +++ b/apstra/resource_datacenter_connectivity_template.go @@ -29,7 +29,7 @@ func (o *resourceDatacenterConnectivityTemplate) Configure(ctx context.Context, func (o *resourceDatacenterConnectivityTemplate) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Connectivity Template within a Datacenter Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource creates a Connectivity Template within a Datacenter Blueprint.", Attributes: blueprint.ConnectivityTemplate{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_connectivity_template_assignment.go b/apstra/resource_datacenter_connectivity_template_assignment.go index 8738371a..78075e49 100644 --- a/apstra/resource_datacenter_connectivity_template_assignment.go +++ b/apstra/resource_datacenter_connectivity_template_assignment.go @@ -29,7 +29,7 @@ func (o *resourceDatacenterConnectivityTemplateAssignment) Configure(ctx context func (o *resourceDatacenterConnectivityTemplateAssignment) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource assigns one or more Connectivity Templates to an " + + MarkdownDescription: docCategoryDatacenter + "This resource assigns one or more Connectivity Templates to an " + "Application Point. Application Points are graph nodes including interfaces at the " + "fabric edge, and switches within the fabric.", Attributes: blueprint.ConnectivityTemplateAssignment{}.ResourceAttributes(), diff --git a/apstra/resource_datacenter_device_allocation.go b/apstra/resource_datacenter_device_allocation.go index a027a712..156ee08f 100644 --- a/apstra/resource_datacenter_device_allocation.go +++ b/apstra/resource_datacenter_device_allocation.go @@ -30,7 +30,7 @@ func (o *resourceDeviceAllocation) Configure(ctx context.Context, req resource.C func (o *resourceDeviceAllocation) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource allocates a Managed Device (probably a switch) to a node role" + + MarkdownDescription: docCategoryDatacenter + "This resource allocates a Managed Device (probably a switch) to a node role" + " (spine1, etc...) within a Blueprint.", Attributes: blueprint.DeviceAllocation{}.ResourceAttributes(), } diff --git a/apstra/resource_datacenter_generic_system.go b/apstra/resource_datacenter_generic_system.go index 28d34ce9..adb7f44b 100644 --- a/apstra/resource_datacenter_generic_system.go +++ b/apstra/resource_datacenter_generic_system.go @@ -29,7 +29,7 @@ func (o *resourceDatacenterGenericSystem) Configure(ctx context.Context, req res func (o *resourceDatacenterGenericSystem) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Generic System within a Datacenter Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource creates a Generic System within a Datacenter Blueprint.", Attributes: blueprint.DatacenterGenericSystem{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_property_set.go b/apstra/resource_datacenter_property_set.go index 17f91e32..4de33e85 100644 --- a/apstra/resource_datacenter_property_set.go +++ b/apstra/resource_datacenter_property_set.go @@ -31,7 +31,7 @@ func (o *resourceDatacenterPropertySet) Configure(ctx context.Context, req resou func (o *resourceDatacenterPropertySet) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource imports a property set into a Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource imports a property set into a Blueprint.", Attributes: blueprint.DatacenterPropertySet{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_resource_pool_allocation.go b/apstra/resource_datacenter_resource_pool_allocation.go index 309b9c0a..86082328 100644 --- a/apstra/resource_datacenter_resource_pool_allocation.go +++ b/apstra/resource_datacenter_resource_pool_allocation.go @@ -29,7 +29,7 @@ func (o *resourcePoolAllocation) Configure(ctx context.Context, req resource.Con func (o *resourcePoolAllocation) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource allocates a resource pool to a role within a Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource allocates a resource pool to a role within a Blueprint.", Attributes: blueprint.PoolAllocation{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_routing_policy.go b/apstra/resource_datacenter_routing_policy.go index 41be7399..9d81c89f 100644 --- a/apstra/resource_datacenter_routing_policy.go +++ b/apstra/resource_datacenter_routing_policy.go @@ -29,7 +29,7 @@ func (o *resourceDatacenterRoutingPolicy) Configure(ctx context.Context, req res func (o *resourceDatacenterRoutingPolicy) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Routing Policy within a Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource creates a Routing Policy within a Blueprint.", Attributes: blueprint.DatacenterRoutingPolicy{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_routing_zone.go b/apstra/resource_datacenter_routing_zone.go index 306d17b6..203bb905 100644 --- a/apstra/resource_datacenter_routing_zone.go +++ b/apstra/resource_datacenter_routing_zone.go @@ -30,7 +30,7 @@ func (o *resourceDatacenterRoutingZone) Configure(ctx context.Context, req resou func (o *resourceDatacenterRoutingZone) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Routing Zone within a Datacenter Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource creates a Routing Zone within a Datacenter Blueprint.", Attributes: blueprint.DatacenterRoutingZone{}.ResourceAttributes(), } } diff --git a/apstra/resource_datacenter_virtual_network.go b/apstra/resource_datacenter_virtual_network.go index 351449ff..2d8b9875 100644 --- a/apstra/resource_datacenter_virtual_network.go +++ b/apstra/resource_datacenter_virtual_network.go @@ -34,7 +34,7 @@ func (o *resourceDatacenterVirtualNetwork) Configure(ctx context.Context, req re func (o *resourceDatacenterVirtualNetwork) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Virtual Network within a Blueprint.", + MarkdownDescription: docCategoryDatacenter + "This resource creates a Virtual Network within a Blueprint.", Attributes: blueprint.DatacenterVirtualNetwork{}.ResourceAttributes(), } } diff --git a/apstra/resource_integer_pool.go b/apstra/resource_integer_pool.go index 4b8e30ce..25aa2d77 100644 --- a/apstra/resource_integer_pool.go +++ b/apstra/resource_integer_pool.go @@ -29,7 +29,7 @@ func (o *resourceIntegerPool) Configure(ctx context.Context, req resource.Config func (o *resourceIntegerPool) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an Integer resource pool", + MarkdownDescription: docCategoryResources + "This resource creates an Integer resource pool", Attributes: resources.IntegerPool{}.ResourceAttributes(), } } diff --git a/apstra/resource_interface_map.go b/apstra/resource_interface_map.go index 336d1670..f31cc5f0 100644 --- a/apstra/resource_interface_map.go +++ b/apstra/resource_interface_map.go @@ -59,7 +59,7 @@ func (o *resourceInterfaceMap) Configure(_ context.Context, req resource.Configu func (o *resourceInterfaceMap) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an Interface Map", + MarkdownDescription: docCategoryDesign + "This resource creates an Interface Map", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ MarkdownDescription: "Apstra ID number of the Interface Map", diff --git a/apstra/resource_ipv4_pool.go b/apstra/resource_ipv4_pool.go index 489ac134..3b849a0f 100644 --- a/apstra/resource_ipv4_pool.go +++ b/apstra/resource_ipv4_pool.go @@ -29,7 +29,7 @@ func (o *resourceIpv4Pool) Configure(ctx context.Context, req resource.Configure func (o *resourceIpv4Pool) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an IPv4 resource pool", + MarkdownDescription: docCategoryResources + "This resource creates an IPv4 resource pool", Attributes: resources.Ipv4Pool{}.ResourceAttributes(), } } diff --git a/apstra/resource_ipv6_pool.go b/apstra/resource_ipv6_pool.go index c6471665..b1301990 100644 --- a/apstra/resource_ipv6_pool.go +++ b/apstra/resource_ipv6_pool.go @@ -29,7 +29,7 @@ func (o *resourceIpv6Pool) Configure(ctx context.Context, req resource.Configure func (o *resourceIpv6Pool) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an IPv6 resource pool", + MarkdownDescription: docCategoryResources + "This resource creates an IPv6 resource pool", Attributes: resources.Ipv6Pool{}.ResourceAttributes(), } } diff --git a/apstra/resource_logical_device.go b/apstra/resource_logical_device.go index db967e46..0b9499a7 100644 --- a/apstra/resource_logical_device.go +++ b/apstra/resource_logical_device.go @@ -29,7 +29,7 @@ func (o *resourceLogicalDevice) Configure(ctx context.Context, req resource.Conf func (o *resourceLogicalDevice) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Logical Device", + MarkdownDescription: docCategoryDesign + "This resource creates a Logical Device", Attributes: design.LogicalDevice{}.ResourceAttributes(), } } diff --git a/apstra/resource_managed_device.go b/apstra/resource_managed_device.go index 58e7984d..9693f20c 100644 --- a/apstra/resource_managed_device.go +++ b/apstra/resource_managed_device.go @@ -39,7 +39,7 @@ func (o *resourceManagedDevice) Configure(_ context.Context, req resource.Config func (o *resourceManagedDevice) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates/installs an Agent for an Apstra Managed Device." + + MarkdownDescription: docCategoryDevices + "This resource creates/installs an Agent for an Apstra Managed Device." + "Optionally, it will 'Acknowledge' the discovered system if the `device key` (serial number)" + "reported by the agent matches the optional `device_key` field.", Attributes: systemAgents.ManagedDevice{}.ResourceAttributes(), diff --git a/apstra/resource_managed_device_ack.go b/apstra/resource_managed_device_ack.go index 5326cbd1..66521245 100644 --- a/apstra/resource_managed_device_ack.go +++ b/apstra/resource_managed_device_ack.go @@ -28,7 +28,7 @@ func (o *resourceManagedDeviceAck) Configure(ctx context.Context, req resource.C func (o *resourceManagedDeviceAck) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource *acknowledges* the System " + + MarkdownDescription: docCategoryDevices + "This resource *acknowledges* the System " + "(probably a switch) discovered by a running System Agent. The " + "acknowledgement of a System cannot be modified nor deleted. " + "Any modification to the inputs of this resource will cause it " + diff --git a/apstra/resource_modular_device_profile.go b/apstra/resource_modular_device_profile.go index c1700d52..ab5c53bb 100644 --- a/apstra/resource_modular_device_profile.go +++ b/apstra/resource_modular_device_profile.go @@ -50,7 +50,7 @@ func (o *resourceModularDeviceProfile) Configure(ctx context.Context, req resour func (o *resourceModularDeviceProfile) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Device Profile for a chassis-based device", + MarkdownDescription: docCategoryDevices + "This resource creates a Device Profile for a chassis-based device", Attributes: device.ModularDeviceProfile{}.ResourceAttributes(), } } diff --git a/apstra/resource_property_set.go b/apstra/resource_property_set.go index a015b976..e8b743fb 100644 --- a/apstra/resource_property_set.go +++ b/apstra/resource_property_set.go @@ -28,7 +28,7 @@ func (o *resourcePropertySet) Configure(ctx context.Context, req resource.Config func (o *resourcePropertySet) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Property Set in the Apstra Design tab.", + MarkdownDescription: docCategoryDesign + "This resource creates a Property Set in the Apstra Design tab.", Attributes: design.PropertySet{}.ResourceAttributes(), } } diff --git a/apstra/resource_rack_type.go b/apstra/resource_rack_type.go index a7a493ac..057d98c2 100644 --- a/apstra/resource_rack_type.go +++ b/apstra/resource_rack_type.go @@ -26,7 +26,7 @@ func (o *resourceRackType) Configure(ctx context.Context, req resource.Configure func (o *resourceRackType) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Rack Type in the Apstra Design tab.", + MarkdownDescription: docCategoryDesign + "This resource creates a Rack Type in the Apstra Design tab.", Attributes: design.RackType{}.ResourceAttributes(), } } diff --git a/apstra/resource_tag.go b/apstra/resource_tag.go index 3b9ae56a..fc55711b 100644 --- a/apstra/resource_tag.go +++ b/apstra/resource_tag.go @@ -26,7 +26,7 @@ func (o *resourceTag) Configure(ctx context.Context, req resource.ConfigureReque func (o *resourceTag) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Tag in the Apstra Design tab.", + MarkdownDescription: docCategoryDesign + "This resource creates a Tag in the Apstra Design tab.", Attributes: design.Tag{}.ResourceAttributes(), } } diff --git a/apstra/resource_template_rack_based.go b/apstra/resource_template_rack_based.go index ab32c5dd..8cf73ced 100644 --- a/apstra/resource_template_rack_based.go +++ b/apstra/resource_template_rack_based.go @@ -33,7 +33,7 @@ func (o *resourceTemplateRackBased) Configure(ctx context.Context, req resource. func (o *resourceTemplateRackBased) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates a Rack Based Template for as a 3-stage Clos design, or for use as " + + MarkdownDescription: docCategoryDesign + "This resource creates a Rack Based Template for as a 3-stage Clos design, or for use as " + "pod in a 5-stage design.", Attributes: design.TemplateRackBased{}.ResourceAttributes(), } diff --git a/apstra/resource_vni_pool.go b/apstra/resource_vni_pool.go index 06ea806b..0b315a6b 100644 --- a/apstra/resource_vni_pool.go +++ b/apstra/resource_vni_pool.go @@ -29,7 +29,7 @@ func (o *resourceVniPool) Configure(ctx context.Context, req resource.ConfigureR func (o *resourceVniPool) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - MarkdownDescription: "This resource creates an VNI resource pool", + MarkdownDescription: docCategoryResources + "This resource creates an VNI resource pool", Attributes: resources.VniPool{}.ResourceAttributes(), } } diff --git a/docs/data-sources/agent.md b/docs/data-sources/agent.md index 212911d9..69d9d2e9 100644 --- a/docs/data-sources/agent.md +++ b/docs/data-sources/agent.md @@ -1,6 +1,6 @@ --- page_title: "apstra_agent Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This resource returns details of a Managed Device Agent. --- @@ -9,6 +9,7 @@ description: |- This resource returns details of a Managed Device Agent. + ## Example Usage ```terraform diff --git a/docs/data-sources/agent_profile.md b/docs/data-sources/agent_profile.md index 1a07d116..5c7bd4bd 100644 --- a/docs/data-sources/agent_profile.md +++ b/docs/data-sources/agent_profile.md @@ -1,6 +1,6 @@ --- page_title: "apstra_agent_profile Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This data source looks up details of an Agent Profile At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source looks up details of an Agent Profile At least one optional attribute is required. + ## Example Usage ```terraform @@ -37,7 +38,7 @@ output "agent_profiles_missing_credentials" { ### Optional -- `id` (String) Apstra ID of the Agent Profile. Required when `name` is omitted. +- `id` (String) Devices --- Apstra ID of the Agent Profile. Required when `name` is omitted. - `name` (String) Web UID name of the Agent Profile. Required when `id` is omitted. ### Read-Only diff --git a/docs/data-sources/agent_profiles.md b/docs/data-sources/agent_profiles.md index 3ed9020d..e9802e1d 100644 --- a/docs/data-sources/agent_profiles.md +++ b/docs/data-sources/agent_profiles.md @@ -1,6 +1,6 @@ --- page_title: "apstra_agent_profiles Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This data source returns the ID numbers of all Agent Profiles. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Agent Profiles. + ## Example Usage ```terraform diff --git a/docs/data-sources/agents.md b/docs/data-sources/agents.md index 2a3532be..6f466891 100644 --- a/docs/data-sources/agents.md +++ b/docs/data-sources/agents.md @@ -1,6 +1,6 @@ --- page_title: "apstra_agents Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This data source returns the IDs of Managed Device Agents. All of the filter attributes are optional. --- @@ -9,6 +9,7 @@ description: |- This data source returns the IDs of Managed Device Agents. All of the `filter` attributes are optional. + ## Example Usage ```terraform diff --git a/docs/data-sources/anomalies.md b/docs/data-sources/anomalies.md index ea2c3787..03933390 100644 --- a/docs/data-sources/anomalies.md +++ b/docs/data-sources/anomalies.md @@ -1,6 +1,6 @@ --- page_title: "apstra_anomalies Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source provides per-node summary, per-service summary and full details of anomalies in the specified Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source provides per-node summary, per-service summary and full details of anomalies in the specified Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/asn_pool.md b/docs/data-sources/asn_pool.md index 8a86449b..e028c786 100644 --- a/docs/data-sources/asn_pool.md +++ b/docs/data-sources/asn_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_asn_pool Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source provides details of a specific ASN Pool. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific ASN Pool. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/asn_pools.md b/docs/data-sources/asn_pools.md index 4c4f04ab..11c3436c 100644 --- a/docs/data-sources/asn_pools.md +++ b/docs/data-sources/asn_pools.md @@ -1,6 +1,6 @@ --- page_title: "apstra_asn_pools Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source returns the ID numbers of all ASN Pools. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all ASN Pools. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprint_deployment.md b/docs/data-sources/blueprint_deployment.md index 7a5050ba..cb2bc5b7 100644 --- a/docs/data-sources/blueprint_deployment.md +++ b/docs/data-sources/blueprint_deployment.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_deployment Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns the deployment status of a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source returns the deployment status of a Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprint_iba_dashboard.md b/docs/data-sources/blueprint_iba_dashboard.md index a51f25c4..62854c8a 100644 --- a/docs/data-sources/blueprint_iba_dashboard.md +++ b/docs/data-sources/blueprint_iba_dashboard.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_dashboard Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source provides details of a specific IBA Dashboard in a Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific IBA Dashboard in a Blueprint. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprint_iba_dashboards.md b/docs/data-sources/blueprint_iba_dashboards.md index a56dc2c5..91b71b7e 100644 --- a/docs/data-sources/blueprint_iba_dashboards.md +++ b/docs/data-sources/blueprint_iba_dashboards.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_dashboards Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source returns the ID numbers of all IBA Dashboards in a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all IBA Dashboards in a Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprint_iba_predefined_probe.md b/docs/data-sources/blueprint_iba_predefined_probe.md index be6c6a0b..aaf7c14d 100644 --- a/docs/data-sources/blueprint_iba_predefined_probe.md +++ b/docs/data-sources/blueprint_iba_predefined_probe.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_predefined_probe Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source provides details of a specific IBA Predefined Probe in a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source provides details of a specific IBA Predefined Probe in a Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprint_iba_widget.md b/docs/data-sources/blueprint_iba_widget.md index 16ab56b5..18b268f6 100644 --- a/docs/data-sources/blueprint_iba_widget.md +++ b/docs/data-sources/blueprint_iba_widget.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_widget Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source provides details of a specific IBA Widget in a Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific IBA Widget in a Blueprint. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprint_iba_widgets.md b/docs/data-sources/blueprint_iba_widgets.md index 611dacd5..3e1f201f 100644 --- a/docs/data-sources/blueprint_iba_widgets.md +++ b/docs/data-sources/blueprint_iba_widgets.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_widgets Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source returns the IDs of the IBA Widgets in a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source returns the IDs of the IBA Widgets in a Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/blueprints.md b/docs/data-sources/blueprints.md index 74347360..6bb927d2 100644 --- a/docs/data-sources/blueprints.md +++ b/docs/data-sources/blueprints.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprints Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source returns the ID numbers of Blueprints. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of Blueprints. + ## Example Usage ```terraform diff --git a/docs/data-sources/configlet.md b/docs/data-sources/configlet.md index 21d1f8ec..01874cdf 100644 --- a/docs/data-sources/configlet.md +++ b/docs/data-sources/configlet.md @@ -1,6 +1,6 @@ --- page_title: "apstra_configlet Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source provides details of a specific Configlet. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Configlet. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/configlets.md b/docs/data-sources/configlets.md index c6f6ac5b..3cfe0439 100644 --- a/docs/data-sources/configlets.md +++ b/docs/data-sources/configlets.md @@ -1,6 +1,6 @@ --- page_title: "apstra_configlets Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source returns the ID numbers of all Configlets. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Configlets. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_blueprint.md b/docs/data-sources/datacenter_blueprint.md index 4b2def5d..0929d6be 100644 --- a/docs/data-sources/datacenter_blueprint.md +++ b/docs/data-sources/datacenter_blueprint.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_blueprint Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source looks up summary details of a Datacenter Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source looks up summary details of a Datacenter Blueprint. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_configlet.md b/docs/data-sources/datacenter_configlet.md index adea6b24..e53db038 100644 --- a/docs/data-sources/datacenter_configlet.md +++ b/docs/data-sources/datacenter_configlet.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_configlet Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source provides details of a specific Configlet imported into a Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Configlet imported into a Bluepr At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_configlets.md b/docs/data-sources/datacenter_configlets.md index 40c6d7a8..79645ec5 100644 --- a/docs/data-sources/datacenter_configlets.md +++ b/docs/data-sources/datacenter_configlets.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_configlets Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns the ID numbers of all Configlets in a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Configlets in a Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_bgp_peering_generic_system.md b/docs/data-sources/datacenter_ct_bgp_peering_generic_system.md index 3f62d6be..10c9bd2f 100644 --- a/docs/data-sources/datacenter_ct_bgp_peering_generic_system.md +++ b/docs/data-sources/datacenter_ct_bgp_peering_generic_system.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_bgp_peering_generic_system Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_bgp_peering_ip_endpoint.md b/docs/data-sources/datacenter_ct_bgp_peering_ip_endpoint.md index f80ad498..58d791a6 100644 --- a/docs/data-sources/datacenter_ct_bgp_peering_ip_endpoint.md +++ b/docs/data-sources/datacenter_ct_bgp_peering_ip_endpoint.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_bgp_peering_ip_endpoint Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_custom_static_route.md b/docs/data-sources/datacenter_ct_custom_static_route.md index 29d32443..c151c41d 100644 --- a/docs/data-sources/datacenter_ct_custom_static_route.md +++ b/docs/data-sources/datacenter_ct_custom_static_route.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_custom_static_route Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_dynamic_bgp_peering.md b/docs/data-sources/datacenter_ct_dynamic_bgp_peering.md index b8592bba..ddc51818 100644 --- a/docs/data-sources/datacenter_ct_dynamic_bgp_peering.md +++ b/docs/data-sources/datacenter_ct_dynamic_bgp_peering.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_dynamic_bgp_peering Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_ip_link.md b/docs/data-sources/datacenter_ct_ip_link.md index b5e097e2..3d33bb62 100644 --- a/docs/data-sources/datacenter_ct_ip_link.md +++ b/docs/data-sources/datacenter_ct_ip_link.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_ip_link Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_routing_policy.md b/docs/data-sources/datacenter_ct_routing_policy.md index fbf5afaa..e9bca9da 100644 --- a/docs/data-sources/datacenter_ct_routing_policy.md +++ b/docs/data-sources/datacenter_ct_routing_policy.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_routing_policy Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_routing_zone_constraint.md b/docs/data-sources/datacenter_ct_routing_zone_constraint.md index 740bdb5c..22ab862b 100644 --- a/docs/data-sources/datacenter_ct_routing_zone_constraint.md +++ b/docs/data-sources/datacenter_ct_routing_zone_constraint.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_routing_zone_constraint Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_static_route.md b/docs/data-sources/datacenter_ct_static_route.md index 4210ddf0..12e156d2 100644 --- a/docs/data-sources/datacenter_ct_static_route.md +++ b/docs/data-sources/datacenter_ct_static_route.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_static_route Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_virtual_network_multiple.md b/docs/data-sources/datacenter_ct_virtual_network_multiple.md index c2c6edad..a0ff7821 100644 --- a/docs/data-sources/datacenter_ct_virtual_network_multiple.md +++ b/docs/data-sources/datacenter_ct_virtual_network_multiple.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_virtual_network_multiple Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_ct_virtual_network_single.md b/docs/data-sources/datacenter_ct_virtual_network_single.md index f3f16e42..1dbb479d 100644 --- a/docs/data-sources/datacenter_ct_virtual_network_single.md +++ b/docs/data-sources/datacenter_ct_virtual_network_single.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_ct_virtual_network_single Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the primitives attribute of an apstra_datacenter_connectivity_template resource or the child_primitives attribute of a Different Connectivity Template Primitive. --- @@ -9,6 +9,7 @@ description: |- This data source composes a Connectivity Template Primitive as a JSON string, suitable for use in the `primitives` attribute of an `apstra_datacenter_connectivity_template` resource or the `child_primitives` attribute of a Different Connectivity Template Primitive. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_interfaces_by_link_tag.md b/docs/data-sources/datacenter_interfaces_by_link_tag.md index c2973e3b..6f2b9163 100644 --- a/docs/data-sources/datacenter_interfaces_by_link_tag.md +++ b/docs/data-sources/datacenter_interfaces_by_link_tag.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_interfaces_by_link_tag Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns the IDs of Interfaces by Link Tag. --- @@ -9,6 +9,7 @@ description: |- This data source returns the IDs of Interfaces by Link Tag. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_interfaces_by_system.md b/docs/data-sources/datacenter_interfaces_by_system.md index 65faf3e2..8c6f8952 100644 --- a/docs/data-sources/datacenter_interfaces_by_system.md +++ b/docs/data-sources/datacenter_interfaces_by_system.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_interfaces_by_system Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns a map of Interface IDs keyed by Interface Name for the given System ID. --- @@ -9,6 +9,7 @@ description: |- This data source returns a map of Interface IDs keyed by Interface Name for the given System ID. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_property_set.md b/docs/data-sources/datacenter_property_set.md index 9964a5ae..d816e8a4 100644 --- a/docs/data-sources/datacenter_property_set.md +++ b/docs/data-sources/datacenter_property_set.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_property_set Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source provides details of a specific Property Set imported into a Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Property Set imported into a Blu At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_property_sets.md b/docs/data-sources/datacenter_property_sets.md index fe701f3c..dc2558d9 100644 --- a/docs/data-sources/datacenter_property_sets.md +++ b/docs/data-sources/datacenter_property_sets.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_property_sets Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source returns the ID numbers of all Property Sets in the Blueprint. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Property Sets in the Blueprint. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_routing_policies.md b/docs/data-sources/datacenter_routing_policies.md index aa802f97..b403f035 100644 --- a/docs/data-sources/datacenter_routing_policies.md +++ b/docs/data-sources/datacenter_routing_policies.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_routing_policies Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns Graph DB node IDs of routing_policy nodes within a Blueprint. Optional filters can be used select only interesting nodes. @@ -12,6 +12,7 @@ This data source returns Graph DB node IDs of *routing_policy* nodes within a Bl Optional `filters` can be used select only interesting nodes. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_routing_policy.md b/docs/data-sources/datacenter_routing_policy.md index ce07bc25..e9206e13 100644 --- a/docs/data-sources/datacenter_routing_policy.md +++ b/docs/data-sources/datacenter_routing_policy.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_routing_policy Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns details of a Datacenter Routing Policy. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source returns details of a Datacenter Routing Policy. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_routing_zone.md b/docs/data-sources/datacenter_routing_zone.md index 73dd1af9..370e3486 100644 --- a/docs/data-sources/datacenter_routing_zone.md +++ b/docs/data-sources/datacenter_routing_zone.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_routing_zone Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource returns details of a Routing Zone within a Datacenter Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This resource returns details of a Routing Zone within a Datacenter Blueprint. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_routing_zones.md b/docs/data-sources/datacenter_routing_zones.md index 35ef4384..6ffcd16f 100644 --- a/docs/data-sources/datacenter_routing_zones.md +++ b/docs/data-sources/datacenter_routing_zones.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_routing_zones Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns the IDs of Routing Zones within the specified Blueprint. All of the filter attributes are optional. --- @@ -9,6 +9,7 @@ description: |- This data source returns the IDs of Routing Zones within the specified Blueprint. All of the `filter` attributes are optional. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_svis_map.md b/docs/data-sources/datacenter_svis_map.md index 2a30b868..e37808c6 100644 --- a/docs/data-sources/datacenter_svis_map.md +++ b/docs/data-sources/datacenter_svis_map.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_svis_map Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns a maps of Sets of SVI info keyed by Virtual Network ID, System ID and SVI ID. --- @@ -9,6 +9,7 @@ description: |- This data source returns a maps of Sets of SVI info keyed by Virtual Network ID, System ID and SVI ID. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_system.md b/docs/data-sources/datacenter_system.md index 74da0c75..1e6a3274 100644 --- a/docs/data-sources/datacenter_system.md +++ b/docs/data-sources/datacenter_system.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_system Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns details of a specific system Graph DB node within a Blueprint. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source returns details of a specific *system* Graph DB node within a B At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_systems.md b/docs/data-sources/datacenter_systems.md index 5aa549d5..5934ace9 100644 --- a/docs/data-sources/datacenter_systems.md +++ b/docs/data-sources/datacenter_systems.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_systems Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns Graph DB node IDs of system nodes within a Blueprint. Optional filters can be used to select only interesting nodes. @@ -12,6 +12,7 @@ This data source returns Graph DB node IDs of *system* nodes within a Blueprint. Optional `filters` can be used to select only interesting nodes. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_virtual_network_binding_constructor.md b/docs/data-sources/datacenter_virtual_network_binding_constructor.md index 40534439..5c1a8588 100644 --- a/docs/data-sources/datacenter_virtual_network_binding_constructor.md +++ b/docs/data-sources/datacenter_virtual_network_binding_constructor.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_virtual_network_binding_constructor Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source can be used to calculate the bindings data required by apstra_datacenter_virtual_network. Given a list of switch node IDSs, it determines whether they're leaf or access nodes, replaces individual switch IDs with ESI or MLAG redundancy group IDs, finds required parent leaf switches of all access switches. @@ -12,6 +12,7 @@ This data source can be used to calculate the `bindings` data required by `apstr Given a list of switch node IDSs, it determines whether they're leaf or access nodes, replaces individual switch IDs with ESI or MLAG redundancy group IDs, finds required parent leaf switches of all access switches. + ## Example Usage ```terraform diff --git a/docs/data-sources/datacenter_virtual_networks.md b/docs/data-sources/datacenter_virtual_networks.md index cdc3794f..ca9a2cc3 100644 --- a/docs/data-sources/datacenter_virtual_networks.md +++ b/docs/data-sources/datacenter_virtual_networks.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_virtual_networks Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This data source returns the IDs of Virtual Networks within the specified Blueprint. All of the filter attributes are optional. --- @@ -9,6 +9,7 @@ description: |- This data source returns the IDs of Virtual Networks within the specified Blueprint. All of the `filter` attributes are optional. + ## Example Usage ```terraform diff --git a/docs/data-sources/integer_pool.md b/docs/data-sources/integer_pool.md index 29433bd6..99b863d1 100644 --- a/docs/data-sources/integer_pool.md +++ b/docs/data-sources/integer_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_integer_pool Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source provides details of a specific Integer Pool. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Integer Pool. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/integer_pools.md b/docs/data-sources/integer_pools.md index 1d2d23ff..b6e0c8d4 100644 --- a/docs/data-sources/integer_pools.md +++ b/docs/data-sources/integer_pools.md @@ -1,6 +1,6 @@ --- page_title: "apstra_integer_pools Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source returns the ID numbers of all Integer Pools. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Integer Pools. + ## Example Usage ```terraform diff --git a/docs/data-sources/interface_map.md b/docs/data-sources/interface_map.md index 4474ca46..152d5e8d 100644 --- a/docs/data-sources/interface_map.md +++ b/docs/data-sources/interface_map.md @@ -1,6 +1,6 @@ --- page_title: "apstra_interface_map Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source provides details of a specific Interface Map. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Interface Map. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/interface_maps.md b/docs/data-sources/interface_maps.md index 87bbc4a8..0a2af8bc 100644 --- a/docs/data-sources/interface_maps.md +++ b/docs/data-sources/interface_maps.md @@ -1,6 +1,6 @@ --- page_title: "apstra_interface_maps Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source returns the ID numbers of Interface Maps. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of Interface Maps. + ## Example Usage ```terraform diff --git a/docs/data-sources/ipv4_pool.md b/docs/data-sources/ipv4_pool.md index e5cd95d4..a7d88eca 100644 --- a/docs/data-sources/ipv4_pool.md +++ b/docs/data-sources/ipv4_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_ipv4_pool Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source provides details of a specific IPv4 Pool. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific IPv4 Pool. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/ipv4_pools.md b/docs/data-sources/ipv4_pools.md index 1b463dcf..137cf428 100644 --- a/docs/data-sources/ipv4_pools.md +++ b/docs/data-sources/ipv4_pools.md @@ -1,6 +1,6 @@ --- page_title: "apstra_ipv4_pools Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source returns the ID numbers of all IPv4 Pools --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all IPv4 Pools + ## Example Usage ```terraform diff --git a/docs/data-sources/ipv6_pool.md b/docs/data-sources/ipv6_pool.md index e2e0ec13..c395fdb7 100644 --- a/docs/data-sources/ipv6_pool.md +++ b/docs/data-sources/ipv6_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_ipv6_pool Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source provides details of a specific IPv6 Pool. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific IPv6 Pool. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/ipv6_pools.md b/docs/data-sources/ipv6_pools.md index fa7d7168..ec47414a 100644 --- a/docs/data-sources/ipv6_pools.md +++ b/docs/data-sources/ipv6_pools.md @@ -1,6 +1,6 @@ --- page_title: "apstra_ipv6_pools Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source returns the ID numbers of all IPv6 Pools --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all IPv6 Pools + ## Example Usage ```terraform diff --git a/docs/data-sources/logical_device.md b/docs/data-sources/logical_device.md index a3d119a8..f7259fb7 100644 --- a/docs/data-sources/logical_device.md +++ b/docs/data-sources/logical_device.md @@ -1,6 +1,6 @@ --- page_title: "apstra_logical_device Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source provides details of a specific Logical Device. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Logical Device. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/property_set.md b/docs/data-sources/property_set.md index 23a17655..612a8723 100644 --- a/docs/data-sources/property_set.md +++ b/docs/data-sources/property_set.md @@ -1,6 +1,6 @@ --- page_title: "apstra_property_set Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source provides details of a specific PropertySet. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific PropertySet. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/property_sets.md b/docs/data-sources/property_sets.md index d74c1bac..bf84ae4f 100644 --- a/docs/data-sources/property_sets.md +++ b/docs/data-sources/property_sets.md @@ -1,6 +1,6 @@ --- page_title: "apstra_property_sets Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This data source returns the ID numbers of all Property Sets. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Property Sets. + ## Example Usage ```terraform diff --git a/docs/data-sources/rack_type.md b/docs/data-sources/rack_type.md index 8295673c..0640d43a 100644 --- a/docs/data-sources/rack_type.md +++ b/docs/data-sources/rack_type.md @@ -1,6 +1,6 @@ --- page_title: "apstra_rack_type Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source provides details of a specific Rack Type. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Rack Type. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/rack_types.md b/docs/data-sources/rack_types.md index 6bc4b146..c11ee909 100644 --- a/docs/data-sources/rack_types.md +++ b/docs/data-sources/rack_types.md @@ -1,6 +1,6 @@ --- page_title: "apstra_rack_types Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source returns the ID numbers of all Rack Types. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all Rack Types. + ## Example Usage ```terraform diff --git a/docs/data-sources/tag.md b/docs/data-sources/tag.md index c1cea601..bee08cd7 100644 --- a/docs/data-sources/tag.md +++ b/docs/data-sources/tag.md @@ -1,6 +1,6 @@ --- page_title: "apstra_tag Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source provides details of a specific Tag. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Tag. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/template_rack_based.md b/docs/data-sources/template_rack_based.md index 917693b8..2b55e6a4 100644 --- a/docs/data-sources/template_rack_based.md +++ b/docs/data-sources/template_rack_based.md @@ -1,6 +1,6 @@ --- page_title: "apstra_template_rack_based Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source provides details of a specific Rack Based (3 stage) Template. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific Rack Based (3 stage) Template. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/templates.md b/docs/data-sources/templates.md index b14a68c7..375064c8 100644 --- a/docs/data-sources/templates.md +++ b/docs/data-sources/templates.md @@ -1,6 +1,6 @@ --- page_title: "apstra_templates Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This data source returns the ID numbers of Templates. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of Templates. + ## Example Usage ```terraform diff --git a/docs/data-sources/vni_pool.md b/docs/data-sources/vni_pool.md index 2c6c379c..72b9865e 100644 --- a/docs/data-sources/vni_pool.md +++ b/docs/data-sources/vni_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_vni_pool Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source provides details of a specific VNI Pool. At least one optional attribute is required. @@ -12,6 +12,7 @@ This data source provides details of a specific VNI Pool. At least one optional attribute is required. + ## Example Usage ```terraform diff --git a/docs/data-sources/vni_pools.md b/docs/data-sources/vni_pools.md index a0ffe5d9..dab1bb05 100644 --- a/docs/data-sources/vni_pools.md +++ b/docs/data-sources/vni_pools.md @@ -1,6 +1,6 @@ --- page_title: "apstra_vni_pools Data Source - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This data source returns the ID numbers of all VNI Pools. --- @@ -9,6 +9,7 @@ description: |- This data source returns the ID numbers of all VNI Pools. + ## Example Usage ```terraform diff --git a/docs/resources/agent_profile.md b/docs/resources/agent_profile.md index fd109c80..fcbbdb5c 100644 --- a/docs/resources/agent_profile.md +++ b/docs/resources/agent_profile.md @@ -1,6 +1,6 @@ --- page_title: "apstra_agent_profile Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This resource creates an Agent Profile. Note that credentials (username/password) cannot be set using this resource because (a) Apstra doesn't allow them to be retrieved, so it's impossible for terraform to detect drift and because (b) leaving credentials in the configuration/state isn't a safe practice. --- @@ -9,6 +9,7 @@ description: |- This resource creates an Agent Profile. Note that credentials (username/password) cannot be set using this resource because (a) Apstra doesn't allow them to be retrieved, so it's impossible for terraform to detect drift and because (b) leaving credentials in the configuration/state isn't a safe practice. + ## Example Usage ```terraform diff --git a/docs/resources/asn_pool.md b/docs/resources/asn_pool.md index e4487fc0..55ec82df 100644 --- a/docs/resources/asn_pool.md +++ b/docs/resources/asn_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_asn_pool Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This resource creates an ASN resource pool --- @@ -9,6 +9,7 @@ description: |- This resource creates an ASN resource pool + ## Example Usage ```terraform diff --git a/docs/resources/blueprint_deployment.md b/docs/resources/blueprint_deployment.md index 2de48c45..6d36428e 100644 --- a/docs/resources/blueprint_deployment.md +++ b/docs/resources/blueprint_deployment.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_deployment Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This resource commits a staging Blueprint after checking for build errors. --- @@ -9,6 +9,7 @@ description: |- This resource commits a staging Blueprint after checking for build errors. + ## Example Usage ```terraform diff --git a/docs/resources/blueprint_iba_dashboard.md b/docs/resources/blueprint_iba_dashboard.md index e8ac1b2d..3297c617 100644 --- a/docs/resources/blueprint_iba_dashboard.md +++ b/docs/resources/blueprint_iba_dashboard.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_dashboard Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This resource creates a IBA Dashboard. --- @@ -9,6 +9,7 @@ description: |- This resource creates a IBA Dashboard. + ## Example Usage ```terraform diff --git a/docs/resources/blueprint_iba_probe.md b/docs/resources/blueprint_iba_probe.md index b5262c65..df042299 100644 --- a/docs/resources/blueprint_iba_probe.md +++ b/docs/resources/blueprint_iba_probe.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_probe Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This resource creates an IBA Probe within a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource creates an IBA Probe within a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/blueprint_iba_widget.md b/docs/resources/blueprint_iba_widget.md index 82a7bc3e..b4289412 100644 --- a/docs/resources/blueprint_iba_widget.md +++ b/docs/resources/blueprint_iba_widget.md @@ -1,6 +1,6 @@ --- page_title: "apstra_blueprint_iba_widget Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This resource creates an IBA Widget. --- @@ -9,6 +9,7 @@ description: |- This resource creates an IBA Widget. + ## Example Usage ```terraform diff --git a/docs/resources/configlet.md b/docs/resources/configlet.md index 2287ad08..f41fd53d 100644 --- a/docs/resources/configlet.md +++ b/docs/resources/configlet.md @@ -1,6 +1,6 @@ --- page_title: "apstra_configlet Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource creates a specific Configlet. --- @@ -9,6 +9,7 @@ description: |- This resource creates a specific Configlet. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_blueprint.md b/docs/resources/datacenter_blueprint.md index 3ce6f0b7..a17cb042 100644 --- a/docs/resources/datacenter_blueprint.md +++ b/docs/resources/datacenter_blueprint.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_blueprint Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource instantiates a Datacenter Blueprint from a template. --- @@ -9,6 +9,7 @@ description: |- This resource instantiates a Datacenter Blueprint from a template. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_configlet.md b/docs/resources/datacenter_configlet.md index c4d5660b..20c618ca 100644 --- a/docs/resources/datacenter_configlet.md +++ b/docs/resources/datacenter_configlet.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_configlet Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource imports a Configlet into a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource imports a Configlet into a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_connectivity_template.md b/docs/resources/datacenter_connectivity_template.md index 139e68ab..6f0ed866 100644 --- a/docs/resources/datacenter_connectivity_template.md +++ b/docs/resources/datacenter_connectivity_template.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_connectivity_template Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource creates a Connectivity Template within a Datacenter Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Connectivity Template within a Datacenter Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_connectivity_template_assignment.md b/docs/resources/datacenter_connectivity_template_assignment.md index 54ca5cbf..82e4d83e 100644 --- a/docs/resources/datacenter_connectivity_template_assignment.md +++ b/docs/resources/datacenter_connectivity_template_assignment.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_connectivity_template_assignment Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource assigns one or more Connectivity Templates to an Application Point. Application Points are graph nodes including interfaces at the fabric edge, and switches within the fabric. --- @@ -9,6 +9,7 @@ description: |- This resource assigns one or more Connectivity Templates to an Application Point. Application Points are graph nodes including interfaces at the fabric edge, and switches within the fabric. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_device_allocation.md b/docs/resources/datacenter_device_allocation.md index c9a27640..bd27ab57 100644 --- a/docs/resources/datacenter_device_allocation.md +++ b/docs/resources/datacenter_device_allocation.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_device_allocation Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This resource allocates a Managed Device (probably a switch) to a node role (spine1, etc...) within a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource allocates a Managed Device (probably a switch) to a node role (spine1, etc...) within a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_generic_system.md b/docs/resources/datacenter_generic_system.md index 688a5588..0254a2ec 100644 --- a/docs/resources/datacenter_generic_system.md +++ b/docs/resources/datacenter_generic_system.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_generic_system Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource creates a Generic System within a Datacenter Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Generic System within a Datacenter Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_property_set.md b/docs/resources/datacenter_property_set.md index 447c170d..c6b8a08c 100644 --- a/docs/resources/datacenter_property_set.md +++ b/docs/resources/datacenter_property_set.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_property_set Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource imports a property set into a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource imports a property set into a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_resource_pool_allocation.md b/docs/resources/datacenter_resource_pool_allocation.md index de8e1f7c..08bf58de 100644 --- a/docs/resources/datacenter_resource_pool_allocation.md +++ b/docs/resources/datacenter_resource_pool_allocation.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_resource_pool_allocation Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Any" description: |- This resource allocates a resource pool to a role within a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource allocates a resource pool to a role within a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_routing_policy.md b/docs/resources/datacenter_routing_policy.md index 8e64302a..fb4b00f5 100644 --- a/docs/resources/datacenter_routing_policy.md +++ b/docs/resources/datacenter_routing_policy.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_routing_policy Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource creates a Routing Policy within a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Routing Policy within a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_routing_zone.md b/docs/resources/datacenter_routing_zone.md index 3dfd8d01..b806943e 100644 --- a/docs/resources/datacenter_routing_zone.md +++ b/docs/resources/datacenter_routing_zone.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_routing_zone Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource creates a Routing Zone within a Datacenter Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Routing Zone within a Datacenter Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/datacenter_virtual_network.md b/docs/resources/datacenter_virtual_network.md index a6868a2a..077e9a68 100644 --- a/docs/resources/datacenter_virtual_network.md +++ b/docs/resources/datacenter_virtual_network.md @@ -1,6 +1,6 @@ --- page_title: "apstra_datacenter_virtual_network Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "RefDesign: Datacenter" description: |- This resource creates a Virtual Network within a Blueprint. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Virtual Network within a Blueprint. + ## Example Usage ```terraform diff --git a/docs/resources/integer_pool.md b/docs/resources/integer_pool.md index 3a7d52a3..630a4f0f 100644 --- a/docs/resources/integer_pool.md +++ b/docs/resources/integer_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_integer_pool Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This resource creates an Integer resource pool --- @@ -9,6 +9,7 @@ description: |- This resource creates an Integer resource pool + ## Example Usage ```terraform diff --git a/docs/resources/interface_map.md b/docs/resources/interface_map.md index f78126c2..52c19b2c 100644 --- a/docs/resources/interface_map.md +++ b/docs/resources/interface_map.md @@ -1,6 +1,6 @@ --- page_title: "apstra_interface_map Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates an Interface Map --- @@ -9,6 +9,7 @@ description: |- This resource creates an Interface Map + ## Example Usage ```terraform diff --git a/docs/resources/ipv4_pool.md b/docs/resources/ipv4_pool.md index 64d23624..738343fb 100644 --- a/docs/resources/ipv4_pool.md +++ b/docs/resources/ipv4_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_ipv4_pool Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This resource creates an IPv4 resource pool --- @@ -9,6 +9,7 @@ description: |- This resource creates an IPv4 resource pool + ## Example Usage ```terraform diff --git a/docs/resources/ipv6_pool.md b/docs/resources/ipv6_pool.md index 64276c83..cd5b7758 100644 --- a/docs/resources/ipv6_pool.md +++ b/docs/resources/ipv6_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_ipv6_pool Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This resource creates an IPv6 resource pool --- @@ -9,6 +9,7 @@ description: |- This resource creates an IPv6 resource pool + ## Example Usage ```terraform diff --git a/docs/resources/logical_device.md b/docs/resources/logical_device.md index 90e2d06d..9af180fc 100644 --- a/docs/resources/logical_device.md +++ b/docs/resources/logical_device.md @@ -1,6 +1,6 @@ --- page_title: "apstra_logical_device Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates a Logical Device --- @@ -9,6 +9,7 @@ description: |- This resource creates a Logical Device + ## Example Usage ```terraform diff --git a/docs/resources/managed_device.md b/docs/resources/managed_device.md index fcd64097..babf53a1 100644 --- a/docs/resources/managed_device.md +++ b/docs/resources/managed_device.md @@ -1,6 +1,6 @@ --- page_title: "apstra_managed_device Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This resource creates/installs an Agent for an Apstra Managed Device.Optionally, it will 'Acknowledge' the discovered system if the device key (serial number)reported by the agent matches the optional device_key field. --- @@ -9,6 +9,7 @@ description: |- This resource creates/installs an Agent for an Apstra Managed Device.Optionally, it will 'Acknowledge' the discovered system if the `device key` (serial number)reported by the agent matches the optional `device_key` field. + ## Example Usage ```terraform diff --git a/docs/resources/managed_device_ack.md b/docs/resources/managed_device_ack.md index ed48dc79..d20e56a2 100644 --- a/docs/resources/managed_device_ack.md +++ b/docs/resources/managed_device_ack.md @@ -1,6 +1,6 @@ --- page_title: "apstra_managed_device_ack Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Devices" description: |- This resource acknowledges the System (probably a switch) discovered by a running System Agent. The acknowledgement of a System cannot be modified nor deleted. Any modification to the inputs of this resource will cause it to be removed from the Terraform state and recreated. Modifying or deleting this resource has no effect on Apstra. --- @@ -9,6 +9,7 @@ description: |- This resource *acknowledges* the System (probably a switch) discovered by a running System Agent. The acknowledgement of a System cannot be modified nor deleted. Any modification to the inputs of this resource will cause it to be removed from the Terraform state and recreated. Modifying or deleting this resource has no effect on Apstra. + ## Example Usage ```terraform diff --git a/docs/resources/modular_device_profile.md b/docs/resources/modular_device_profile.md index 2307f35e..3da43dd6 100644 --- a/docs/resources/modular_device_profile.md +++ b/docs/resources/modular_device_profile.md @@ -1,6 +1,6 @@ --- page_title: "apstra_modular_device_profile Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates a Device Profile for a chassis-based device --- @@ -9,6 +9,7 @@ description: |- This resource creates a Device Profile for a chassis-based device + ## Example Usage ```terraform diff --git a/docs/resources/property_set.md b/docs/resources/property_set.md index 2280edc1..cc5c6308 100644 --- a/docs/resources/property_set.md +++ b/docs/resources/property_set.md @@ -1,6 +1,6 @@ --- page_title: "apstra_property_set Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates a Property Set in the Apstra Design tab. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Property Set in the Apstra Design tab. + ## Example Usage ```terraform diff --git a/docs/resources/rack_type.md b/docs/resources/rack_type.md index 34eb445b..d321036a 100644 --- a/docs/resources/rack_type.md +++ b/docs/resources/rack_type.md @@ -1,6 +1,6 @@ --- page_title: "apstra_rack_type Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates a Rack Type in the Apstra Design tab. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Rack Type in the Apstra Design tab. + ## Example Usage ```terraform diff --git a/docs/resources/tag.md b/docs/resources/tag.md index 694e17b1..fae4590b 100644 --- a/docs/resources/tag.md +++ b/docs/resources/tag.md @@ -1,6 +1,6 @@ --- page_title: "apstra_tag Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates a Tag in the Apstra Design tab. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Tag in the Apstra Design tab. + ## Example Usage ```terraform diff --git a/docs/resources/template_rack_based.md b/docs/resources/template_rack_based.md index 24f2819c..3c9b53e3 100644 --- a/docs/resources/template_rack_based.md +++ b/docs/resources/template_rack_based.md @@ -1,6 +1,6 @@ --- page_title: "apstra_template_rack_based Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Design" description: |- This resource creates a Rack Based Template for as a 3-stage Clos design, or for use as pod in a 5-stage design. --- @@ -9,6 +9,7 @@ description: |- This resource creates a Rack Based Template for as a 3-stage Clos design, or for use as pod in a 5-stage design. + ## Example Usage ```terraform diff --git a/docs/resources/vni_pool.md b/docs/resources/vni_pool.md index 6dc517a1..5c6dbccc 100644 --- a/docs/resources/vni_pool.md +++ b/docs/resources/vni_pool.md @@ -1,6 +1,6 @@ --- page_title: "apstra_vni_pool Resource - terraform-provider-apstra" -subcategory: "" +subcategory: "Resources" description: |- This resource creates an VNI resource pool --- @@ -9,6 +9,7 @@ description: |- This resource creates an VNI resource pool + ## Example Usage ```terraform diff --git a/scripts/tfplugindocs.sh b/scripts/tfplugindocs.sh index 05261003..2b166228 100755 --- a/scripts/tfplugindocs.sh +++ b/scripts/tfplugindocs.sh @@ -2,6 +2,11 @@ go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs || exit 1 +grep -E '^subcategory: ""$' docs/data-sources/* && echo "missing subcategory" && exit 1 + +grep -E '^subcategory: ""$' docs/resources//* && echo "missing subcategory" && exit 1 + git update-index --refresh || exit 1 git diff-index --quiet HEAD -- || exit 1 + diff --git a/templates/data-sources.md.tmpl b/templates/data-sources.md.tmpl index 6d428d18..cbea4727 100644 --- a/templates/data-sources.md.tmpl +++ b/templates/data-sources.md.tmpl @@ -1,13 +1,25 @@ --- page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +{{ if gt (len (split .Description " --- ")) 1 -}} +subcategory: "{{ index (split .Description " --- ") 0 }}" +{{- else -}} subcategory: "" +{{- end }} description: |- +{{ if gt (len (split .Description " --- ")) 1 -}} +{{ index (split .Description " --- ") 1 | plainmarkdown | trimspace | prefixlines " " }} +{{- else -}} {{ .Description | plainmarkdown | trimspace | prefixlines " " }} +{{- end }} --- # {{.Name}} ({{.Type}}) +{{ if gt (len (split .Description " --- ")) 1 -}} +{{ index (split .Description " --- ") 1 | trimspace }} +{{ else }} {{ .Description | trimspace }} +{{- end }} ## Example Usage diff --git a/templates/resources.md.tmpl b/templates/resources.md.tmpl index 315cc7e9..7bed939b 100644 --- a/templates/resources.md.tmpl +++ b/templates/resources.md.tmpl @@ -1,13 +1,25 @@ --- page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +{{ if gt (len (split .Description " --- ")) 1 -}} +subcategory: "{{ index (split .Description " --- ") 0 }}" +{{- else -}} subcategory: "" +{{- end }} description: |- +{{ if gt (len (split .Description " --- ")) 1 -}} +{{ index (split .Description " --- ") 1 | plainmarkdown | trimspace | prefixlines " " }} +{{- else -}} {{ .Description | plainmarkdown | trimspace | prefixlines " " }} +{{- end }} --- # {{.Name}} ({{.Type}}) +{{ if gt (len (split .Description " --- ")) 1 -}} +{{ index (split .Description " --- ") 1 | trimspace }} +{{ else }} {{ .Description | trimspace }} +{{- end }} ## Example Usage