Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/v1.2.0 beta doc review yst #229

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions website/docs/d/access_control_policies.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,23 @@ Describes a list of access control policies.
## Example Usage

``` hcl
data "nutanix_access_control_policies" "test" {}}
data "nutanix_access_control_policies" "test" {}
```

## Attribute Reference

The following attributes are exported:

* `api_version`: version of the API
* `entities`: List of Projects
* `entities`: List of Access Control Policies

# Entities

The entities attribute element contains the followings attributes:

* `name`: - Name of the Access Control Policy.
* `description`: - The description of the association of a role to a user in a given context.
* `description`: - The description of the Access Control Policy.
* `categories`: - Categories for the Access Control Policy.
* `project_reference`: - The reference to a project.
* `owner_reference`: - The reference to a user.
* `project_reference`: - The reference to a project.
* `role_reference`: - The reference to a role.
Expand Down Expand Up @@ -80,20 +79,20 @@ The right_hand_side attribute supports the following.

The following attributes are exported:

* `metadata`: - The vm kind metadata.
* `metadata`: - The Access Control Policy kind metadata.
* `api_version` - The version of the API.
* `state`: - The state of the vm.
* `state`: - The state of the Access Control Policy.

### Metadata

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when Access Control Policy was last updated.
* `uuid`: - Access Control Policy UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when Access Control Policy was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - Access Control Policy name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
23 changes: 11 additions & 12 deletions website/docs/d/access_control_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ resource "nutanix_access_control_policy" "test" {
kind = "role"
uuid = "UUID of role"
}

data "nutanix_access_control_policy" "test" {
access_control_policy_id = nutanix_access_control_policy.test.id
}
}
data "nutanix_access_control_policy" "test" {
access_control_policy_id = nutanix_access_control_policy.test.id
}

```

## Argument Reference
Expand All @@ -38,11 +38,10 @@ The following arguments are supported:
The following attributes are exported:

* `name`: - Name of the Access Control Policy.
* `description`: - The description of the association of a role to a user in a given context.
* `description`: - The description of the Access Control Policy.
* `categories`: - Categories for the Access Control Policy.
* `project_reference`: - The reference to a project.
* `owner_reference`: - The reference to a user.
* `project_reference`: - The reference to a project.
* `role_reference`: - The reference to a role.
* `user_reference_list`: - The User(s) being assigned a given role.
* `user_group_reference_list`: - The User group(s) being assigned a given role.
Expand Down Expand Up @@ -90,20 +89,20 @@ The right_hand_side attribute supports the following.

The following attributes are exported:

* `metadata`: - The vm kind metadata.
* `metadata`: - The Access Control Policy kind metadata.
* `api_version` - The version of the API.
* `state`: - The state of the vm.
* `state`: - The state of the Access Control Policy.

### Metadata

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when Access Control Policy was last updated.
* `uuid`: - Access Control Policy UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when Access Control Policy was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - Access Control Policy name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
8 changes: 4 additions & 4 deletions website/docs/d/project.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,12 @@ The following attributes are exported:
### Metadata
The metadata attribute exports the following:

* `last_update_time` - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid` - vm UUID.
* `creation_time` - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time` - UTC date and time in RFC-3339 format when the project was last updated.
* `uuid` - Project UUID.
* `creation_time` - UTC date and time in RFC-3339 format when the project was created.
* `spec_version` - Version number of the latest spec.
* `spec_hash` - Hash of the spec. This will be returned from server.
* `name` - vm name.
* `name` - Project name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
8 changes: 4 additions & 4 deletions website/docs/d/projects.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,12 @@ The entities attribute element contains the followings attributes:
### Metadata
The metadata attribute exports the following:

* `last_update_time` - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid` - vm UUID.
* `creation_time` - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time` - UTC date and time in RFC-3339 format when the project was last updated.
* `uuid` - Project UUID.
* `creation_time` - UTC date and time in RFC-3339 format when the project was created.
* `spec_version` - Version number of the latest spec.
* `spec_hash` - Hash of the spec. This will be returned from server.
* `name` - vm name.
* `name` - Project name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
24 changes: 12 additions & 12 deletions website/docs/d/role.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ resource "nutanix_role" "test" {
kind = "permission"
uuid = "ID OF PERMISSION"
}

data "nutanix_role" "test" {
role_id = nutanix_role.test.id
}
}
data "nutanix_role" "test" {
role_id = nutanix_role.test.id
}
```

## Argument Reference

The following arguments are supported:

* `role_id`: - (Required) The UUID of a Role.
* `role_id`: - (Optional) The UUID of a Role.
* `role_name`: - (Optional) The name of a Role.

## Attribute Reference

The following attributes are exported:

* `name`: - Name of the Role.
* `description`: - The description of the association of a role to a user in a given context.
* `description`: - The description of the Role.
* `categories`: - Categories for the Role.
* `project_reference`: - The reference to a project.
* `owner_reference`: - The reference to a user.
Expand All @@ -49,20 +49,20 @@ The following attributes are exported:

