Skip to content

Commit

Permalink
Update watch and custom issue docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhung committed Aug 6, 2024
1 parent 8c1e739 commit e7cd6d4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
13 changes: 8 additions & 5 deletions docs/resources/custom_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,20 @@ resource "xray_custom_issue" "my-issue-1" {

### Required

- `component` (Block Set, Min: 1) Component of custom issue (see [below for nested schema](#nestedblock--component))
- `cve` (Block Set, Min: 1) CVE of the custom issue (see [below for nested schema](#nestedblock--cve))
- `description` (String) Description of custom issue
- `name` (String) Name of the custom issue. It must not begin with 'xray' (case insensitive)
- `package_type` (String) Package Type of custom issue. Valid values are: alpine, bower, cargo, composer, conan, conda, cran, debian, docker, generic, go, gradle, huggingface, ivy, maven, npm, nuget, oci, pypi, rpm, rubygems, sbt, terraformbe
- `provider_name` (String) Provider of custom issue. It must not be 'jfrog' (case insensitive)
- `severity` (String) Severity of custom issue. Valid values: Critical, High, Medium, Low, Information
- `source` (Block Set, Min: 1) List of sources (see [below for nested schema](#nestedblock--source))
- `summary` (String) Summary of custom issue
- `type` (String) Type of custom issue. Valid values: other, performance, security, versions

### Optional

- `component` (Block Set) Component of custom issue (see [below for nested schema](#nestedblock--component))
- `cve` (Block Set) CVE of the custom issue (see [below for nested schema](#nestedblock--cve))
- `source` (Block Set) List of sources (see [below for nested schema](#nestedblock--source))

### Read-Only

- `id` (String) The ID of this resource.
Expand All @@ -73,7 +76,7 @@ Required:

Optional:

- `fixed_versions` (Set of String) List of the fixed versions
- `fixed_versions` (Set of String) List of fixed versions
- `vulnerable_ranges` (Block Set) List of the vulnerable ranges (see [below for nested schema](#nestedblock--component--vulnerable_ranges))
- `vulnerable_versions` (Set of String) List of vulnerable versions

Expand All @@ -82,7 +85,7 @@ Optional:

Optional:

- `fixed_versions` (Set of String) List of the fixed versions
- `fixed_versions` (Set of String) List of fixed versions
- `vulnerable_versions` (Set of String) List of vulnerable versions


Expand Down
10 changes: 3 additions & 7 deletions docs/resources/watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,20 +358,16 @@ resource "xray_watch" "project" {

### Required

- `assigned_policy` (Block Set, Min: 1) Nested argument describing policies that will be applied. Defined below. (see [below for nested schema](#nestedblock--assigned_policy))
- `name` (String) Name of the watch (must be unique)
- `watch_resource` (Block Set, Min: 1) Nested argument describing the resources to be watched. Defined below. (see [below for nested schema](#nestedblock--watch_resource))
- `name` (String) Name of the watch

### Optional

- `active` (Boolean) Whether or not the watch is active
- `assigned_policy` (Block Set) Nested argument describing policies that will be applied. Defined below. (see [below for nested schema](#nestedblock--assigned_policy))
- `description` (String) Description of the watch
- `project_key` (String) Project key for assigning this resource to. Must be 2 - 10 lowercase alphanumeric and hyphen characters. Support repository and build watch resource types. When specifying individual repository or build they must be already assigned to the project. Build must be added as indexed resources.
- `watch_recipients` (Set of String) A list of email addressed that will get emailed when a violation is triggered.

### Read-Only

- `id` (String) The ID of this resource.
- `watch_resource` (Block Set) (see [below for nested schema](#nestedblock--watch_resource))

<a id="nestedblock--assigned_policy"></a>
### Nested Schema for `assigned_policy`
Expand Down

0 comments on commit e7cd6d4

Please sign in to comment.