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.

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

r/aws_lexv2models_slot_type: fix audio_recognition_strategy argument name #39254

Merged
merged 4 commits into from
Sep 10, 2024

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Sep 10, 2024

Description

Previously this nested argument was misnamed audio_recognition_settings. If the correct name was provided, Terraform would fail indicating the argument name did not exist.

│ Error: Unsupported argument
│
│   on main.tf line 71, in resource "aws_lexv2models_slot_type" "test":
│   71:       audio_recognition_strategy = "UseSlotValuesAsCustomVocabulary"
│
│ An argument named "audio_recognition_strategy" is not expected here.

If the incorrect name was provided, creation would fail as AutoFlex would be unable to write the result from the AWS data structure back to the Terraform data structure due to the mismatch in field names.

aws_lexv2models_slot_type.test: Creating...
╷
│ Error: Provider produced inconsistent result after apply
│
│ When applying changes to aws_lexv2models_slot_type.test, provider "provider[\"registry.terraform.io/hashicorp/aws\"]" produced an unexpected new value:
│ .value_selection_setting[0].advanced_recognition_setting[0].audio_recognition_setting: was cty.StringVal("UseSlotValuesAsCustomVocabulary"), but now null.
│
│ This is a bug in the provider, which should be reported in the provider's own issue tracker.

As such, this technically breaking change to the schema definition is deemed acceptable within a minor release.

Also fixes various issues with the registry documentation for aws_lexv2models_slot_type and adds a new example.

Relations

Closes #39246
Closes #39247 (documentation changes incorporated into this PR)

References

Output from Acceptance Testing

% make testacc PKG=lexv2models TESTS=TestAccLexV2ModelsSlotType_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.23.0 test ./internal/service/lexv2models/... -v -count 1 -parallel 20 -run='TestAccLexV2ModelsSlotType_'  -timeout 360m

--- PASS: TestAccLexV2ModelsSlotType_values (42.82s)
--- PASS: TestAccLexV2ModelsSlotType_valueSelectionSetting (44.74s)
--- PASS: TestAccLexV2ModelsSlotType_disappears (45.08s)
--- PASS: TestAccLexV2ModelsSlotType_basic (50.91s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/lexv2models        56.975s

Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added documentation Introduces or discusses updates to documentation. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. service/lexv2models Issues and PRs that pertain to the lexv2models service. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. labels Sep 10, 2024
@jar-b jar-b added the breaking-change Introduces a breaking change in current functionality; usually deferred to the next major release. label Sep 10, 2024
…t name

Previously this nested argument was misnamed `audio_recognition_settings`. If the correct name was provided, Terraform would fail indicating the argument name did not exist.

```
│ Error: Unsupported argument
│
│   on main.tf line 71, in resource "aws_lexv2models_slot_type" "test":
│   71:       audio_recognition_strategy = "UseSlotValuesAsCustomVocabulary"
│
│ An argument named "audio_recognition_strategy" is not expected here.
```

If the incorrect name was provided, creation would fail as AutoFlex would be unable to write the result from the AWS data structure back to the Terraform data structure due to the mismatch in field names.

```
aws_lexv2models_slot_type.test: Creating...
╷
│ Error: Provider produced inconsistent result after apply
│
│ When applying changes to aws_lexv2models_slot_type.test, provider "provider[\"registry.terraform.io/hashicorp/aws\"]" produced an unexpected new value:
│ .value_selection_setting[0].advanced_recognition_setting[0].audio_recognition_setting: was cty.StringVal("UseSlotValuesAsCustomVocabulary"), but now null.
│
│ This is a bug in the provider, which should be reported in the provider's own issue tracker.
```

As such, this technically breaking change to the schema definition is deemed acceptable within a minor release.

```console
% make testacc PKG=lexv2models TESTS=TestAccLexV2ModelsSlotType_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.23.0 test ./internal/service/lexv2models/... -v -count 1 -parallel 20 -run='TestAccLexV2ModelsSlotType_'  -timeout 360m

--- PASS: TestAccLexV2ModelsSlotType_values (42.82s)
--- PASS: TestAccLexV2ModelsSlotType_valueSelectionSetting (44.74s)
--- PASS: TestAccLexV2ModelsSlotType_disappears (45.08s)
--- PASS: TestAccLexV2ModelsSlotType_basic (50.91s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/lexv2models        56.975s
```
@jar-b jar-b marked this pull request as ready for review September 10, 2024 18:54
@jar-b jar-b requested a review from a team as a code owner September 10, 2024 18:54
Copy link
Member

@YakDriver YakDriver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🎉

@jar-b jar-b merged commit be13791 into main Sep 10, 2024
53 checks passed
@jar-b jar-b deleted the b-lexv2models-slot-type branch September 10, 2024 19:54
@github-actions github-actions bot added this to the v5.67.0 milestone Sep 10, 2024
terraform-aws-provider bot pushed a commit that referenced this pull request Sep 10, 2024
Copy link

This functionality has been released in v5.67.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions github-actions bot removed the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Sep 13, 2024
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking-change Introduces a breaking change in current functionality; usually deferred to the next major release. documentation Introduces or discusses updates to documentation. service/lexv2models Issues and PRs that pertain to the lexv2models service. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: r/aws_lexv2models_slot_type: audio_recognition_strategy cannot be set
2 participants