The following attributes are exported:

* `metadata`: - The vm kind metadata.
* `metadata`: - The role kind metadata.
* `api_version` - The version of the API.
* `state`: - The state of the vm.
* `state`: - The state of the role.

### Metadata

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when role was last updated.
* `uuid`: - Role UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when role was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - Role name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
22 changes: 11 additions & 11 deletions website/docs/d/roles.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@ Describes a list of roles.
## Example Usage

``` hcl
data "nutanix_roles" "test" {}}
data "nutanix_roles" "test" {}
```

## Attribute Reference

The following attributes are exported:

* `api_version`: version of the API
* `entities`: List of Projects
* `entities`: List of Roles

# Entities

The entities attribute element contains the followings attributes:

* `name`: - Name of the Access Control Policy.
* `description`: - The description of the association of a role to a user in a given context.
* `categories`: - Categories for the Access Control Policy.
* `name`: - Name of the role.
* `description`: - The description of the role.
* `categories`: - Categories for the role.
* `project_reference`: - The reference to a project.
* `owner_reference`: - The reference to a user.
* `project_reference`: - The reference to a project.
Expand All @@ -39,20 +39,20 @@ The entities attribute element contains the followings attributes:

The following attributes are exported:

* `metadata`: - The vm kind metadata.
* `metadata`: - The role kind metadata.
* `api_version` - The version of the API.
* `state`: - The state of the vm.
* `state`: - The state of the role.

### Metadata

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when role was last updated.
* `uuid`: - Role UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when role was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - Role name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
10 changes: 5 additions & 5 deletions website/docs/d/user.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The following arguments are supported:

The following attributes are exported:

* `metadata`: - The vm kind metadata.
* `metadata`: - The user kind metadata.
* `api_version` - The version of the API.
* `state`: - The state of the entity.
* `name`: - The name of the user.
Expand All @@ -66,12 +66,12 @@ The following attributes are exported:

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when user was last updated.
* `uuid`: - User UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when user was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - User name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
14 changes: 7 additions & 7 deletions website/docs/d/user_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ The following arguments are supported:
The following attributes are exported:

* `api_version` - The version of the API.
* `metadata`: - The vm kind metadata.
* `categories`: - The Distinguished Categories for the Access Control Policy.
* `owner_reference`: - The Distinguished The reference to a user.
* `metadata`: - The user group kind metadata.
* `categories`: - The Distinguished Categories for the user group.
* `owner_reference`: - The reference to a user.
* `project_reference`: - The Distinguished The reference to a project.
* `user_group_type`: - The type of the user group.
* `display_name`: - The display name of the user group.
Expand All @@ -61,12 +61,12 @@ The following attributes are exported:

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when the user group was last updated.
* `uuid`: - User group UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when the user group was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - User group name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
16 changes: 8 additions & 8 deletions website/docs/d/user_groups.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ The entities attribute element contains the following attributes:
The following attributes are exported:

* `api_version` - The version of the API.
* `metadata`: - The vm kind metadata.
* `categories`: - The Distinguished Categories for the Access Control Policy.
* `owner_reference`: - The Distinguished The reference to a user.
* `project_reference`: - The Distinguished The reference to a project.
* `metadata`: - The user group kind metadata.
* `categories`: - The Categories for the user group.
* `owner_reference`: - The reference to a user.
* `project_reference`: - The reference to a project.
* `user_group_type`: - The type of the user group.
* `display_name`: - The display name of the user group.
* `directory_service_user_group`: - A Directory Service User Group.
Expand All @@ -45,12 +45,12 @@ The following attributes are exported:

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when user group was last updated.
* `uuid`: - User group UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when user group was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - User group name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
12 changes: 6 additions & 6 deletions website/docs/d/users.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following attributes are exported:

The entities attribute element contains the following attributes:

* `metadata`: - The vm kind metadata.
* `metadata`: - The user kind metadata.
* `api_version` - The version of the API.
* `state`: - The state of the entity.
* `name`: - The name of the user.
Expand All @@ -44,20 +44,20 @@ The entities attribute element contains the following attributes:
* `access_control_policy_reference_list`: - List of ACP references. See #reference for more details.
* `directory_service_user`: - (Optional) The directory service user configuration. See below for more information.
* `identity_provider_user`: - (Optional) (Optional) The identity provider user configuration. See below for more information.
* `categories`: - (Optional) Categories for the Access Control Policy.
* `categories`: - (Optional) Categories for the user.
* `project_reference`: - (Optional) The reference to a project.
* `owner_reference`: - (Optional) The reference to a user.

### Metadata

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when vm was last updated.
* `uuid`: - vm UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when vm was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when user was last updated.
* `uuid`: - User UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when user was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - vm name.
* `name`: - User name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
Loading