Skip to content

Commit

Permalink
🧹 update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-rock committed Nov 11, 2023
1 parent d4a6436 commit 28f6b50
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 49 deletions.
30 changes: 0 additions & 30 deletions docs/data-sources/example.md

This file was deleted.

16 changes: 8 additions & 8 deletions docs/resources/registration_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ output "generated_token" {

### Required

- `space_id` (String) Example configurable attribute with default value
- `space_id` (String) Mondoo Space Identifier to create the token in.

### Optional

- `description` (String) Example configurable attribute with default value
- `expires_at` (String) Example configurable attribute with default value
- `expires_in` (String) Example configurable attribute with default value
- `no_expiration` (Boolean) Example configurable attribute with default value
- `revoked` (Boolean) Example configurable attribute with default value
- `description` (String) Description of the token.
- `expires_at` (String) The date and time when the token will expire.
- `expires_in` (String) The duration after which the token will expire. Format: 1h, 1d, 1w, 1m, 1y
- `no_expiration` (Boolean) If set to true, the token will not expire.
- `revoked` (Boolean) If set to true, the token is revoked.

### Read-Only

- `mrn` (String) Example identifier
- `result` (String, Sensitive) The generated random string.
- `mrn` (String) The Mondoo Resource Name (MRN) of the created token.
- `result` (String, Sensitive) The generated token.
16 changes: 8 additions & 8 deletions docs/resources/service_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_service_account Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Example resource
Service account resource
---

# mondoo_service_account (Resource)

Example resource
Service account resource

## Example Usage

Expand Down Expand Up @@ -50,12 +50,12 @@ resource "mondoo_service_account" "service_account" {

### Optional

- `description` (String) Example configurable attribute with default value
- `name` (String) Example configurable attribute
- `org_id` (String) Example configurable attribute with default value
- `roles` (List of String) tbd
- `space_id` (String) Example configurable attribute with default value
- `description` (String) Description of the service account.
- `name` (String) Name of the service account.
- `org_id` (String) Mondoo Organization Identifier to create the service account in.
- `roles` (List of String) Roles to assign to the service account.
- `space_id` (String) Mondoo Space Identifier to create the service account in.

### Read-Only

- `mrn` (String) Example identifier
- `mrn` (String) The Mondoo Resource Name (MRN) of the created service account.
6 changes: 3 additions & 3 deletions docs/resources/space.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ resource "mondoo_space" "my_space" {

### Required

- `org_id` (String) Organization where the space is created
- `org_id` (String) Id of the organization.

### Optional

- `name` (String) Space Name
- `name` (String) Name of the space.

### Read-Only

- `id` (String) Space identifier
- `id` (String) Id of the space. Must be globally within the organization.

0 comments on commit 28f6b50

Please sign in to comment.