From c95ded1aec13591d303559436d2600456db016f6 Mon Sep 17 00:00:00 2001 From: wangzepeng666 <852420284@qq.com> Date: Thu, 28 Sep 2023 15:39:13 +0800 Subject: [PATCH] docs(smn/sms/swr): fix docs issues --- docs/data-sources/smn_topics.md | 9 +++++++-- docs/data-sources/sms_source_servers.md | 14 ++++++++------ docs/resources/smn_topic_v2.md | 7 +++++-- docs/resources/sms_task.md | 10 ++++++++-- docs/resources/swr_organization.md | 11 +++++++++-- docs/resources/swr_organization_users.md | 18 ++++++++++++++---- docs/resources/swr_repository.md | 10 +++++++++- docs/resources/swr_repository_sharing.md | 2 +- ...ta_source_flexibleengine_smn_topics_test.go | 5 +++-- .../resource_flexibleengine_smn_topic_test.go | 5 +++-- 10 files changed, 67 insertions(+), 24 deletions(-) diff --git a/docs/data-sources/smn_topics.md b/docs/data-sources/smn_topics.md index 9fe543597..9f4127ef5 100644 --- a/docs/data-sources/smn_topics.md +++ b/docs/data-sources/smn_topics.md @@ -29,14 +29,17 @@ The following arguments are supported: * `display_name` - (Optional, String) Specifies the topic display name. -## Attributes Reference +* `enterprise_project_id` - (Optional, String) Specifies the enterprise project id of the topic. + +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - The data source ID. -* `topics` - An array of SMN topics found. Structure is documented below. +* `topics` - An array of SMN topics found. The [topics](#smn_topics) object structure is documented below. + The `topics` block supports: * `name` - The name of the topic. @@ -47,6 +50,8 @@ The `topics` block supports: * `display_name` - The topic display name. +* `enterprise_project_id` - The enterprise project id of the topic. + * `push_policy` - Message pushing policy. + **0**: indicates that the message sending fails and the message is cached in the queue. + **1**: indicates that the failed message is discarded. diff --git a/docs/data-sources/sms_source_servers.md b/docs/data-sources/sms_source_servers.md index c6a38d970..35c541375 100644 --- a/docs/data-sources/sms_source_servers.md +++ b/docs/data-sources/sms_source_servers.md @@ -24,18 +24,19 @@ The following arguments are supported: * `name` - (Optional, String) Specifies the name of the source server. -* `status` - (Optional, String) Specifies the status of the source server. +* `state` - (Optional, String) Specifies the status of the source server. * `ip` - (Optional, String) Specifies the IP address of the source server. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - The data source ID. -* `servers` - An array of SMS source servers found. Structure is documented below. +* `servers` - An array of SMS source servers found. The [servers](#sms_servers) object structure is documented below. + The `servers` block supports: * `name` - The name of the source server. @@ -44,7 +45,7 @@ The `servers` block supports: * `ip` - The IP address of the source server. -* `status` - The status of the source server. +* `state` - The status of the source server. * `connected` - Whether the source server is properly connected to SMS. @@ -60,9 +61,10 @@ The `servers` block supports: * `memory` - The memory size in MB. -* `disks` - The disk information of the source server. Structure is documented below. +* `disks` - The disk information of the source server. The [disks](#sms_disks) object structure is documented below. -The `disks` blocks support: + +The `disks` block supports: * `name` - The disk name, for example, /dev/vda. diff --git a/docs/resources/smn_topic_v2.md b/docs/resources/smn_topic_v2.md index 618e42426..a02d96430 100644 --- a/docs/resources/smn_topic_v2.md +++ b/docs/resources/smn_topic_v2.md @@ -43,7 +43,7 @@ The following arguments are supported: Changing this parameter will create a new resource. * `display_name` - (Optional, String) Specifies the topic display name, which is presented as the name of the email - sender in an email message. The name can contains of 0 to 192 characters. + sender in an email message. The name can contain of 0 to 192 characters. * `users_publish_allowed` - (Optional, String) Specifies the users who can publish messages to this topic. The value can be **\*** which indicates all users or user account URNs separated by comma(,). The format of @@ -56,7 +56,10 @@ The following arguments are supported: * `introduction` - (Optional, String) Specifies the introduction of the topic, this will be contained in the subscription invitation. -## Attributes Reference +* `enterprise_project_id` - (Optional, String, ForceNew) Specifies the enterprise project id of the SMN Topic, Value 0 + indicates the default enterprise project. Changing this parameter will create a new resource. + +## Attribute Reference In addition to all arguments above, the following attributes are exported: diff --git a/docs/resources/sms_task.md b/docs/resources/sms_task.md index 7d9e208ed..3bee3d2c9 100644 --- a/docs/resources/sms_task.md +++ b/docs/resources/sms_task.md @@ -118,21 +118,27 @@ The `physical_volumes` block supports: * `uuid` - (Optional, String, ForceNew) Specifies the GUID of the volume. Changing this parameter will create a new resource. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - The resource ID in UUID format. + * `state` - The status of the migration task. + * `enterprise_project_id` - The enterprise project id of the target server. + * `target_server_name` - The name of the target server. + * `migrate_speed` - The migration rate, in MB/s. ## Timeouts This resource provides the following timeouts configuration options: -* `create` - Default is 5 minute. +* `create` - Default is 5 minutes. +* `update` - Default is 5 minutes. +* `delete` - Default is 5 minutes. ## Import diff --git a/docs/resources/swr_organization.md b/docs/resources/swr_organization.md index 9b291e70c..e3a0b6519 100644 --- a/docs/resources/swr_organization.md +++ b/docs/resources/swr_organization.md @@ -26,18 +26,25 @@ The following arguments are supported: * `name` - (Required, String, ForceNew) Specifies the name of the organization. The organization name must be globally unique. Changing this creates a new resource. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - ID of the organization. -* `creator` - The creator user name of the organization. +* `creator` - The creator username of the organization. * `permission` - The permission of the organization, the value can be Manage, Write, and Read. * `login_server` - The URL that can be used to log into the container registry. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 5 minutes. +* `delete` - Default is 5 minutes. + ## Import Organizations can be imported using the `name`, e.g. diff --git a/docs/resources/swr_organization_users.md b/docs/resources/swr_organization_users.md index 109cf3e97..23be15f9b 100644 --- a/docs/resources/swr_organization_users.md +++ b/docs/resources/swr_organization_users.md @@ -43,8 +43,9 @@ The following arguments are supported: Changing this creates a new resource. * `users` - (Required, List) Specifies the users to access to the organization (namespace). - Structure is documented below. + The [users](#swr_users) object structure is documented below. + The `users` block supports: * `permission` - (Required, String) Specifies the permission of the existing IAM user. @@ -54,16 +55,18 @@ The `users` block supports: * `user_name` - (Optional, String) Specifies the name of the existing IAM user. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - ID of the resource. The value is the name of the organization. -* `creator` - The creator user name of the organization. +* `creator` - The creator username of the organization. -* `self_permission` - The permission informations of current user. +* `self_permission` - The permission information of current user. The [self_permission](#swr_self_permission) object + structure is documented below. + The `self_permission` block supports: * `user_name` - The name of current user. @@ -72,6 +75,13 @@ The `self_permission` block supports: * `permission` - The permission of current user. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 5 minutes. +* `delete` - Default is 5 minutes. + ## Import Organization Permissions can be imported using the `id` (organization name), e.g. diff --git a/docs/resources/swr_repository.md b/docs/resources/swr_repository.md index eae6708b0..4daafc1b6 100644 --- a/docs/resources/swr_repository.md +++ b/docs/resources/swr_repository.md @@ -41,7 +41,7 @@ The following arguments are supported: * `category` - (Optional, String) Specifies the category of the repository. The value can be `app_server`, `linux`, `framework_app`, `database`, `lang`, `other`, `windows`, `arm`. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: @@ -57,6 +57,14 @@ In addition to all arguments above, the following attributes are exported: * `size` - Repository size. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 2 minutes. +* `update` - Default is 2 minutes. +* `delete` - Default is 2 minutes. + ## Import Repository can be imported using the organization name and repository name separated by a slash, e.g.: diff --git a/docs/resources/swr_repository_sharing.md b/docs/resources/swr_repository_sharing.md index fd585e681..fb8347c72 100644 --- a/docs/resources/swr_repository_sharing.md +++ b/docs/resources/swr_repository_sharing.md @@ -53,7 +53,7 @@ The following arguments are supported: * `description` - (Optional, String) Specifies the description of the repository sharing. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: diff --git a/flexibleengine/acceptance/data_source_flexibleengine_smn_topics_test.go b/flexibleengine/acceptance/data_source_flexibleengine_smn_topics_test.go index 77dbbc9ed..47e4209a1 100644 --- a/flexibleengine/acceptance/data_source_flexibleengine_smn_topics_test.go +++ b/flexibleengine/acceptance/data_source_flexibleengine_smn_topics_test.go @@ -35,8 +35,9 @@ func TestAccDataTopics_basic(t *testing.T) { func testAccDataTopicsConfig_basic(rName string) string { return fmt.Sprintf(` resource "flexibleengine_smn_topic_v2" "topic_1" { - name = "%[1]s" - display_name = "The display name of %[1]s" + name = "%[1]s" + display_name = "The display name of %[1]s" + enterprise_project_id = "0" } data "flexibleengine_smn_topics" "test" { diff --git a/flexibleengine/acceptance/resource_flexibleengine_smn_topic_test.go b/flexibleengine/acceptance/resource_flexibleengine_smn_topic_test.go index 448634b13..f4082b257 100644 --- a/flexibleengine/acceptance/resource_flexibleengine_smn_topic_test.go +++ b/flexibleengine/acceptance/resource_flexibleengine_smn_topic_test.go @@ -125,8 +125,9 @@ func TestAccSMNV2Topic_policies(t *testing.T) { func testAccSMNV2TopicConfig_basic(rName string) string { return fmt.Sprintf(` resource "flexibleengine_smn_topic_v2" "topic_1" { - name = "%s" - display_name = "The display name of %s" + name = "%s" + display_name = "The display name of %s" + enterprise_project_id = "0" } `, rName, rName) }