Skip to content

docs: update invoke_api argument documentation - #49199

Open
cokerrd wants to merge 1 commit into
hashicorp:mainfrom
cokerrd:d-fix_apigatewayv2_routing_rule_invoke_api
Open

docs: update invoke_api argument documentation#49199
cokerrd wants to merge 1 commit into
hashicorp:mainfrom
cokerrd:d-fix_apigatewayv2_routing_rule_invoke_api

Conversation

@cokerrd

@cokerrd cokerrd commented Jul 30, 2026

Copy link
Copy Markdown

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the library.

Changes to Security Controls

No changes to security controls.

Description

Updates invoke_api block documentation to correct argument descriptions and defaults.

  • Clarified api_id description
  • Corrected stage description from duplicate "Action to invoke a stage" to "Name of the target stage"
  • Changed strip_base_path from (Required) to (Optional) with default value of false

Relations

Closes #49160

References

  • Cloudformation - Descriptions are present for the InvokeApi properties in the cloudformation documentation
  • construct hub - Shows the default value for the strip_base_path property

Output from Acceptance Testing

Not applicable. Only documentation is updated.

@cokerrd
cokerrd requested a review from a team as a code owner July 30, 2026 11:10
@github-actions

Copy link
Copy Markdown
Contributor

Community Guidelines

This comment is added to every new Pull Request to provide quick reference to how the Terraform AWS Provider is maintained. Please review the information below, and thank you for contributing to the community that keeps the provider thriving! 🚀

Voting for Prioritization

  • Please vote on this Pull Request by adding a 👍 reaction to the original post to help the community and maintainers prioritize it.
  • Please see our prioritization guide for additional information on how the maintainers handle prioritization.
  • Please do not leave +1 or other comments that do not add relevant new information or questions; they generate extra noise for others following the Pull Request and do not help prioritize the request.

Pull Request Authors

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • 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 needs-triage Waiting for first response or review from a maintainer. documentation Introduces or discusses updates to documentation. service/apigatewayv2 Issues and PRs that pertain to the apigatewayv2 service. size/XS Managed by automation to categorize the size of a PR. labels Jul 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Introduces or discusses updates to documentation. needs-triage Waiting for first response or review from a maintainer. service/apigatewayv2 Issues and PRs that pertain to the apigatewayv2 service. size/XS Managed by automation to categorize the size of a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AWS API Gateway V2 Routing Rule - Poor documentation

1 participant