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: rewrite descriptions for groups resources #1527

Merged
merged 1 commit into from
Jan 12, 2024
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
16 changes: 8 additions & 8 deletions docs/data-sources/organization_user_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_user_group Data Source - terraform-provider-aiven"
subcategory: ""
description: |-
The Organization User Groupe data source provides information about the existing Aiven Organization User Group.
Provides information about an existing user group in an organization.
---

# aiven_organization_user_group (Data Source)

The Organization User Groupe data source provides information about the existing Aiven Organization User Group.
Provides information about an existing user group in an organization.



Expand All @@ -17,13 +17,13 @@ The Organization User Groupe data source provides information about the existing

### Required

- `name` (String) The organization user group name. This property cannot be changed, doing so forces recreation of the resource.
- `organization_id` (String) The unique organization ID. This property cannot be changed, doing so forces recreation of the resource.
- `name` (String) The name of the user group. This property cannot be changed, doing so forces recreation of the resource.
- `organization_id` (String) The ID of the organization. This property cannot be changed, doing so forces recreation of the resource.

### Read-Only

- `create_time` (String) Time of creation
- `description` (String) The organization user group description. This property cannot be changed, doing so forces recreation of the resource.
- `group_id` (String) The unique organization user group ID
- `create_time` (String) Time of creation.
- `description` (String) The description of the user group. This property cannot be changed, doing so forces recreation of the resource.
- `group_id` (String) The ID of the user group.
- `id` (String) The ID of this resource.
- `update_time` (String) Time of last update
- `update_time` (String) Time of last update.
10 changes: 5 additions & 5 deletions docs/resources/organization_group_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_group_project Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Creates and manages an organization group project relations in Aiven. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable.
Adds and manages a group of users as members of a project. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable.
---

# aiven_organization_group_project (Resource)

Creates and manages an organization group project relations in Aiven. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable.
Adds and manages a group of users as members of a project. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable.



Expand All @@ -17,9 +17,9 @@ Creates and manages an organization group project relations in Aiven. Please not

### Required

- `group_id` (String) Organization group identifier of the organization group project relation.
- `project` (String) Tenant identifier of the organization.
- `role` (String) Role of the organization group project relation.
- `group_id` (String) The ID of the user group.
- `project` (String) The project that the users in the group are members of.
- `role` (String) Role assigned to the users in the group for the project.

### Optional

Expand Down
16 changes: 8 additions & 8 deletions docs/resources/organization_user_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_user_group Resource - terraform-provider-aiven"
subcategory: ""
description: |-
The Organization User Group resource allows the creation and management of an Aiven Organization Groups.
Creates and manages a user group in an organization.
---

# aiven_organization_user_group (Resource)

The Organization User Group resource allows the creation and management of an Aiven Organization Groups.
Creates and manages a user group in an organization.



Expand All @@ -17,20 +17,20 @@ The Organization User Group resource allows the creation and management of an Ai

### Required

- `organization_id` (String) The unique organization ID. This property cannot be changed, doing so forces recreation of the resource.
- `organization_id` (String) The ID of the organization. This property cannot be changed, doing so forces recreation of the resource.

### Optional

- `description` (String) The organization user group description. This property cannot be changed, doing so forces recreation of the resource.
- `name` (String) The organization user group name. This property cannot be changed, doing so forces recreation of the resource.
- `description` (String) The description of the user group. This property cannot be changed, doing so forces recreation of the resource.
- `name` (String) The name of the user group. This property cannot be changed, doing so forces recreation of the resource.
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `create_time` (String) Time of creation
- `group_id` (String) The unique organization user group ID
- `create_time` (String) Time of creation.
- `group_id` (String) The ID of the user group.
- `id` (String) The ID of this resource.
- `update_time` (String) Time of last update
- `update_time` (String) Time of last update.

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/organization_user_group_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_user_group_member Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Creates and manages an organization user group members in Aiven. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable.
Adds and manages users in a user group. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable.
---

# aiven_organization_user_group_member (Resource)

Creates and manages an organization user group members in Aiven. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable.
Adds and manages users in a user group. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func (r *organizationGroupProjectResource) Schema(
resp *resource.SchemaResponse) {
resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{
Description: util.BetaDescription(
"Creates and manages an organization group project relations in Aiven.",
"Adds and manages a group of users as members of a project.",
),
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Expand All @@ -89,21 +89,21 @@ func (r *organizationGroupProjectResource) Schema(
},
},
"project": schema.StringAttribute{
Description: "Tenant identifier of the organization.",
Description: "The project that the users in the group are members of.",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"group_id": schema.StringAttribute{
Description: "Organization group identifier of the organization group project relation.",
Description: "The ID of the user group.",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"role": schema.StringAttribute{
Description: "Role of the organization group project relation.",
Description: "Role assigned to the users in the group for the project.",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func (r *organizationUserGroupMembersResource) Schema(
resp *resource.SchemaResponse,
) {
resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{
Description: util.BetaDescription("Creates and manages an organization user group members in Aiven."),
Description: util.BetaDescription("Adds and manages users in a user group."),
Attributes: map[string]schema.Attribute{
"organization_id": schema.StringAttribute{
Description: "Identifier of the organization.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,39 @@ var aivenOrganizationUserGroupSchema = map[string]*schema.Schema{
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: userconfig.Desc("The unique organization ID").ForceNew().Build(),
Description: userconfig.Desc("The ID of the organization.").ForceNew().Build(),
},
"name": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: userconfig.Desc("The organization user group name").ForceNew().Build(),
Description: userconfig.Desc("The name of the user group.").ForceNew().Build(),
},
"description": {
Type: schema.TypeString,
Optional: true,
Description: userconfig.Desc("The organization user group description").ForceNew().Build(),
Description: userconfig.Desc("The description of the user group.").ForceNew().Build(),
},
"create_time": {
Type: schema.TypeString,
Computed: true,
Description: "Time of creation",
Description: "Time of creation.",
},
"update_time": {
Type: schema.TypeString,
Computed: true,
Description: "Time of last update",
Description: "Time of last update.",
},
"group_id": {
Type: schema.TypeString,
Computed: true,
Description: "The unique organization user group ID",
Description: "The ID of the user group.",
},
}

func ResourceOrganizationUserGroup() *schema.Resource {
return &schema.Resource{
Description: "The Organization User Group resource allows the creation and management of an Aiven Organization Groups.",
Description: "Creates and manages a user group in an organization.",
CreateContext: resourceOrganizationUserGroupCreate,
ReadContext: resourceOrganizationUserGroupRead,
UpdateContext: resourceOrganizationUserGroupUpdate,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ import (
func DatasourceOrganizationUserGroup() *schema.Resource {
return &schema.Resource{
ReadContext: datasourceOrganizationUserGroupRead,
Description: "The Organization User Groupe data source provides information about the existing Aiven" +
" Organization User Group.",
Description: "Provides information about an existing user group in an organization.",
Schema: schemautil.ResourceSchemaAsDatasourceSchema(
aivenOrganizationUserGroupSchema, "organization_id", "name",
),
Expand Down
Loading