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

feat: [CDS-71681]: Update the docs #600

Merged
merged 2 commits into from
Jun 29, 2023
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
4 changes: 4 additions & 0 deletions .changelog/600.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```release-note:enhancement
resource/harness_platform_template: Update the description for filter_visibility.
resource/harness_platform_template_filters: Update the description force_delete.
```
2 changes: 1 addition & 1 deletion docs/resources/platform_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,7 @@ template:

- `comments` (String) Specify comment with respect to changes.
- `description` (String, Deprecated) Description of the entity. Description field is deprecated
- `force_delete` (String) Enable this flag for force deletion of template
- `force_delete` (String) Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
- `git_details` (Block List, Max: 1) Contains parameters related to creating an Entity for Git Experience. (see [below for nested schema](#nestedblock--git_details))
- `is_stable` (Boolean) True if given version for template to be set as stable.
- `org_id` (String) Organization Identifier for the Entity
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/platform_template_filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ resource "harness_platform_template_filters" "test" {

### Optional

- `filter_visibility` (String) This indicates visibility of filters. By default, everyone can view this filter.
- `filter_visibility` (String) Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
- `org_id` (String) Organization Identifier for the Entity.
- `project_id` (String) Project Identifier for the Entity.

Expand Down
2 changes: 1 addition & 1 deletion internal/service/platform/template/resource_template.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ func ResourceTemplate() *schema.Resource {
},
},
"force_delete": {
Description: "Enable this flag for force deletion of template",
Description: "Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it",
Type: schema.TypeString,
Optional: true,
Computed: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func ResourceTemplateFilters() *schema.Resource {
},
},
"filter_visibility": {
Description: "This indicates visibility of filters. By default, everyone can view this filter.",
Description: "Only accept values \"EveryOne\" and \"OnlyCreator\". This indicates visibility of filters. By default, everyone can view this filter.",
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.StringInSlice([]string{"EveryOne", "OnlyCreator"}, false),
Expand Down