Skip to content

chore: Update service account related descriptions #1461

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

Open
JorTurFer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Update service account related descriptions #1461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/data-sources/service_account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "stackit_service_account Data Source - stackit"
subcategory: ""
description: |-
Service account data source schema.
Gets details about a STACKIT service account in a project by email.
---

# stackit_service_account (Data Source)

Service account data source schema.
Gets details about a STACKIT service account in a project by email.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/service_account_federated_identity_provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "stackit_service_account_federated_identity_provider Data Source - stackit"
subcategory: ""
description: |-
Service account federated identity provider schema.
Gets details about a federated identity provider configured for a STACKIT service account.
---

# stackit_service_account_federated_identity_provider (Data Source)

Service account federated identity provider schema.
Gets details about a federated identity provider configured for a STACKIT service account.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/service_accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "stackit_service_accounts Data Source - stackit"
subcategory: ""
description: |-
Service accounts plural data source schema. Returns a list of all service accounts in a project, optionally filtered.
Lists STACKIT service accounts in a project, optionally filtered by email.
---

# stackit_service_accounts (Data Source)

Service accounts plural data source schema. Returns a list of all service accounts in a project, optionally filtered.
Lists STACKIT service accounts in a project, optionally filtered by email.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/service_account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "stackit_service_account Resource - stackit"
subcategory: ""
description: |-
Service account resource schema.
Manages a STACKIT service account in a project.
---

# stackit_service_account (Resource)

Service account resource schema.
Manages a STACKIT service account in a project.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/service_account_federated_identity_provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "stackit_service_account_federated_identity_provider Resource - stackit"
subcategory: ""
description: |-
Service account federated identity provider schema.
Manages a federated identity provider for a STACKIT service account to enable workload identity federation.
Example Usage
Create a federated identity provider

Expand Down Expand Up @@ -35,7 +35,7 @@ description: |-

# stackit_service_account_federated_identity_provider (Resource)

Service account federated identity provider schema.
Manages a federated identity provider for a STACKIT service account to enable workload identity federation.
## Example Usage


Expand Down
4 changes: 2 additions & 2 deletions docs/resources/service_account_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "stackit_service_account_key Resource - stackit"
subcategory: ""
description: |-
Service account key schema.
Creates and manages a key for a STACKIT service account.
Example Usage
Automatically rotate service account keys

Expand All @@ -29,7 +29,7 @@ description: |-

# stackit_service_account_key (Resource)

Service account key schema.
Creates and manages a key for a STACKIT service account.
## Example Usage


Expand Down
4 changes: 2 additions & 2 deletions stackit/internal/services/serviceaccount/account/datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ func (r *serviceAccountDataSource) Schema(_ context.Context, _ datasource.Schema

// Define the schema with validation rules and descriptions for each attribute.
resp.Schema = schema.Schema{
MarkdownDescription: "Service account data source schema.",
Description: "Service account data source schema.",
MarkdownDescription: "Gets details about a STACKIT service account in a project by email.",
Description: "Gets details about a STACKIT service account in a project by email.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: descriptions["id"],
Expand Down
4 changes: 2 additions & 2 deletions stackit/internal/services/serviceaccount/account/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ func (r *serviceAccountResource) Schema(_ context.Context, _ resource.SchemaRequ
}

resp.Schema = schema.Schema{
MarkdownDescription: "Service account resource schema.",
Description: "Service account resource schema.",
MarkdownDescription: "Manages a STACKIT service account in a project.",
Description: "Manages a STACKIT service account in a project.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: descriptions["id"],
Expand Down
4 changes: 2 additions & 2 deletions stackit/internal/services/serviceaccount/accounts/datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ func (r *serviceAccountsDataSource) Metadata(_ context.Context, req datasource.M

func (r *serviceAccountsDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "Service accounts plural data source schema. Returns a list of all service accounts in a project, optionally filtered.",
Description: "Service accounts plural data source schema.",
MarkdownDescription: "Lists STACKIT service accounts in a project, optionally filtered by email.",
Description: "Lists STACKIT service accounts in a project, optionally filtered by email.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: "Terraform's internal resource ID, structured as \"`project_id`\".",
Expand Down
3 changes: 2 additions & 1 deletion stackit/internal/services/serviceaccount/federated_identity_provider/datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ func (r *serviceAccountFederatedIdentityProviderDatasource) Metadata(_ context.C

func (r *serviceAccountFederatedIdentityProviderDatasource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: descriptions["main"],
MarkdownDescription: "Gets details about a federated identity provider configured for a STACKIT service account.",
Description: "Gets details about a federated identity provider configured for a STACKIT service account.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
Expand Down
3 changes: 2 additions & 1 deletion stackit/internal/services/serviceaccount/federated_identity_provider/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ type AssertionModel struct {

var descriptions = map[string]string{
"id": "Terraform's internal resource identifier. It is structured as \"`project_id`,`service_account_email`,`federation_id`\".",
"main": "Service account federated identity provider schema.",
"main": "Manages a federated identity provider for a STACKIT service account to enable workload identity federation.",
"project_id": "The STACKIT project ID associated with the service account.",
"federation_id": "The unique identifier for the federated identity provider associated with the service account.",
"service_account_email": "The email address associated with the service account, used for account identification and communication.",
Expand All @@ -82,6 +82,7 @@ func (r *serviceAccountFederatedIdentityProviderResource) Metadata(_ context.Con
func (r *serviceAccountFederatedIdentityProviderResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: fmt.Sprintf("%s%s", descriptions["main"], markdownDescription),
Description: descriptions["main"],
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
Expand Down
2 changes: 1 addition & 1 deletion stackit/internal/services/serviceaccount/key/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func (r *serviceAccountKeyResource) Metadata(_ context.Context, req resource.Met
func (r *serviceAccountKeyResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
descriptions := map[string]string{
"id": "Terraform's internal resource identifier. It is structured as \"`project_id`,`service_account_email`,`key_id`\".",
"main": "Service account key schema.",
"main": "Creates and manages a key for a STACKIT service account.",
"project_id": "The STACKIT project ID associated with the service account key.",
"key_id": "The unique identifier for the key associated with the service account.",
"service_account_email": "The email address associated with the service account, used for account identification and communication.",
Expand Down
Loading