From 9ee37e46fbc5b09040ca69038b1ebadf341fd1c1 Mon Sep 17 00:00:00 2001 From: Paz Hershberg Date: Wed, 15 Nov 2023 12:27:22 +0200 Subject: [PATCH] updated docs --- docs/index.md | 20 ++++++++------------ docs/resources/port_action.md | 10 ++++++++++ docs/resources/port_team.md | 2 +- 3 files changed, 19 insertions(+), 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index 957cc111..740d8746 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,27 +1,23 @@ --- - # generated by https://github.com/hashicorp/terraform-plugin-docs - page_title: "port-labs Provider" subcategory: "" description: |- -Interact with Port-labs + Interact with Port-labs +--- # port-labs Provider -[getport.io](https://getport.io) - Interact with Port-labs - - -## Schema -### Required -- `client_id` (String) Client ID for Port-labs (environment: `PORT_CLIENT_ID`) -- `secret` (String, Sensitive) Client Secret for Port-labs (environment: `PORT_CLIENT_SECRET`) + +## Schema ### Optional -- `base_url` (String) Base URL for Port-labs (environment: `PORT_BASE_URL`) +- `base_url` (String) +- `client_id` (String) Client ID for Port-labs +- `secret` (String, Sensitive) Client Secret for Port-labs +- `token` (String, Sensitive) Token for Port-labs diff --git a/docs/resources/port_action.md b/docs/resources/port_action.md index 267a3a83..c582c0a7 100644 --- a/docs/resources/port_action.md +++ b/docs/resources/port_action.md @@ -133,6 +133,8 @@ Optional: - `required` (Boolean) Whether the property is required - `string_items` (Attributes) The items of the array property (see [below for nested schema](#nestedatt--user_properties--array_props--string_items)) - `title` (String) The title of the property +- `visible` (Boolean) The visibility of the array property +- `visible_jq_query` (String) The visibility condition jq query of the array property ### Nested Schema for `user_properties.array_props.boolean_items` @@ -217,6 +219,8 @@ Optional: - `icon` (String) The icon of the property - `required` (Boolean) Whether the property is required - `title` (String) The title of the property +- `visible` (Boolean) The visibility of the boolean property +- `visible_jq_query` (String) The visibility condition jq query of the boolean property ### Nested Schema for `user_properties.boolean_props.dataset` @@ -267,6 +271,8 @@ Optional: - `minimum` (Number) The max of the number property - `required` (Boolean) Whether the property is required - `title` (String) The title of the property +- `visible` (Boolean) The visibility of the number property +- `visible_jq_query` (String) The visibility condition jq query of the number property ### Nested Schema for `user_properties.number_props.dataset` @@ -314,6 +320,8 @@ Optional: - `icon` (String) The icon of the property - `required` (Boolean) Whether the property is required - `title` (String) The title of the property +- `visible` (Boolean) The visibility of the object property +- `visible_jq_query` (String) The visibility condition jq query of the object property ### Nested Schema for `user_properties.object_props.dataset` @@ -368,6 +376,8 @@ Optional: - `pattern` (String) The pattern of the string property - `required` (Boolean) Whether the property is required - `title` (String) The title of the property +- `visible` (Boolean) The visibility of the string property +- `visible_jq_query` (String) The visibility condition jq query of the string property ### Nested Schema for `user_properties.string_props.dataset` diff --git a/docs/resources/port_team.md b/docs/resources/port_team.md index fcdeb846..518df378 100644 --- a/docs/resources/port_team.md +++ b/docs/resources/port_team.md @@ -22,7 +22,7 @@ Team resource ### Optional - `description` (String) The description of the team -- `users` (List of String) The users of the team +- `users` (Set of String) The users of the team ### Read-Only