Skip to content

Commit

Permalink
fix: added documentation and fixed formatting
Browse files Browse the repository at this point in the history
Signed-off-by: Matthias Theuermann <[email protected]>
  • Loading branch information
mati007thm committed Dec 3, 2024
1 parent f9bc532 commit b130223
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 5 deletions.
58 changes: 58 additions & 0 deletions docs/resources/integration_jira.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mondoo_integration_jira Resource - terraform-provider-mondoo"

Check warning on line 3 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`jira` is not a recognized word. (unrecognized-spelling)
subcategory: ""
description: |-
Integrate the Ticketing System Jira with Mondoo to automatically create and close issues based on Mondoo findings.
---

# mondoo_integration_jira (Resource)

Check warning on line 9 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`jira` is not a recognized word. (unrecognized-spelling)

Integrate the Ticketing System Jira with Mondoo to automatically create and close issues based on Mondoo findings.

## Example Usage

```terraform
variable "jira_token" {

Check warning on line 16 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`jira` is not a recognized word. (unrecognized-spelling)
description = "The Jira API Token"
type = string
sensitive = true
}
provider "mondoo" {
space = "hungry-poet-123456"
}
# Setup the jira integration

Check warning on line 26 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`jira` is not a recognized word. (unrecognized-spelling)
resource "mondoo_integration_jira" "jira_integration" {

Check warning on line 27 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`jira` is not a recognized word. (unrecognized-spelling)
name = "My Jira Integration"
host = "https://your-instance.atlassian.net"
email = "[email protected]"

Check warning on line 30 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`jiraowner` is not a recognized word. (unrecognized-spelling)
# default_project = "GTMS"

Check warning on line 31 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`GTMS` is not a recognized word. (unrecognized-spelling)
api_token = var.jira_token
auto_create = true
auto_close = true
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `api_token` (String, Sensitive) Jira API token
- `email` (String) Jira user email
- `host` (String) Jira host URL
- `name` (String) Name of the integration.

### Optional

- `auto_close` (Boolean) Automatically close Jira issues for resolved Mondoo findings
- `auto_create` (Boolean) Automatically create Jira issues for Mondoo findings
- `default_project` (String) Default Jira project (is represented by the project key e.g. `GTMS` for `Go to market sample`)

Check warning on line 53 in docs/resources/integration_jira.md

View workflow job for this annotation

GitHub Actions / Run spell check

`GTMS` is not a recognized word. (unrecognized-spelling)
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.

### Read-Only

- `mrn` (String) Integration identifier
10 changes: 5 additions & 5 deletions examples/resources/mondoo_integration_jira/resource.tf
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ provider "mondoo" {

# Setup the jira integration
resource "mondoo_integration_jira" "jira_integration" {
name = "My Jira Integration"
host = "https://your-instance.atlassian.net"
email = "[email protected]"
name = "My Jira Integration"
host = "https://your-instance.atlassian.net"
email = "[email protected]"
# default_project = "GTMS"
api_token = var.jira_token
api_token = var.jira_token

auto_create = true
auto_close = true
}

0 comments on commit b130223

Please sign in to comment.