Skip to content

Commit

Permalink
update doc files for Projects (IBM-Cloud#4681)
Browse files Browse the repository at this point in the history 
* fix: generate project code

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix build

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: add examples and markdown files

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: mark new false positive secrets

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix review

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix links

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix test

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: remove regex check

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix id to project_id

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix integration test project

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: fix resource_group values

Signed-off-by: dvesperini <dvesperini@gmail.com>

* fix: last changes

Signed-off-by: dvesperini <dvesperini@gmail.com>

* 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 <dvesperini@gmail.com>
Co-authored-by: dvesperini <dvesperini@gmail.com>
Co-authored-by: knee-na <130502432+knee-na@users.noreply.github.com>
  • Loading branch information
@riccardo-angelilli @dvesperini
@knee-na @omaraibrahim
3 people authored and omaraibrahim committed Jul 20, 2023
1 parent aae59b7 commit ff5cf0b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
14 changes: 7 additions & 7 deletions website/docs/d/project_event_notification.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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]+$/`.

16 changes: 8 additions & 8 deletions website/docs/r/project_instance.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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)$/`.

Expand Down

0 comments on commit ff5cf0b

Please sign in to comment.