Skip to content

Commit

Permalink
(doc): Fixed several documentation formatting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
willguibr committed Apr 3, 2024
1 parent 592545e commit 82eff42
Show file tree
Hide file tree
Showing 118 changed files with 2,396 additions and 2,116 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ When executing the test, the following steps are taken for each `TestStep`:
responsible for configuring the resource under test, and any dependencies it
may have. For example, to test the `zpa_app_connector_group` resource, a valid configuration with the requisite fields is required. This results in configuration which looks like this:

```hcl
```terraform
resource "zpa_app_connector_group" "test" {
name = "testAcc_app_connector_group"
description = "testing"
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you are running into one of these scenarios, we recommend opening an issue in

<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->

```hcl
```terraform
# Copy-paste your Terraform configurations here - for large Terraform configs,
# please use a service like Dropbox and share a link to the ZIP file. For
# security, you can also encrypt the files using our GPG public key: https://keybase.io/hashicorp
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ labels: enhancement

<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->

```hcl
```terraform
# Copy-paste your Terraform configurations here - for large Terraform configs,
# please use a service like Dropbox and share a link to the ZIP file. For
# security, you can also encrypt the files using our GPG public key.
Expand Down
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Changelog

## 3.2.0 (March, 27 2024)
## 3.2.0 (April, 3 2024)

### Notes

- Release date: **(March, 27 2024)**
- Release date: **(April, 3 2024)**
- Supported Terraform version: **v1.x**

### NEW - RESOURCES, DATA SOURCES, PROPERTIES, ATTRIBUTES:
Expand Down Expand Up @@ -827,7 +827,7 @@ Fixed authentication issue when specifying zpa_cloud="PRODUCTION"
The Terraform Provider for Zscaler Private Access (ZPA) is now officially hosted under Zscaler's GitHub account and published in the Terraform Registry. For more details, visit the Zscaler Community Article [Here](https://community.zscaler.com/t/zpa-and-zia-terraform-providers-now-verified/16675)
Administrators who used previous versions of the provider, and followed instructions to install the binary as a custom provider, must update their provider block as such:

```hcl
```terraform
terraform {
required_providers {
zpa = {
Expand Down Expand Up @@ -861,7 +861,7 @@ provider "zpa" {}
The Terraform Provider for Zscaler Private Access (ZPA) is now officially hosted under Zscaler's GitHub account and published in the Terraform Registry. For more details, visit the Zscaler Community Article [Here](https://community.zscaler.com/t/zpa-and-zia-terraform-providers-now-verified/16675)
Administrators who used previous versions of the provider, and followed instructions to install the binary as a custom provider, must update their provider block as such:

```hcl
```terraform
terraform {
required_providers {
zpa = {
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Using Zscaler Private Access Provider (Terraform v0.13+)
For Terraform v0.13+, to use a locally built version of a provider you must add the following snippet to every module
that you want to use the provider in.
```hcl
```terraform
terraform {
required_providers {
zpa = {
Expand Down
16 changes: 11 additions & 5 deletions docs/data-sources/zpa_access_policy_client_types.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
page_title: "zpa_access_policy_client_types Data Source - terraform-provider-zpa"
subcategory: "Policy Set Controller"
layout: "zscaler"
page_title: "ZPA: access_policy_client_types"
description: |-
Official documentation https://help.zscaler.com/zpa
documentation https://help.zscaler.com/zpa/configuring-access-policies-using-api#getClientTypes
Get information about all client types for the specified customer.
---

# Data Source: zpa_access_policy_client_types
# zpa_access_policy_client_types (Data Source)

* [Official documentation](https://help.zscaler.com/zpa)
* [API documentation](https://help.zscaler.com/zpa/configuring-access-policies-using-api#getClientTypes)

Use the **zpa_access_policy_client_types** data source to get information about all client types for the specified customer in the Zscaler Private Access cloud. This data source can be optionally used when defining the following policy types:
- ``zpa_policy_access_rule``
Expand All @@ -23,12 +27,14 @@ The ``object_type`` attribute must be defined as "CLIENT_TYPE" in the policy ope

## Example Usage

```hcl
```terraform
data "zpa_access_policy_client_types" "this" {
}
```

## Argument Reference
## Schema

### Read-Only

The following values are returned:

Expand Down
11 changes: 6 additions & 5 deletions docs/data-sources/zpa_access_policy_platforms.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
page_title: "zpa_access_policy_platforms Data Source - terraform-provider-zpa"
subcategory: "Policy Set Controller"
layout: "zscaler"
page_title: "ZPA: access_policy_platforms"
description: |-
Get information about all platforms for the specified customer.
---

# Data Source: zpa_access_policy_platforms
# zpa_access_policy_platforms (Data Source)

Use the **zpa_access_policy_platforms** data source to get information about all platforms for the specified customer in the Zscaler Private Access cloud. This data source can be optionally used when defining the following policy types:
- ``zpa_policy_access_rule``
Expand All @@ -21,12 +20,14 @@ The ``object_type`` attribute must be defined as "PLATFORM" in the policy operan

## Example Usage

```hcl
```terraform
data "zpa_access_policy_platforms" "this" {
}
```

## Argument Reference
## Schema

### Read-Only

The following values are returned:

Expand Down
22 changes: 14 additions & 8 deletions docs/data-sources/zpa_app_connector_assistant_schedule.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
---
page_title: "zpa_app_connector_assistant_schedule Data Source - terraform-provider-zpa"
subcategory: "App Connector Controller"
layout: "zscaler"
page_title: "ZPA: app_connector_assistant_schedule"
description: |-
Official documentation https://help.zscaler.com/zpa/deleting-disconnected-app-connectors
documentation https://help.zscaler.com/zpa/configuring-auto-delete-disconnected-app-connectors-using-api
Get information about ZPA App Connector Assistant Schedule in Zscaler Private Access cloud.
---

# Data Source: app_connector_assistant_schedule
# zpa_app_connector_assistant_schedule (Data Source)

* [Official documentation](https://help.zscaler.com/zpa/deleting-disconnected-app-connectors)
* [API documentation](https://help.zscaler.com/zpa/configuring-auto-delete-disconnected-app-connectors-using-api)

Use the **zpa_app_connector_assistant_schedule** data source to get information about Auto Delete frequency of the App Connector for the specified customer in the Zscaler Private Access cloud.

~> **NOTE** - The `customer_id` attribute is optional and not required during the configuration.

## Example Usage

```hcl
```terraform
// Retrieve All Assistant Schedules
data "zpa_app_connector_assistant_schedule" "this" {}
Expand All @@ -29,14 +33,16 @@ data "zpa_app_connector_assistant_schedule" "this" {
}
```

## Argument Reference
## Schema

### Required

The following arguments are supported:

* `id` - (Required) The unique identifier for the App Connector auto deletion configuration for a customer. This field is only required for the PUT request to update the frequency of the App Connector Settings.
* `customer_id` - (Optional) The unique identifier of the ZPA tenant.
* `id` - (Number) The unique identifier for the App Connector auto deletion configuration for a customer. This field is only required for the PUT request to update the frequency of the App Connector Settings.
* `customer_id` - (Number) The unique identifier of the ZPA tenant.

## Attribute Reference
### Read-Only

In addition to all arguments above, the following attributes are exported:

Expand Down
102 changes: 55 additions & 47 deletions docs/data-sources/zpa_app_connector_controller.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,87 @@
---
page_title: "zpa_app_connector_controller Data Source - terraform-provider-zpa"
subcategory: "App Connector Controller"
layout: "zscaler"
page_title: "ZPA: app_connector_controller"
Official documentation https://help.zscaler.com/zpa/about-connectors
documentation https://help.zscaler.com/zpa/managing-app-connectors-using-api
description: |-
Get information about ZPA App Connector in Zscaler Private Access cloud.
---

# Data Source: app_connector_controller
# zpa_app_connector_controller (Data Source)

* [Official documentation](https://help.zscaler.com/zpa/about-connectors)
* [API documentation](https://help.zscaler.com/zpa/managing-app-connectors-using-api)

Use the **zpa_app_connector_controller** data source to get information about a app connector created in the Zscaler Private Access cloud. This data source can then be referenced in an App Connector Group.

## Example Usage

```hcl
```terraform
# ZPA App Connector Data Source
data "zpa_app_connector_controller" "example" {
name = "AWS-VPC100-App-Connector"
}
```

```hcl
```terraform
# ZPA App Connector Data Source
data "zpa_app_connector_controller" "example" {
id = "123456789"
}
```

## Argument Reference
## Schema

### Required

The following arguments are supported:
The following values are returned:

* `name` - (Required) Name of the App Connector Group.
* `id` - (Optional) Name of the App Connector Group.
- `name` - (String) Name of the App Connector Group.
- `id` - (String) Name of the App Connector Group.

## Attribute Reference
### Read-Only

In addition to all arguments above, the following attributes are exported:

The following values are ignored in PUT/POST calls. Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.

* `description` (Computed) - Description of the App Connector.
* `app_connector_group_name` (Computed) - Expected values: UNKNOWN/ZPN_STATUS_AUTHENTICATED(1)/ZPN_STATUS_DISCONNECTED
* `latitude` (Computed) - Latitude of the App Connector. Integer or decimal. With values in the range of `-90` to `90`
* `longitude` - (Computed) - Longitude of the App Connector. Integer or decimal. With values in the range of `-180` to `180`
* `enabled` - (Computed) - Whether this App Connector is enabled or not. Default value: `true`. Supported values: `true`, `false`
* `location` (Computed) - Location of the App Connector.
* `application_start_time` (Computed)
* `app_connector_group_id` (Computed)
* `control_channel_status` (Computed)
* `creation_time` (Computed)
* `modified_by` (Computed)
* `modified_time` (Computed)
* `ctrl_broker_name` (Computed)
* `current_version` (Computed)
* `expected_upgrade_time` (Computed)
* `expected_version` (Computed)
* `figerprint` (Computed)
* `ip_acl` (Computed)
* `issued_cert_id` (Computed)
* `last_broker_connect_time` (Computed)
* `last_broker_connect_time_duration` (Computed)
* `last_broker_disconnect_time` (Computed)
* `last_broker_disconnect_time_duration` (Computed)
* `last_upgrade_time` (Computed)
* `provisioning_key_id` (Computed)
* `provisioning_key_name` (Computed)
* `platform` (Computed)
* `previous_version` (Computed)
* `private_ip` (Computed)
* `public_ip` (Computed)
* `sarge_version` (Computed)
* `enrollment_cert` (Computed)
* `upgrade_attempt` (Computed)
* `upgrade_status` (Computed)
* `microtenant_id` (string) The ID of the microtenant the resource is to be associated with.
* `microtenant_name` (string) The name of the microtenant the resource is to be associated with.
- `description` (String) - Description of the App Connector.
- `app_connector_group_name` (String) - Expected values: `UNKNOWN/ZPN_STATUS_AUTHENTICATED(1)` or `ZPN_STATUS_DISCONNECTED`
- `latitude` (String) - Latitude of the App Connector. Integer or decimal. With values in the range of `-90` to `90`
- `longitude` - (String) - Longitude of the App Connector. Integer or decimal. With values in the range of `-180` to `180`
- `enabled` - (String) - Whether this App Connector is enabled or not. Default value: `true`. Supported values: `true`, `false`
- `location` (String) - Location of the App Connector.
- `application_start_time` (String) The start time of the App Connector.
- `app_connector_group_id` (String) The unique identifier of the App Connector Group.
- `control_channel_status` (String) The status of the control channel.
- `creation_time` (String) The time the App Connector is created.
- `modified_by` (String) The unique identifier of the tenant who modified the App Connector.
- `modified_time` (String) The time the App Connector is modified.
- `ctrl_broker_name` (String) The name of the Control Public Service Edge.
- `current_version` (String) The current version of the App Connector.
- `expected_upgrade_time` (String) The expected upgrade time for the App Connector.
- `expected_version` (String) The expected version of the App Connector.
- `figerprint` (String) The hardware fingerprint associated with the App Connector.
- `ip_acl` (String) The IP Access List (IP ACL) to allow App Connectors on a specific IP or subnet.
- `issued_cert_id` (String) The unique identifier of the issued certificate.
- `last_broker_connect_time` (String) The time the ZPA Public Service Edge last connected.
- `last_broker_connect_time_duration` (String) The duration of time when the ZPA Public Service Edge last connected.
- `last_broker_disconnect_time` (String) The time the ZPA Public Service Edge last disconnected.
- `last_broker_disconnect_time_duration` (String) The duration of time when the ZPA Public Service Edge last disconnected.
- `last_upgrade_time` (String) The time the App Connector last upgraded.
- `provisioning_key_id` (String) The unique identifier of the provisioning key.
- `provisioning_key_name` (String) The name of the provisioning key.
- `platform` (String) The host OS the App Connector is deployed on.
- `platform_detail` (String) The platform the App Connector is deployed on
- `previous_version` (String) The previous version of the App Connector.
- `private_ip` (String) The private IP of the App Connector.
- `public_ip` (String) The public IP of the App Connector.
- `runtime_os`(String) The run time OS on which the App Connector is running.
- `sarge_version` (String) The manager version of the App Connector.
- `enrollment_cert` (String) The enrollment certificate for the App Connector.
- `upgrade_attempt` (String) The number of attempts the App Connector takes to upgrade.
- `upgrade_status` (String) The status of the App Connector upgrade.
- `microtenant_id` (string) The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as `0` when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
- `microtenant_name` (string) The name of the microtenant the resource is to be associated with.

:warning: Notice that certificate and public_keys are omitted from the output.
~> :warning: Notice that certificate and public_keys are omitted from the output.
Loading

0 comments on commit 82eff42

Please sign in to comment.