Skip to content

Commit

Permalink
Fix documentation generation
Browse files Browse the repository at this point in the history
  • Loading branch information
majori committed Mar 20, 2024
1 parent ca00f14 commit b4ca8af
Show file tree
Hide file tree
Showing 18 changed files with 202 additions and 183 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ website/node_modules
*.test
*.iml

temp

website/vendor

# Test exclusions
Expand Down
30 changes: 0 additions & 30 deletions docs/data-sources/example.md

This file was deleted.

28 changes: 28 additions & 0 deletions docs/data-sources/notification_publisher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_notification_publisher Data Source - dependencytrack"
subcategory: ""
description: |-
TODO data source
---

# dependencytrack_notification_publisher (Data Source)

TODO data source



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

### Required

- `name` (String) Name of the team

### Read-Only

- `default_publisher` (Boolean) Whether this is the default publisher
- `id` (String) Team UUID
- `publisher_class` (String) Class of the publisher
- `template` (String) Template used by the publisher
- `template_mime_type` (String) MIME type of the template
26 changes: 26 additions & 0 deletions docs/data-sources/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_team Data Source - dependencytrack"
subcategory: ""
description: |-
TODO data source
---

# dependencytrack_team (Data Source)

TODO data source



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

### Required

- `id` (String) Team UUID

### Read-Only

- `mapped_oidc_groups` (Set of String) OIDC groups mapped to the team
- `name` (String) Name of the team
- `permissions` (Set of String) Permissions given to the team
26 changes: 0 additions & 26 deletions docs/functions/example.md

This file was deleted.

14 changes: 8 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
page_title: "dependencytrack Provider"
subcategory: ""
description: |-
---

# scaffolding Provider
# dependencytrack Provider



## Example Usage

```terraform
provider "scaffolding" {
# example configuration here
provider "dependencytrack" {
host = "http://localhost:8081"
api_key = "odt_2gbKwjq2j0RT9kESnq8J6LUwxQ4IfFeB"
}
```

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

### Optional
### Required

- `endpoint` (String) Example provider attribute
- `api_key` (String, Sensitive)
- `host` (String)
21 changes: 21 additions & 0 deletions docs/resources/acl_mapping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_acl_mapping Resource - dependencytrack"
subcategory: ""
description: |-
ACL mapping
---

# dependencytrack_acl_mapping (Resource)

ACL mapping



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

### Required

- `project_id` (String) Project UUID
- `team_id` (String) Team UUID
31 changes: 0 additions & 31 deletions docs/resources/example.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/resources/notification_rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_notification_rule Resource - dependencytrack"
subcategory: ""
description: |-
Notification rule
---

# dependencytrack_notification_rule (Resource)

Notification rule



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

### Required

- `name` (String) Name of the rule
- `notification_level` (String) Notification level. Possible values: [INFORMATIONAL, WARNING, ERROR]
- `publisher_id` (String) Publisher UUID
- `scope` (String) Rule scope. Possible values: [PORTFOLIO, SYSTEM]

### Optional

- `enabled` (Boolean)
- `log_successful_publish` (Boolean)
- `notify_children` (Boolean)
- `notify_on` (Set of String)
- `publisher_config` (String) Publisher configuration in JSON format

### Read-Only

- `id` (String) Rule UUID
31 changes: 31 additions & 0 deletions docs/resources/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_project Resource - dependencytrack"
subcategory: ""
description: |-
Team
---

# dependencytrack_project (Resource)

Team



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

### Required

- `classifier` (String) Specifies the type of project. Must be one of the following values: [APPLICATION, CONTAINER, PLATFORM, DEVICE, DATA, FIRMWARE, FILE, OPERATING_SYSTEM, FRAMEWORK, MACHINE_LEARNING_MODEL, LIBRARY, DEVICE_DRIVER]
- `name` (String) Name of the team

### Optional

- `active` (Boolean) Whether the project is active or not. Default is true.
- `description` (String) Name of the team
- `parent_id` (String) Parent project UUID

### Read-Only

- `id` (String) Project UUID
24 changes: 24 additions & 0 deletions docs/resources/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_team Resource - dependencytrack"
subcategory: ""
description: |-
Team
---

# dependencytrack_team (Resource)

Team



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

### Required

- `name` (String) Name of the team

### Read-Only

- `id` (String) Team UUID
21 changes: 21 additions & 0 deletions docs/resources/team_permission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_team_permission Resource - dependencytrack"
subcategory: ""
description: |-
Team permission
---

# dependencytrack_team_permission (Resource)

Team permission



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

### Required

- `name` (String) Name of the permission
- `team_id` (String) ID of the team
3 changes: 0 additions & 3 deletions examples/data-sources/scaffolding_example/data-source.tf

This file was deleted.

Loading

0 comments on commit b4ca8af

Please sign in to comment.