Skip to content

Commit

Permalink
docs: fix typo of principal type attribute description for resource d…
Browse files Browse the repository at this point in the history
…omain role assignment (#181)

# 📥 Pull Request

## ❓ What are you trying to address

Fix documentation typo of principal type attribute description for
resource domain_role_assignment.

## ✨ Description of new changes

- Write a detailed description of all changes and, if appropriate, why
they are needed.

## ☑️ PR Checklist

- [ ] Link to the issue you are addressing is included above
- [x] Ensure the PR description clearly describes the feature you're
adding and any known limitations

## ☑️ Resources / Data Sources Checklist

PRs for new/enhanced resources or data sources are expected to meet the
following criteria:

- [ ] Production quality implementation of the resource or data-source
in [./internal/services](./internal/services)
- [ ] Unit Tests and Acceptance Tests for your contribution in
[./internal/services/<service_name>](./internal/services)
  - [ ] Tests should pass and provide >80% coverage of your contribution
- [ ] Examples for your contribution in [./examples](./examples) (see
[Terraform Documentation on
examples](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation#add-configuration-examples))
- [ ] [Schema
descriptions](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation#add-schema-descriptions)
for your resource or data-source in
[./internal/services](./internal/services)
- [ ] Docs templates in [./templates](./templates)
- [ ] Updated auto-generated documentation in [./docs](./docs). (DO NOT
manually edit [./docs](./docs) - your updates will be overwritten)
  • Loading branch information
badeamarjieh authored Jan 6, 2025
1 parent d68ad26 commit 5578a67
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/resources/domain_role_assignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ resource "fabric_domain_role_assignments" "example" {
Required:

- `id` (String) The Principal ID. Changing this forces a new resource to be created.
- `type` (String) ThePrincipal type. Accepted values: `Group`, `User`. Changing this forces a new resource to be created.
- `type` (String) The Principal type. Accepted values: `Group`, `User`. Changing this forces a new resource to be created.

<a id="nestedatt--timeouts"></a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func (r *resourceDomainRoleAssignments) Schema(ctx context.Context, _ resource.S
CustomType: customtypes.UUIDType{},
},
"type": schema.StringAttribute{
MarkdownDescription: "ThePrincipal type. Accepted values: " + utils.ConvertStringSlicesToString(possiblePrincipalTypeValues, true, true) + ". " + common.DocsRequiresReplace,
MarkdownDescription: "The Principal type. Accepted values: " + utils.ConvertStringSlicesToString(possiblePrincipalTypeValues, true, true) + ". " + common.DocsRequiresReplace,
Required: true,
Validators: []validator.String{
stringvalidator.OneOf(utils.ConvertEnumsToStringSlices(possiblePrincipalTypeValues, false)...),
Expand Down

0 comments on commit 5578a67

Please sign in to comment.