Skip to content

Commit

Permalink
reviewed docs for new datasources and resources
Browse files Browse the repository at this point in the history
  • Loading branch information
annawenger20 committed Jul 25, 2023
1 parent ba459fa commit f7f0b30
Show file tree
Hide file tree
Showing 24 changed files with 47 additions and 47 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/subaccount_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_apps Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Lists all apps.
Lists all apps in a subaccount.
---

# btp_subaccount_apps (Data Source)

Lists all apps.
Lists all apps in a subaccount.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/subaccount_service_binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ data "btp_subaccount_service_binding" "by_name" {
- `context` (Map of String) Contextual data for the resource.
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `credentials` (String, Sensitive) The credentials to access the binding.
- `labels` (Map of Set of String) Set of words or phrases assigned to the binding.
- `labels` (Map of Set of String) The set of words or phrases assigned to the binding.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `parameters` (String) The parameters of the service binding as a valid JSON object.
- `ready` (Boolean) Shows whether the service binding is ready.
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/subaccount_service_bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_bindings Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Lists all service bindings in a subaccount.
Lists all service bindings in a subaccount, i.e. the access details to consume a service.
---

# btp_subaccount_service_bindings (Data Source)

Lists all service bindings in a subaccount.
Lists all service bindings in a subaccount, i.e. the access details to consume a service.

## Example Usage

Expand Down Expand Up @@ -55,7 +55,7 @@ Read-Only:
- `context` (Map of String) Contextual data for the resource.
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `credentials` (String, Sensitive) The credentials to access the binding.
- `labels` (Map of Set of String) Set of words or phrases assigned to the binding.
- `labels` (Map of Set of String) The set of words or phrases assigned to the binding.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `ready` (Boolean) Shows whether the service binding is ready.
- `service_instance_id` (String) The ID of the service instance associated with the binding.
6 changes: 3 additions & 3 deletions docs/data-sources/subaccount_service_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_instance Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets details about a specific provisioned service instance such as its name, id, platform to which it belongs, the last operation performed, and more.
Gets details about a specific provisioned service instance, such as its name, id, platform to which it belongs, and the last operation performed.
---

# btp_subaccount_service_instance (Data Source)

Gets details about a specific provisioned service instance such as its name, id, platform to which it belongs, the last operation performed, and more.
Gets details about a specific provisioned service instance, such as its name, id, platform to which it belongs, and the last operation performed.

## Example Usage

Expand Down Expand Up @@ -41,7 +41,7 @@ data "btp_subaccount_service_instance" "by_name" {

- `context` (Map of String) Contextual data for the resource.
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `labels` (Map of Set of String) Set of words or phrases assigned to the service instance.
- `labels` (Map of Set of String) The set of words or phrases assigned to the service instance.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `parameters` (String) The configuration parameters for the service instance.
- `platform_id` (String) The platform ID.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/subaccount_service_instances.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_instances Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets all service instances in a subaccount.
Lists all service instances in a subaccount.
---

# btp_subaccount_service_instances (Data Source)

Gets all service instances in a subaccount.
Lists all service instances in a subaccount.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/subaccount_service_offering.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_offering Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets details about a specific service offering such as its ID, name, description, metadata, the associated service brokers, and more.
Gets details about a specific service offering such as its ID, name, description, metadata, and the associated service brokers.
---

# btp_subaccount_service_offering (Data Source)

Gets details about a specific service offering such as its ID, name, description, metadata, the associated service brokers, and more.
Gets details about a specific service offering such as its ID, name, description, metadata, and the associated service brokers.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/subaccount_service_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_plan Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets details about a specific service plan such as its name, description, metadata, and more.
Gets details about a specific service plan such as its name, description, and metadata.
---

# btp_subaccount_service_plan (Data Source)

Gets details about a specific service plan such as its name, description, metadata, and more.
Gets details about a specific service plan such as its name, description, and metadata.

## Example Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/subaccount_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "btp_subaccount_subscription Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Gets the details of a specific multitenant application to which a subaccount is entitled to subscribe. If this application is in a different global account than the current one, you need to specify its plan with '--plan'.
Gets details of a specific multitenant application to which a subaccount is entitled to subscribe. If this application is in a different global account than the current one, you need to specify its plan with '--plan'.
Tip:
You must be assigned to the subaccount admin or viewer role.
---

# btp_subaccount_subscription (Data Source)

Gets the details of a specific multitenant application to which a subaccount is entitled to subscribe. If this application is in a different global account than the current one, you need to specify its plan with '--plan'.
Gets details of a specific multitenant application to which a subaccount is entitled to subscribe. If this application is in a different global account than the current one, you need to specify its plan with '--plan'.

__Tip:__
You must be assigned to the subaccount admin or viewer role.
Expand Down Expand Up @@ -47,7 +47,7 @@ data "btp_subaccount_subscription" "content_agent_ui_free" {
- `formation_solution_name` (String) The name of the formations solution associated with the multitenant application.
- `globalaccount_id` (String) The ID of the associated global account.
- `id` (String) The technical ID generated by XSUAA for a multitenant application when a consumer subscribes to the application.
- `labels` (Map of Set of String) Set of words or phrases assigned to the multitenant application subscription.
- `labels` (Map of Set of String) The set of words or phrases assigned to the multitenant application subscription.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `parameters` (String) The parameters of the subscription as a valid JSON object.
- `platform_entity_id` (String) The ID of the landscape-specific environment.
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/subaccount_subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
page_title: "btp_subaccount_subscriptions Data Source - terraform-provider-btp"
subcategory: ""
description: |-
Lists all the multitenant applications to which a subaccount is entitled to subscribe, including their subscription details.
Lists all multitenant applications to which the subaccount is entitled to subscribe, including their subscription details.
Tip:
You must be assigned to the subaccount admin or viewer role.
---

# btp_subaccount_subscriptions (Data Source)

Lists all the multitenant applications to which a subaccount is entitled to subscribe, including their subscription details.
Lists all multitenant applications to which the subaccount is entitled to subscribe, including their subscription details.

__Tip:__
You must be assigned to the subaccount admin or viewer role.
Expand Down Expand Up @@ -56,7 +56,7 @@ Read-Only:
- `globalaccount_id` (String) The ID of the associated global account.
- `id` (String) The technical ID generated by XSUAA for a multitenant application when a consumer subscribes to the application.
- `incident_tracking_component` (String) The application's incident-tracking component provided in metadata for customer-facing UIs.
- `labels` (Map of Set of String) Set of words or phrases assigned to the multitenant application subscription.
- `labels` (Map of Set of String) The set of words or phrases assigned to the multitenant application subscription.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `plan_description` (String) The description of the plan for customer-facing UIs.
- `plan_name` (String) The plan name of the application to which the consumer has subscribed.
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/subaccount_service_binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_binding Resource - terraform-provider-btp"
subcategory: ""
description: |-
Creates a service binding between a service instance and an application.
Creates a service binding, i.e. generates access details to consume a service.
---

# btp_subaccount_service_binding (Resource)

Creates a service binding between a service instance and an application.
Creates a service binding, i.e. generates access details to consume a service.

## Example Usage

Expand Down Expand Up @@ -51,7 +51,7 @@ resource "btp_subaccount_service_binding" "my_parameterized_binding" {
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `credentials` (String, Sensitive) The credentials to access the binding.
- `id` (String) The ID of the service binding.
- `labels` (Map of Set of String) Set of words or phrases assigned to service binding.
- `labels` (Map of Set of String) The set of words or phrases assigned to service binding.
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format.
- `ready` (Boolean) Shows whether the service binding is ready.
- `state` (String) The current state of the service binding. Possible values are:
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/subaccount_service_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
page_title: "btp_subaccount_service_instance Resource - terraform-provider-btp"
subcategory: ""
description: |-
Creates a new service instance.
Creates a service instance in a subaccount.
---

# btp_subaccount_service_instance (Resource)

Creates a new service instance.
Creates a service instance in a subaccount.

## Example Usage

Expand Down Expand Up @@ -44,7 +44,7 @@ resource "btp_subaccount_service_instance" "xsuaa_application" {

### Optional

- `labels` (Map of Set of String) Set of words or phrases assigned to the service instance..
- `labels` (Map of Set of String) The set of words or phrases assigned to the service instance.
- `parameters` (String, Sensitive) The configuration parameters for the service instance.

### Read-Only
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/subaccount_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
page_title: "btp_subaccount_subscription Resource - terraform-provider-btp"
subcategory: ""
description: |-
Subscribes to a multitenant application from a subaccount.
Subscribes a subaccount to a multitenant application.
Custom or partner-developed applications are currently not supported.
Tip:
You must be assigned to the subaccount admin role.
---

# btp_subaccount_subscription (Resource)

Subscribes to a multitenant application from a subaccount.
Subscribes a subaccount to a multitenant application.
Custom or partner-developed applications are currently not supported.

__Tip:__
Expand Down
2 changes: 1 addition & 1 deletion internal/provider/datasource_subaccount_apps.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func (ds *subaccountAppsDataSource) Configure(_ context.Context, req datasource.

func (ds *subaccountAppsDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Lists all apps.`,
MarkdownDescription: `Lists all apps in a subaccount.`,
Attributes: map[string]schema.Attribute{
"subaccount_id": schema.StringAttribute{
MarkdownDescription: "The ID of the subaccount.",
Expand Down
2 changes: 1 addition & 1 deletion internal/provider/datasource_subaccount_service_binding.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func (ds *subaccountServiceBindingDataSource) Schema(_ context.Context, _ dataso
ElementType: types.SetType{
ElemType: types.StringType,
},
MarkdownDescription: "Set of words or phrases assigned to the binding.",
MarkdownDescription: "The set of words or phrases assigned to the binding.",
Computed: true,
},
},
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_subaccount_service_bindings.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (ds *subaccountServiceBindingsDataSource) Configure(_ context.Context, req

func (ds *subaccountServiceBindingsDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Lists all service bindings in a subaccount.`,
MarkdownDescription: `Lists all service bindings in a subaccount, i.e. the access details to consume a service.`,
Attributes: map[string]schema.Attribute{
"subaccount_id": schema.StringAttribute{
MarkdownDescription: "The ID of the subaccount.",
Expand Down Expand Up @@ -135,7 +135,7 @@ func (ds *subaccountServiceBindingsDataSource) Schema(_ context.Context, _ datas
ElementType: types.SetType{
ElemType: types.StringType,
},
MarkdownDescription: "Set of words or phrases assigned to the binding.",
MarkdownDescription: "The set of words or phrases assigned to the binding.",
Computed: true,
},
},
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_subaccount_service_instance.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (ds *subaccountServiceInstanceDataSource) Configure(_ context.Context, req

func (ds *subaccountServiceInstanceDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Gets details about a specific provisioned service instance such as its name, id, platform to which it belongs, the last operation performed, and more.`,
MarkdownDescription: `Gets details about a specific provisioned service instance, such as its name, id, platform to which it belongs, and the last operation performed.`,
Attributes: map[string]schema.Attribute{
"subaccount_id": schema.StringAttribute{
MarkdownDescription: "The ID of the subaccount.",
Expand Down Expand Up @@ -113,7 +113,7 @@ func (ds *subaccountServiceInstanceDataSource) Schema(_ context.Context, _ datas
ElementType: types.SetType{
ElemType: types.StringType,
},
MarkdownDescription: "Set of words or phrases assigned to the service instance.",
MarkdownDescription: "The set of words or phrases assigned to the service instance.",
Computed: true,
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (ds *subaccountServiceInstancesDataSource) Configure(_ context.Context, req

func (ds *subaccountServiceInstancesDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Gets all service instances in a subaccount.`,
MarkdownDescription: `Lists all service instances in a subaccount.`,
Attributes: map[string]schema.Attribute{
"subaccount_id": schema.StringAttribute{
MarkdownDescription: "The ID of the subaccount.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (ds *subaccountServiceOfferingDataSource) Configure(_ context.Context, req

func (ds *subaccountServiceOfferingDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Gets details about a specific service offering such as its ID, name, description, metadata, the associated service brokers, and more.`,
MarkdownDescription: `Gets details about a specific service offering such as its ID, name, description, metadata, and the associated service brokers.`,
Attributes: map[string]schema.Attribute{
"subaccount_id": schema.StringAttribute{
MarkdownDescription: "The ID of the subaccount.",
Expand Down
2 changes: 1 addition & 1 deletion internal/provider/datasource_subaccount_service_plan.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func (ds *subaccountServicePlanDataSource) Configure(_ context.Context, req data

func (ds *subaccountServicePlanDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Gets details about a specific service plan such as its name, description, metadata, and more.`,
MarkdownDescription: `Gets details about a specific service plan such as its name, description, and metadata.`,
Attributes: map[string]schema.Attribute{
"subaccount_id": schema.StringAttribute{
MarkdownDescription: "The ID of the subaccount.",
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_subaccount_subscription.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func (ds *subaccountSubscriptionDataSource) Configure(_ context.Context, req dat

func (ds *subaccountSubscriptionDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Gets the details of a specific multitenant application to which a subaccount is entitled to subscribe. If this application is in a different global account than the current one, you need to specify its plan with '--plan'.
MarkdownDescription: `Gets details of a specific multitenant application to which a subaccount is entitled to subscribe. If this application is in a different global account than the current one, you need to specify its plan with '--plan'.
__Tip:__
You must be assigned to the subaccount admin or viewer role.`,
Expand Down Expand Up @@ -159,7 +159,7 @@ You must be assigned to the subaccount admin or viewer role.`,
ElementType: types.SetType{
ElemType: types.StringType,
},
MarkdownDescription: "Set of words or phrases assigned to the multitenant application subscription.",
MarkdownDescription: "The set of words or phrases assigned to the multitenant application subscription.",
Computed: true,
},
},
Expand Down
4 changes: 2 additions & 2 deletions internal/provider/datasource_subaccount_subscriptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func (ds *subaccountSubscriptionsDataSource) Configure(_ context.Context, req da

func (ds *subaccountSubscriptionsDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: `Lists all the multitenant applications to which a subaccount is entitled to subscribe, including their subscription details.
MarkdownDescription: `Lists all multitenant applications to which the subaccount is entitled to subscribe, including their subscription details.
__Tip:__
You must be assigned to the subaccount admin or viewer role.`,
Expand Down Expand Up @@ -221,7 +221,7 @@ You must be assigned to the subaccount admin or viewer role.`,
ElementType: types.SetType{
ElemType: types.StringType,
},
MarkdownDescription: "Set of words or phrases assigned to the multitenant application subscription.",
MarkdownDescription: "The set of words or phrases assigned to the multitenant application subscription.",
Computed: true,
},
},
Expand Down
Loading

0 comments on commit f7f0b30

Please sign in to comment.