From 36f905d1914717be48f157207db510382ac25476 Mon Sep 17 00:00:00 2001 From: hnrkndrssn Date: Thu, 8 Aug 2024 15:36:49 +1000 Subject: [PATCH] chore(docs): update runbook resource docs --- docs/resources/runbook.md | 10 +++++----- octopusdeploy_framework/schemas/runbook.go | 4 +--- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/resources/runbook.md b/docs/resources/runbook.md index b540fd6e7..09b12e7b3 100644 --- a/docs/resources/runbook.md +++ b/docs/resources/runbook.md @@ -22,16 +22,16 @@ This resource manages runbooks in Octopus Deploy. ### Optional -- `connectivity_policy` (Block List, Max: 1) (see [below for nested schema](#nestedblock--connectivity_policy)) +- `connectivity_policy` (Block List) (see [below for nested schema](#nestedblock--connectivity_policy)) - `default_guided_failure_mode` (String) Sets the runbook guided failure mode. - `description` (String) The description of this runbook. - `environment_scope` (String) Determines how the runbook is scoped to environments. - `environments` (List of String) When environment_scope is set to "Specified", this is the list of environments the runbook can be run against. -- `force_package_download` (Boolean) Whether to force packages to be re-downloaded or not +- `force_package_download` (Boolean) Whether to force packages to be re-downloaded or not. - `id` (String) The unique ID for this resource. -- `multi_tenancy_mode` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`. -- `retention_policy` (Block List, Max: 1) Sets the runbook retention policy (see [below for nested schema](#nestedblock--retention_policy)) -- `space_id` (String) The space ID associated with this resource. +- `multi_tenancy_mode` (String) The tenanted deployment mode of the runbook. Valid modes are `Untenanted`, `TenantedOrUntenanted`, `Tenanted` +- `retention_policy` (Block List) Sets the runbook retention policy. (see [below for nested schema](#nestedblock--retention_policy)) +- `space_id` (String) The space ID associated with this runbook. ### Read-Only diff --git a/octopusdeploy_framework/schemas/runbook.go b/octopusdeploy_framework/schemas/runbook.go index 0345ec75c..052ecda78 100644 --- a/octopusdeploy_framework/schemas/runbook.go +++ b/octopusdeploy_framework/schemas/runbook.go @@ -155,7 +155,6 @@ func GetRunbookResourceSchema() resourceSchema.Schema { RunbookSchemaAttributeNames.RunbookProcessID: resourceSchema.StringAttribute{ Description: "The runbook process ID.", Computed: true, - Optional: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.UseStateForUnknown(), }, @@ -163,7 +162,6 @@ func GetRunbookResourceSchema() resourceSchema.Schema { RunbookSchemaAttributeNames.PublishedRunbookSnapshotID: resourceSchema.StringAttribute{ Description: "The published snapshot ID.", Computed: true, - Optional: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.UseStateForUnknown(), }, @@ -192,7 +190,7 @@ func GetRunbookResourceSchema() resourceSchema.Schema { }, }, RunbookSchemaAttributeNames.Environments: resourceSchema.ListAttribute{ - Description: fmt.Sprintf("When %s is set to \"%s\", this is the list of environments the runbook can be run agains.", RunbookSchemaAttributeNames.EnvironmentScope, environmentScopeNames.Specified), + Description: fmt.Sprintf("When %s is set to \"%s\", this is the list of environments the runbook can be run against.", RunbookSchemaAttributeNames.EnvironmentScope, environmentScopeNames.Specified), Optional: true, Computed: true, ElementType: types.StringType,