Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hnrkndrssn committed Aug 9, 2024
1 parent 528705e commit 5486101
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
17 changes: 10 additions & 7 deletions docs/resources/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "octopusdeploy_environment Resource - terraform-provider-octopusdeploy"
subcategory: ""
description: |-
This resource manages environments in Octopus Deploy.
---

# octopusdeploy_environment (Resource)


This resource manages environments in Octopus Deploy.

## Example Usage

Expand Down Expand Up @@ -48,33 +48,36 @@ resource "octopusdeploy_environment" "example" {
- `jira_extension_settings` (Block List) Provides extension settings for the Jira integration for this environment. (see [below for nested schema](#nestedblock--jira_extension_settings))
- `jira_service_management_extension_settings` (Block List) Provides extension settings for the Jira Service Management (JSM) integration for this environment. (see [below for nested schema](#nestedblock--jira_service_management_extension_settings))
- `servicenow_extension_settings` (Block List) Provides extension settings for the ServiceNow integration for this environment. (see [below for nested schema](#nestedblock--servicenow_extension_settings))
- `slug` (String) The unique slug of this environment
- `sort_order` (Number) The order number to sort an environment
- `sort_order` (Number) The order number to sort an environment.
- `space_id` (String) The space ID associated with this environment.
- `use_guided_failure` (Boolean)

### Read-Only

- `slug` (String) The unique slug of this environment

<a id="nestedblock--jira_extension_settings"></a>
### Nested Schema for `jira_extension_settings`

Optional:

- `environment_type` (String)
- `environment_type` (String) The Jira environment type of this Octopus deployment environment. Valid values are `"development"`, `"production"`, `"staging"`, `"testing"`, `"unmapped"`.


<a id="nestedblock--jira_service_management_extension_settings"></a>
### Nested Schema for `jira_service_management_extension_settings`

Optional:

- `is_enabled` (Boolean)
- `is_enabled` (Boolean) Specifies whether or not this extension is enabled for this project.


<a id="nestedblock--servicenow_extension_settings"></a>
### Nested Schema for `servicenow_extension_settings`

Optional:

- `is_enabled` (Boolean)
- `is_enabled` (Boolean) Specifies whether or not this extension is enabled for this project.

## Import

Expand Down
6 changes: 3 additions & 3 deletions octopusdeploy_framework/schemas/environment.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ func GetEnvironmentResourceSchema() resourceSchema.Schema {
Attributes: map[string]resourceSchema.Attribute{
"environment_type": resourceSchema.StringAttribute{
Description: fmt.Sprintf("The Jira environment type of this Octopus deployment environment. Valid values are %s.", strings.Join(util.Map(jiraEnvironmentTypes, func(item string) string { return fmt.Sprintf("`\"%s\"`", item) }), ", ")),
Required: true,
Optional: true,
Validators: []validator.String{
stringvalidator.OneOfCaseInsensitive(
jiraEnvironmentTypes...,
Expand All @@ -145,7 +145,7 @@ func GetEnvironmentResourceSchema() resourceSchema.Schema {
Attributes: map[string]resourceSchema.Attribute{
"is_enabled": resourceSchema.BoolAttribute{
Description: "Specifies whether or not this extension is enabled for this project.",
Required: true,
Optional: true,
},
},
},
Expand All @@ -156,7 +156,7 @@ func GetEnvironmentResourceSchema() resourceSchema.Schema {
Attributes: map[string]resourceSchema.Attribute{
"is_enabled": resourceSchema.BoolAttribute{
Description: "Specifies whether or not this extension is enabled for this project.",
Required: true,
Optional: true,
},
},
},
Expand Down

0 comments on commit 5486101

Please sign in to comment.