From 28f6b507e519a9ae49a3de4fec7accb0025a9db6 Mon Sep 17 00:00:00 2001 From: Christoph Hartmann Date: Sat, 11 Nov 2023 17:28:17 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=B9=20update=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/data-sources/example.md | 30 ---------------------------- docs/resources/registration_token.md | 16 +++++++-------- docs/resources/service_account.md | 16 +++++++-------- docs/resources/space.md | 6 +++--- 4 files changed, 19 insertions(+), 49 deletions(-) delete mode 100644 docs/data-sources/example.md diff --git a/docs/data-sources/example.md b/docs/data-sources/example.md deleted file mode 100644 index bcf83ee..0000000 --- a/docs/data-sources/example.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "mondoo_example Data Source - terraform-provider-mondoo" -subcategory: "" -description: |- - Example data source ---- - -# mondoo_example (Data Source) - -Example data source - -## Example Usage - -```terraform -data "mondoo_example" "example" { - configurable_attribute = "some-value" -} -``` - - -## Schema - -### Optional - -- `configurable_attribute` (String) Example configurable attribute - -### Read-Only - -- `id` (String) Example identifier diff --git a/docs/resources/registration_token.md b/docs/resources/registration_token.md index b3a2356..3699845 100644 --- a/docs/resources/registration_token.md +++ b/docs/resources/registration_token.md @@ -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. diff --git a/docs/resources/service_account.md b/docs/resources/service_account.md index 42597a3..0bd2b9b 100644 --- a/docs/resources/service_account.md +++ b/docs/resources/service_account.md @@ -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 @@ -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. diff --git a/docs/resources/space.md b/docs/resources/space.md index edc0eeb..8a668f9 100644 --- a/docs/resources/space.md +++ b/docs/resources/space.md @@ -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.