Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix for wrong format of tables in terraform registry #333

Merged
merged 2 commits into from
Jul 26, 2023
Merged

docs: fix for wrong format of tables in terraform registry #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2833985
fix: misformated docu
lechnerc77 Jul 26, 2023
817f8fa
docu: sync usage of backticks in docu
lechnerc77 Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/data-sources/globalaccount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ data "btp_globalaccount" "this" {}

| value | description |
| --- | --- |
| COST_CENTER | Cost Center |
| INTERNAL_ORDER | Internal Order |
| WBS_ELEMENT | WBS Element |
| `COST_CENTER` | Cost Center |
| `INTERNAL_ORDER` | Internal Order |
| `WBS_ELEMENT` | WBS Element |
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `crm_customer_id` (String) The ID of the customer as registered in the CRM system.
- `crm_tenant_id` (String) The ID of the customer tenant as registered in the CRM system.
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/subaccount_service_binding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ data "btp_subaccount_service_binding" "by_name" {

| state | description |
| --- | --- |
| in progress | The operation or processing is in progress |
| failed | The operation or processing failed |
| succeeded | The operation or processing succeeded |
| `in progress` | The operation or processing is in progress |
| `failed` | The operation or processing failed |
| `succeeded` | The operation or processing succeeded |
4 changes: 2 additions & 2 deletions docs/data-sources/subaccount_service_offerings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ data "btp_subaccount_service_offerings" "labeled" {

| value | description |
| --- | --- |
| cloudfoundry | Cloud Foundry |
| kubernetes | Kubernetes |
| `cloudfoundry` | Cloud Foundry |
| `kubernetes` | Kubernetes |
- `fields_filter` (String) Filters the response based on the field query. For example, use "name eq 'my service offering name'".
- `labels_filter` (String) Filters the response based on the label query. For example, to list all the service offerings associated with the testing environment, use "environment eq 'test'".

Expand Down
37 changes: 19 additions & 18 deletions docs/resources/directory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,32 +58,33 @@ resource "btp_directory" "child" {
- `created_by` (String) The details of the user that created the directory.
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `features` (Set of String) The features that are enabled for the directory. Possible values are:

| value | description |
| --- | --- |
| DEFAULT | All directories have the following basic feature enabled:<br> 1. Group and filter subaccounts for reports and filters <br> 2. Monitor usage and costs on a directory level (costs only available for contracts that use the consumption-based commercial model)<br> 3. Set custom properties and tags to the directory for identification and reporting purposes. |
| ENTITLEMENTS | Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory. |
| AUTHORIZATIONS | Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the `ENTITLEMENTS` feature. |
| `DEFAULT` | All directories have the following basic feature enabled:<br> 1. Group and filter subaccounts for reports and filters <br> 2. Monitor usage and costs on a directory level (costs only available for contracts that use the consumption-based commercial model)<br> 3. Set custom properties and tags to the directory for identification and reporting purposes. |
| `ENTITLEMENTS` | Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory. |
| `AUTHORIZATIONS` | Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the `ENTITLEMENTS` feature. |
- `id` (String) The ID of the directory.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `state` (String) The current state of the directory. Possible values are:

| value | description |
| --- | --- |
| OK | The CRUD operation or series of operations completed successfully. |
| STARTED | CRUD operation on an entity has started. |
| CREATING | Creating entity operation is in progress. |
| UPDATING | Updating entity operation is in progress. |
| MOVING | Moving entity operation is in progress. |
| PROCESSING | A series of operations related to the entity is in progress. |
| DELETING | Deleting entity operation is in progress. |
| PENDING REVIEW | The processing operation has been stopped for reviewing and can be restarted by the operator. |
| CANCELLED | The operation or processing was canceled by the operator. |
| CREATION_FAILED | The creation operation failed, and the entity was not created or was created but cannot be used. |
| UPDATE_FAILED | The update operation failed, and the entity was not updated. |
| PROCESSING_FAILED | The processing operations failed. |
| DELETION_FAILED | The delete operation failed, and the entity was not deleted. |
| MOVE_FAILED | Entity could not be moved to a different location. |
| MIGRATING | Migrating entity from Neo to Cloud Foundry. |
| `OK` | The CRUD operation or series of operations completed successfully. |
| `STARTED` | CRUD operation on an entity has started. |
| `CREATING` | Creating entity operation is in progress. |
| `UPDATING` | Updating entity operation is in progress. |
| `MOVING` | Moving entity operation is in progress. |
| `PROCESSING` | A series of operations related to the entity is in progress. |
| `DELETING` | Deleting entity operation is in progress. |
| `PENDING REVIEW` | The processing operation has been stopped for reviewing and can be restarted by the operator. |
| `CANCELLED` | The operation or processing was canceled by the operator. |
| `CREATION_FAILED` | The creation operation failed, and the entity was not created or was created but cannot be used. |
| `UPDATE_FAILED` | The update operation failed, and the entity was not updated. |
| `PROCESSING_FAILED` | The processing operations failed. |
| `DELETION_FAILED` | The delete operation failed, and the entity was not deleted. |
| `MOVE_FAILED` | Entity could not be moved to a different location. |
| `MIGRATING` | Migrating entity from Neo to Cloud Foundry. |

## Import

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/subaccount_service_binding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ resource "btp_subaccount_service_binding" "my_parameterized_binding" {

| state | description |
| --- | --- |
| in progress | The operation or processing is in progress |
| failed | The operation or processing failed |
| succeeded | The operation or processing succeeded |
| `in progress` | The operation or processing is in progress |
| `failed` | The operation or processing failed |
| `succeeded` | The operation or processing succeeded |

## Import

Expand Down
6 changes: 3 additions & 3 deletions internal/provider/datasource_globalaccount.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ __Further documentation:__
MarkdownDescription: "The type of accounting assignment object that is associated with the global account owner and used to charge for the creation and usage of the global account. The number or code of the specified cost object is defined in `costobject_id`. Possible values are: \n" +
getFormattedValueAsTableRow("value", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("COST_CENTER", "Cost Center") +
getFormattedValueAsTableRow("INTERNAL_ORDER", "Internal Order") +
getFormattedValueAsTableRow("WBS_ELEMENT", "WBS Element"),
getFormattedValueAsTableRow("`COST_CENTER`", "Cost Center") +
getFormattedValueAsTableRow("`INTERNAL_ORDER`", "Internal Order") +
getFormattedValueAsTableRow("`WBS_ELEMENT`", "WBS Element"),
Computed: true,
},
"crm_customer_id": schema.StringAttribute{
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_globalaccount_resource_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ __Further documentation:__
MarkdownDescription: "The provider of the requested resource. Possible values are: \n" +
getFormattedValueAsTableRow("value", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("AWS", "Amazon Web Services") +
getFormattedValueAsTableRow("AZURE", "Microsoft Azure"),
getFormattedValueAsTableRow("`AWS`", "Amazon Web Services") +
getFormattedValueAsTableRow("`AZURE`", "Microsoft Azure"),
Required: true,
Validators: []validator.String{
stringvalidator.LengthAtLeast(1),
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_globalaccount_resource_providers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ __Further documentation:__
MarkdownDescription: "The provider of the requested resource. Possible values are: \n" +
getFormattedValueAsTableRow("value", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("AWS", "Amazon Web Services") +
getFormattedValueAsTableRow("AZURE", "Microsoft Azure"),
getFormattedValueAsTableRow("`AWS`", "Amazon Web Services") +
getFormattedValueAsTableRow("`AZURE`", "Microsoft Azure"),
Computed: true,
},
"id": schema.StringAttribute{
Expand Down
6 changes: 3 additions & 3 deletions internal/provider/datasource_subaccount_service_binding.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ func (ds *subaccountServiceBindingDataSource) Schema(_ context.Context, _ dataso
MarkdownDescription: "The current state of the service binding. Possible values are: \n" +
getFormattedValueAsTableRow("state", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("in progress", "The operation or processing is in progress") +
getFormattedValueAsTableRow("failed", "The operation or processing failed") +
getFormattedValueAsTableRow("succeeded", "The operation or processing succeeded"),
getFormattedValueAsTableRow("`in progress`", "The operation or processing is in progress") +
getFormattedValueAsTableRow("`failed`", "The operation or processing failed") +
getFormattedValueAsTableRow("`succeeded`", "The operation or processing succeeded"),
Computed: true,
},
"created_date": schema.StringAttribute{
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_subaccount_service_offerings.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ func (ds *subaccountServiceOfferingsDataSource) Schema(_ context.Context, _ data
MarkdownDescription: "Lists services to be consumed in a Cloud Foundry or Kubernetes-native way. Valid values are: \n " +
getFormattedValueAsTableRow("value", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("cloudfoundry", "Cloud Foundry") +
getFormattedValueAsTableRow("kubernetes", "Kubernetes"),
getFormattedValueAsTableRow("`cloudfoundry`", "Cloud Foundry") +
getFormattedValueAsTableRow("`kubernetes`", "Kubernetes"),
Optional: true,
},
"fields_filter": schema.StringAttribute{
Expand Down
38 changes: 19 additions & 19 deletions internal/provider/resource_directory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,15 @@ __Further documentation:__

"features": schema.SetAttribute{
ElementType: types.StringType,
MarkdownDescription: "The features that are enabled for the directory. Possible values are: " +
MarkdownDescription: "The features that are enabled for the directory. Possible values are: \n" +
getFormattedValueAsTableRow("value", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("DEFAULT", "All directories have the following basic feature enabled:"+
getFormattedValueAsTableRow("`DEFAULT`", "All directories have the following basic feature enabled:"+
"<br> 1. Group and filter subaccounts for reports and filters "+
"<br> 2. Monitor usage and costs on a directory level (costs only available for contracts that use the consumption-based commercial model)"+
"<br> 3. Set custom properties and tags to the directory for identification and reporting purposes.") +
getFormattedValueAsTableRow("ENTITLEMENTS", "Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory.") +
getFormattedValueAsTableRow("AUTHORIZATIONS", "Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the `ENTITLEMENTS` feature."),
getFormattedValueAsTableRow("`ENTITLEMENTS`", "Allows the assignment of a quota for services and applications to the directory from the global account quota for distribution to the subaccounts under this directory.") +
getFormattedValueAsTableRow("`AUTHORIZATIONS`", "Allows the assignment of users as administrators or viewers of this directory. You must apply this feature in combination with the `ENTITLEMENTS` feature."),
Computed: true,
},
"last_modified": schema.StringAttribute{
Expand All @@ -136,21 +136,21 @@ __Further documentation:__
MarkdownDescription: "The current state of the directory. Possible values are: \n" +
getFormattedValueAsTableRow("value", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("OK", "The CRUD operation or series of operations completed successfully.") +
getFormattedValueAsTableRow("STARTED", "CRUD operation on an entity has started.") +
getFormattedValueAsTableRow("CREATING", "Creating entity operation is in progress.") +
getFormattedValueAsTableRow("UPDATING", "Updating entity operation is in progress.") +
getFormattedValueAsTableRow("MOVING", "Moving entity operation is in progress.") +
getFormattedValueAsTableRow("PROCESSING", "A series of operations related to the entity is in progress.") +
getFormattedValueAsTableRow("DELETING", "Deleting entity operation is in progress.") +
getFormattedValueAsTableRow("PENDING REVIEW", "The processing operation has been stopped for reviewing and can be restarted by the operator.") +
getFormattedValueAsTableRow("CANCELLED", "The operation or processing was canceled by the operator.") +
getFormattedValueAsTableRow("CREATION_FAILED", "The creation operation failed, and the entity was not created or was created but cannot be used.") +
getFormattedValueAsTableRow("UPDATE_FAILED", "The update operation failed, and the entity was not updated.") +
getFormattedValueAsTableRow("PROCESSING_FAILED", "The processing operations failed.") +
getFormattedValueAsTableRow("DELETION_FAILED", "The delete operation failed, and the entity was not deleted.") +
getFormattedValueAsTableRow("MOVE_FAILED", "Entity could not be moved to a different location.") +
getFormattedValueAsTableRow("MIGRATING", "Migrating entity from Neo to Cloud Foundry."),
getFormattedValueAsTableRow("`OK`", "The CRUD operation or series of operations completed successfully.") +
getFormattedValueAsTableRow("`STARTED`", "CRUD operation on an entity has started.") +
getFormattedValueAsTableRow("`CREATING`", "Creating entity operation is in progress.") +
getFormattedValueAsTableRow("`UPDATING`", "Updating entity operation is in progress.") +
getFormattedValueAsTableRow("`MOVING`", "Moving entity operation is in progress.") +
getFormattedValueAsTableRow("`PROCESSING`", "A series of operations related to the entity is in progress.") +
getFormattedValueAsTableRow("`DELETING`", "Deleting entity operation is in progress.") +
getFormattedValueAsTableRow("`PENDING REVIEW`", "The processing operation has been stopped for reviewing and can be restarted by the operator.") +
getFormattedValueAsTableRow("`CANCELLED`", "The operation or processing was canceled by the operator.") +
getFormattedValueAsTableRow("`CREATION_FAILED`", "The creation operation failed, and the entity was not created or was created but cannot be used.") +
getFormattedValueAsTableRow("`UPDATE_FAILED`", "The update operation failed, and the entity was not updated.") +
getFormattedValueAsTableRow("`PROCESSING_FAILED`", "The processing operations failed.") +
getFormattedValueAsTableRow("`DELETION_FAILED`", "The delete operation failed, and the entity was not deleted.") +
getFormattedValueAsTableRow("`MOVE_FAILED`", "Entity could not be moved to a different location.") +
getFormattedValueAsTableRow("`MIGRATING`", "Migrating entity from Neo to Cloud Foundry."),
Computed: true,
},
},
Expand Down
6 changes: 3 additions & 3 deletions internal/provider/resource_subaccount_service_binding.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ func (rs *subaccountServiceBindingResource) Schema(_ context.Context, _ resource
MarkdownDescription: "The current state of the service binding. Possible values are: \n" +
getFormattedValueAsTableRow("state", "description") +
getFormattedValueAsTableRow("---", "---") +
getFormattedValueAsTableRow("in progress", "The operation or processing is in progress") +
getFormattedValueAsTableRow("failed", "The operation or processing failed") +
getFormattedValueAsTableRow("succeeded", "The operation or processing succeeded"),
getFormattedValueAsTableRow("`in progress`", "The operation or processing is in progress") +
getFormattedValueAsTableRow("`failed`", "The operation or processing failed") +
getFormattedValueAsTableRow("`succeeded`", "The operation or processing succeeded"),
Computed: true,
},
"created_date": schema.StringAttribute{
Expand Down
Loading