From 6a8ca8148ed3b23e89fd9f37af74842b3de059fd Mon Sep 17 00:00:00 2001 From: Riccardo Angelilli Date: Thu, 13 Jul 2023 13:28:46 +0200 Subject: [PATCH] update doc files for Projects (#4681) * fix: generate project code Signed-off-by: dvesperini * fix: fix build Signed-off-by: dvesperini * fix: add examples and markdown files Signed-off-by: dvesperini * fix: mark new false positive secrets Signed-off-by: dvesperini * fix: fix review Signed-off-by: dvesperini * fix: fix links Signed-off-by: dvesperini * fix: fix test Signed-off-by: dvesperini * fix: remove regex check Signed-off-by: dvesperini * fix: fix id to project_id Signed-off-by: dvesperini * fix: fix integration test project Signed-off-by: dvesperini * fix: fix resource_group values Signed-off-by: dvesperini * fix: last changes Signed-off-by: dvesperini * fix integration test * fix integration test * fix integration test * fix integration test * fix integration test * fix integration test * fix name * pr comments * pr comments * fix doc * fix doc * new version * new version * new version * new version * update code to the latest SDK level * fix integration tests * fix integration tests * fix integration tests * fix integration tests * address PR comment * typo * typo * Update project_instance.html.markdown Fixing formatting issues * Update project_event_notification.html.markdown * Update README.md * Update variables.tf * Update project_event_notification.html.markdown --------- Signed-off-by: dvesperini Co-authored-by: dvesperini Co-authored-by: knee-na <130502432+knee-na@users.noreply.github.com> --- .../d/project_event_notification.html.markdown | 14 +++++++------- website/docs/r/project_instance.html.markdown | 16 ++++++++-------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/website/docs/d/project_event_notification.html.markdown b/website/docs/d/project_event_notification.html.markdown index e546b6e542..6818a34bc8 100644 --- a/website/docs/d/project_event_notification.html.markdown +++ b/website/docs/d/project_event_notification.html.markdown @@ -78,7 +78,7 @@ Nested scheme for **configs**: * `metadata` - (List) The metadata of the project. Nested scheme for **metadata**: - * `created_at` - (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339. + * `created_at` - (String) A date and time value in the format `YYYY-MM-DDTHH:mm:ssZ` or `YYYY-MM-DDTHH:mm:ss.sssZ`, matching the date and time format as specified by RFC 3339. * `crn` - (String) An IBM Cloud resource name, which uniquely identifies a resource. * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. * `cumulative_needs_attention_view` - (List) The cumulative list of needs attention items for a project. @@ -88,20 +88,20 @@ Nested scheme for **metadata**: * Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`. * `config_version` - (Integer) The version number of the configuration. * `event` - (String) The event name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `event_id` - (String) The unique ID of a project. * Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`. - * `cumulative_needs_attention_view_err` - (String) \"True\" indicates that the fetch of the needs attention items failed. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * `cumulative_needs_attention_view_err` - (String) `True` indicates that the fetch of the needs attention items failed. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `event_notifications_crn` - (String) The CRN of the event notifications instance if one is connected to this project. * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. * `location` - (String) The IBM Cloud location where a resource is deployed. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `resource_group` - (String) The resource group where the project's data and tools are created. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `state` - (String) The project status value. * Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(CREATING|CREATING_FAILED|UPDATING|UPDATING_FAILED|READY)$/`. * `name` - (String) The project name. - * Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/`. diff --git a/website/docs/r/project_instance.html.markdown b/website/docs/r/project_instance.html.markdown index 71fc66d409..5193113914 100644 --- a/website/docs/r/project_instance.html.markdown +++ b/website/docs/r/project_instance.html.markdown @@ -70,9 +70,9 @@ Nested scheme for **configs**: * `location` - (Required, String) The location where the project's data and tools are created. * Constraints: The maximum length is `12` characters. The minimum length is `0` characters. The value must match regular expression `/^$|^(us-south|us-east|eu-gb|eu-de)$/`. * `name` - (Required, String) The project name. - * Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/`. * `resource_group` - (Required, String) The resource group where the project's data and tools are created. - * Constraints: The maximum length is `40` characters. The minimum length is `0` characters. The value must match regular expression `/^$|^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `40` characters. The minimum length is `0` characters. The value must match regular expression `/^$|^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. ## Attribute Reference @@ -83,7 +83,7 @@ In addition to all argument references listed, you can access the following attr * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. * `metadata` - (List) The metadata of the project. Nested scheme for **metadata**: - * `created_at` - (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339. + * `created_at` - (String) A date and time value in the format `YYYY-MM-DDTHH:mm:ssZ` or `YYYY-MM-DDTHH:mm:ss.sssZ`, matching the date and time format as specified by RFC 3339. * `crn` - (String) An IBM Cloud resource name, which uniquely identifies a resource. * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. * `cumulative_needs_attention_view` - (List) The cumulative list of needs attention items for a project. @@ -93,17 +93,17 @@ Nested scheme for **metadata**: * Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`. * `config_version` - (Integer) The version number of the configuration. * `event` - (String) The event name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `event_id` - (String) The unique ID of a project. * Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`. - * `cumulative_needs_attention_view_err` - (String) \"True\" indicates that the fetch of the needs attention items failed. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * `cumulative_needs_attention_view_err` - (String) `True` indicates that the fetch of the needs attention items failed. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `event_notifications_crn` - (String) The CRN of the event notifications instance if one is connected to this project. * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. * `location` - (String) The IBM Cloud location where a resource is deployed. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `resource_group` - (String) The resource group where the project's data and tools are created. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`. + * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`. * `state` - (String) The project status value. * Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(CREATING|CREATING_FAILED|UPDATING|UPDATING_FAILED|READY)$/`.