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

docs: results of go generate ./... #338

Closed
wants to merge 1 commit into from
Closed
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
59 changes: 28 additions & 31 deletions docs/data-sources/directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
page_title: "btp_directory Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets the details about a directory.
Get the details about a directory.
Tip:
You must be assigned to the global account admin role, or the directory admin if the directory is configured to manage its authorizations.
Further documentation:
Expand All @@ -11,7 +11,7 @@ description: |-

# btp_directory (Data Source)

Gets the details about a directory.
Get the details about a directory.

__Tip:__
You must be assigned to the global account admin role, or the directory admin if the directory is configured to manage its authorizations.
Expand All @@ -36,37 +36,34 @@ data "btp_directory" "by_id" {

### Read-Only

- `created_by` (String) The details of the user that created the directory.
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `created_by` (String) Details of the user that created the directory.
- `created_date` (String) The date and time the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `description` (String) The description of the directory.
- `features` (Set of String) The features that are enabled for the directory. Possible values are:

| value | description |
| --- | --- |
| `DEFAULT` | All directories have the following basic feature enabled:<br> 1. Group and filter subaccounts for reports and filters <br> 2. Monitor usage and costs on a directory level (costs only available for contracts that use the consumption-based commercial model)<br> 3. Set custom properties and tags to the directory for identification and reporting purposes. |
| `ENTITLEMENTS` | Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory. |
| `AUTHORIZATIONS` | Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the `ENTITLEMENTS` feature. |
- `labels` (Map of Set of String) The set of words or phrases assigned to the directory.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `DEFAULT` All directories have the following basic feature enabled:
1. Group and filter subaccounts for reports and filters
2. Monitor usage and costs on a directory level (costs only available for contracts that use the consumption-based commercial model)
3. Set custom properties and tags to the directory for identification and reporting purposes.
- `ENTITLEMENTS` Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory.
- `AUTHORIZATIONS` Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the `ENTITLEMENTS` feature.
- `labels` (Map of Set of String) Set of words or phrases assigned to the directory.
- `last_modified` (String) The date and time the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `name` (String) The display name of the directory.
- `parent_id` (String) The ID of the directory's parent entity. Typically this is the global account.
- `state` (String) The current state of the directory. Possible values are:

| state | description |
| --- | --- |
| `OK` | The CRUD operation or series of operations completed successfully. |
| `STARTED` | CRUD operation on an entity has started. |
| `CANCELLED` | The operation or processing was canceled by the operator. |
| `PROCESSING` | A series of operations related to the entity is in progress. |
| `PROCESSING_FAILED` | The processing operations failed. |
| `CREATING` | Creating entity operation is in progress. |
| `CREATION_FAILED` | The creation operation failed, and the entity was not created or was created but cannot be used. |
| `UPDATING` | Updating entity operation is in progress. |
| `UPDATE_FAILED` | The update operation failed, and the entity was not updated. |
| `DELETING` | Deleting entity operation is in progress. |
| `DELETION_FAILED` | The delete operation failed, and the entity was not deleted. |
| `MOVING` | Moving entity operation is in progress. |
| `MOVE_FAILED` | Entity could not be moved to a different location. |
| `PENDING REVIEW` | The processing operation has been stopped for reviewing and can be restarted by the operator. |
| `MIGRATING` | Migrating entity from Neo to Cloud Foundry. |
- `subdomain` (String) This applies only to directories that have the user authorization management feature enabled. The subdomain is part of the path used to access the authorization tenant of the directory.
- `OK` The CRUD operation or series of operations completed successfully.
- `STARTED` CRUD operation on an entity has started.
- `CREATING` Creating entity operation is in progress.
- `UPDATING` Updating entity operation is in progress.
- `MOVING` Moving entity operation is in progress.
- `PROCESSING` A series of operations related to the entity is in progress.
- `DELETING` Deleting entity operation is in progress.
- `PENDING REVIEW` The processing operation has been stopped for reviewing and can be restarted by the operator.
- `CANCELLED` The operation or processing was canceled by the operator.
- `CREATION_FAILED` The creation operation failed, and the entity was not created or was created but cannot be used.
- `UPDATE_FAILED` The update operation failed, and the entity was not updated.
- `PROCESSING_FAILED` The processing operations failed.
- `DELETION_FAILED` The delete operation failed, and the entity was not deleted.
- `MOVE_FAILED` Entity could not be moved to a different location.
- `MIGRATING` Migrating entity from Neo to Cloud Foundry.
- `subdomain` (String) Applies only to directories that have the user authorization management feature enabled. The subdomain is part of the path used to access the authorization tenant of the directory.
24 changes: 9 additions & 15 deletions docs/data-sources/directory_entitlements.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,25 @@
page_title: "btp_directory_entitlements Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets all the entitlements and quota assignments for a directory.
To view all the resources that a directory and its subdirectories and subaccounts are entitled to use, the following condition must be met:
Get all the entitlements and quota assignments for a directory.
To view all the resources that a directory and its subdirectories and subaccounts are entitled to use:
* The directory must be a directory that is configured to manage its own entitlements.
* You must be assigned to either the global account admin or global account viewers role.
Tip:
You must be assigned to one of these roles: global account admin, global account viewer
---

# btp_directory_entitlements (Data Source)

Gets all the entitlements and quota assignments for a directory.
Get all the entitlements and quota assignments for a directory.

To view all the resources that a directory and its subdirectories and subaccounts are entitled to use, the following condition must be met:
To view all the resources that a directory and its subdirectories and subaccounts are entitled to use:
* The directory must be a directory that is configured to manage its own entitlements.
* You must be assigned to either the global account admin or global account viewers role.

__Tip:__
You must be assigned to one of these roles: global account admin, global account viewer

## Example Usage

```terraform
Expand All @@ -41,17 +46,6 @@ data "btp_directory_entitlements" "all" {

Read-Only:

- `category` (String) The current state of the entitlement. Possible values are:

| value | description |
| --- | --- |
| `PLATFORM` | A service required for using a specific platform; for example, Application Runtime is required for the Cloud Foundry platform. |
| `SERVICE` | A commercial or technical service. that has a numeric quota (amount) when entitled or assigned to a resource. When assigning entitlements of this type, use the 'amount' option. |
| `ELASTIC_SERVICE` | A commercial or technical service that has no numeric quota (amount) when entitled or assigned to a resource. Generally this type of service can be as many times as needed when enabled, but may in some cases be restricted by the service owner. |
| `ELASTIC_LIMITED` | An elastic service that can be enabled for only one subaccount per global account. |
| `APPLICATION` | A multitenant application to which consumers can subscribe. As opposed to applications defined as a 'QUOTA_BASED_APPLICATION', these applications do not have a numeric quota and are simply enabled or disabled as entitlements per subaccount. |
| `QUOTA_BASED_APPLICATION` | A multitenant application to which consumers can subscribe. As opposed to applications defined as 'APPLICATION', these applications have an numeric quota that limits consumer usage of the subscribed application per subaccount. |
| `ENVIRONMENT` | An environment service; for example, Cloud Foundry. |
- `plan_description` (String) The description of the entitled service plan.
- `plan_display_name` (String) The display name of the entitled service plan.
- `plan_name` (String) The name of the entitled service plan.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/directory_labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
page_title: "btp_directory_labels Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets all the user-defined labels that are currently assigned to a specific directory.
Get all the user-defined labels that are currently assigned to a specific directory.
Tip:
You must be assigned to the global account admin or viewer role. These roles assignments are not needed for directories of which you are the directory admin.
Further documentation:
Expand All @@ -11,7 +11,7 @@ description: |-

# btp_directory_labels (Data Source)

Gets all the user-defined labels that are currently assigned to a specific directory.
Get all the user-defined labels that are currently assigned to a specific directory.

__Tip:__
You must be assigned to the global account admin or viewer role. These roles assignments are not needed for directories of which you are the directory admin.
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/directory_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_directory_role Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets details about a specific directory role.
Get details about a specific directory role.
---

# btp_directory_role (Data Source)

Gets details about a specific directory role.
Get details about a specific directory role.

## Example Usage

Expand All @@ -34,8 +34,8 @@ data "btp_directory_role" "user_role_auditor" {

- `description` (String) The description of the role.
- `id` (String, Deprecated) The ID of the directory.
- `read_only` (Boolean) Shows whether the role can be modified or not.
- `scopes` (Attributes List) The scopes available with this role. (see [below for nested schema](#nestedatt--scopes))
- `read_only` (Boolean) Whether the role can be modified or not.
- `scopes` (Attributes List) Scopes available with this role. (see [below for nested schema](#nestedatt--scopes))

<a id="nestedatt--scopes"></a>
### Nested Schema for `scopes`
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/directory_role_collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_directory_role_collection Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets details about a specific directory role collection.
Get details about a specific directory role collection.
---

# btp_directory_role_collection (Data Source)

Gets details about a specific directory role collection.
Get details about a specific directory role collection.

## Example Usage

Expand All @@ -30,7 +30,7 @@ data "btp_directory_role_collection" "directory_admin" {

- `description` (String) The description of the role collection.
- `id` (String, Deprecated) The ID of the directory.
- `read_only` (Boolean) Shows whether the role collection is read-only.
- `read_only` (Boolean) Whether the role collection is read-only.
- `roles` (Attributes Set) (see [below for nested schema](#nestedatt--roles))

<a id="nestedatt--roles"></a>
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/directory_role_collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_directory_role_collections Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets all role collections.
List all role collections.
---

# btp_directory_role_collections (Data Source)

Gets all role collections.
List all role collections.

## Example Usage

Expand Down Expand Up @@ -36,7 +36,7 @@ Read-Only:

- `description` (String) The description of the role collection.
- `name` (String) The name of the role collection.
- `read_only` (Boolean) Shows whether the role collection is read-only.
- `read_only` (Boolean) Whether the role collection is read-only.
- `roles` (Attributes Set) (see [below for nested schema](#nestedatt--values--roles))

<a id="nestedatt--values--roles"></a>
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/directory_roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "btp_directory_roles Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets all roles.
List all roles.
Further documentation:
https://help.sap.com/docs/btp/sap-business-technology-platform/role-collections-and-roles-in-global-accounts-directories-and-subaccounts
---

# btp_directory_roles (Data Source)

Gets all roles.
List all roles.

__Further documentation:__
<https://help.sap.com/docs/btp/sap-business-technology-platform/role-collections-and-roles-in-global-accounts-directories-and-subaccounts>
Expand Down Expand Up @@ -42,9 +42,9 @@ Read-Only:
- `app_id` (String) The ID of the xsuaa application.
- `description` (String) The description of the role.
- `name` (String) The name of the role.
- `read_only` (Boolean) Shows whether the role can be modified or not.
- `read_only` (Boolean) Whether the role can be modified or not.
- `role_template_name` (String) The name of the role template.
- `scopes` (Attributes List) The scopes available with this role. (see [below for nested schema](#nestedatt--values--scopes))
- `scopes` (Attributes List) Scopes available with this role. (see [below for nested schema](#nestedatt--values--scopes))

<a id="nestedatt--values--scopes"></a>
### Nested Schema for `values.scopes`
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/directory_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ data "btp_directory_user" "someone_else" {
- `family_name` (String) The last name of the user.
- `given_name` (String) The given name of the user.
- `id` (String) The ID of the user.
- `role_collections` (Set of String) The set of role collections, which are assigned to the user.
- `role_collections` (Set of String) Set of role collections, which are assigned to the user.
- `verified` (Boolean) The verification status of the user.
4 changes: 2 additions & 2 deletions docs/data-sources/directory_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "btp_directory_users Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets all users.
List all users.
Further documentation:
https://help.sap.com/docs/btp/sap-business-technology-platform/user-and-member-management
---

# btp_directory_users (Data Source)

Gets all users.
List all users.

__Further documentation:__
<https://help.sap.com/docs/btp/sap-business-technology-platform/user-and-member-management>
Expand Down
Loading
Loading