fix: changed markdown description

Signed-off-by: Matthias Theuermann <[email protected]>
infralovers · Jun 20, 2024 · 62ebda0 · 62ebda0
1 parent 7bd8f2f
commit 62ebda0
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 28 deletions.
diff --git a/docs/data-sources/active_policy.md b/docs/data-sources/active_policy.md
@@ -39,11 +39,11 @@ output "policies_mrn" {
 
 Read-Only:
 
-- `action` (String) Action
-- `assigned` (Boolean) Assigned to
-- `created_at` (String) Created at
-- `is_public` (Boolean) Is public
-- `policy_mrn` (String) Policy MRN
+- `action` (String) Policies can be set to `Null`, `IGNORE` or `ACTIVE`
+- `assigned` (Boolean) Determines if a policy is enabled or disabled
+- `created_at` (String) Timestamp of policy creation
+- `is_public` (Boolean) Determines if a policy is public or private
+- `policy_mrn` (String) Unique policy Mondoo Resource Name
 - `policy_name` (String) Policy name
-- `updated_at` (String) Updated at
-- `version` (String) Version
+- `updated_at` (String) Timestamp of policy update
+- `version` (String) Version of the policy
diff --git a/docs/data-sources/policy.md b/docs/data-sources/policy.md
@@ -29,7 +29,7 @@ output "policies" {
 
 ### Optional
 
-- `assigned_only` (Boolean) Assigned only
+- `assigned_only` (Boolean) Only return enabled policies if set to `true`
 - `catalog_type` (String) Catalog type of either `ALL`, `POLICY` or `QUERYPACK`. Defaults to `ALL`
 - `space_id` (String) Space ID
 - `space_mrn` (String) Space MRN
@@ -43,11 +43,11 @@ output "policies" {
 
 Read-Only:
 
-- `action` (String) Action
-- `assigned` (Boolean) Assigned to
-- `created_at` (String) Created at
-- `is_public` (Boolean) Is public
-- `policy_mrn` (String) Policy MRN
+- `action` (String) Policies can be set to `Null`, `IGNORE` or `ACTIVE`
+- `assigned` (Boolean) Determines if a policy is enabled or disabled
+- `created_at` (String) Timestamp of policy creation
+- `is_public` (Boolean) Determines if a policy is public or private
+- `policy_mrn` (String) Unique policy Mondoo Resource Name
 - `policy_name` (String) Policy name
-- `updated_at` (String) Updated at
+- `updated_at` (String) Timestamp of policy update
 - `version` (String) Version
diff --git a/internal/provider/active_policy_data_source.go b/internal/provider/active_policy_data_source.go
@@ -62,35 +62,35 @@ func (d *activePolicyDataSource) Schema(ctx context.Context, req datasource.Sche
 					Attributes: map[string]schema.Attribute{
 						"policy_mrn": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Policy MRN",
+							MarkdownDescription: "Unique policy Mondoo Resource Name",
 						},
 						"policy_name": schema.StringAttribute{
 							Computed:            true,
 							MarkdownDescription: "Policy name",
 						},
 						"assigned": schema.BoolAttribute{
 							Computed:            true,
-							MarkdownDescription: "Assigned to",
+							MarkdownDescription: "Determines if a policy is enabled or disabled",
 						},
 						"action": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Action",
+							MarkdownDescription: "Policies can be set to `Null`, `IGNORE` or `ACTIVE`",
 						},
 						"version": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Version",
+							MarkdownDescription: "Version of the policy",
 						},
 						"is_public": schema.BoolAttribute{
 							Computed:            true,
-							MarkdownDescription: "Is public",
+							MarkdownDescription: "Determines if a policy is public or private",
 						},
 						"created_at": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Created at",
+							MarkdownDescription: "Timestamp of policy creation",
 						},
 						"updated_at": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Updated at",
+							MarkdownDescription: "Timestamp of policy update",
 						},
 					},
 				},

diff --git a/internal/provider/policy_data_source.go b/internal/provider/policy_data_source.go
@@ -54,7 +54,7 @@ func (d *policyDataSource) Schema(ctx context.Context, req datasource.SchemaRequ
 			"assigned_only": schema.BoolAttribute{
 				Computed:            true,
 				Optional:            true,
-				MarkdownDescription: "Assigned only",
+				MarkdownDescription: "Only return enabled policies if set to `true`",
 			},
 			"policies": schema.ListNestedAttribute{
 				Computed:            true,
@@ -63,35 +63,35 @@ func (d *policyDataSource) Schema(ctx context.Context, req datasource.SchemaRequ
 					Attributes: map[string]schema.Attribute{
 						"policy_mrn": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Policy MRN",
+							MarkdownDescription: "Unique policy Mondoo Resource Name",
 						},
 						"policy_name": schema.StringAttribute{
 							Computed:            true,
 							MarkdownDescription: "Policy name",
 						},
 						"assigned": schema.BoolAttribute{
 							Computed:            true,
-							MarkdownDescription: "Assigned to",
+							MarkdownDescription: "Determines if a policy is enabled or disabled",
 						},
 						"action": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Action",
+							MarkdownDescription: "Policies can be set to `Null`, `IGNORE` or `ACTIVE`",
 						},
 						"version": schema.StringAttribute{
 							Computed:            true,
 							MarkdownDescription: "Version",
 						},
 						"is_public": schema.BoolAttribute{
 							Computed:            true,
-							MarkdownDescription: "Is public",
+							MarkdownDescription: "Determines if a policy is public or private",
 						},
 						"created_at": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Created at",
+							MarkdownDescription: "Timestamp of policy creation",
 						},
 						"updated_at": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "Updated at",
+							MarkdownDescription: "Timestamp of policy update",
 						},
 					},
 				},