[apigateway] does not detect addPropertyOverride changes for deployment hash

[mhart]

Using addPropertyOverride on API properties, such as auth, fails to result in new API Gateway Deployments – likely due to these changes not being picked up by the hashing mechanism.

Reproduction Steps

1. Deploy a stack with a LambdaRestApi with deploy set to true (the default)
2. Modify an API method using addPropertyOverride – for example in the manner suggested here: defaultMethodOptions should be selectively applied to CORS OPTIONS method #8615 (comment)
3. Update the stack
4. Observe that a new Deployment has not been created – so the changes to the API remain undeployed.

Other

If this is deemed out of scope for addPropertyOverride modifications (which may make sense if they're too hard to use in the hashing mechanism), then at least the documentation should be updated to mention that you may need to manually take action for scenarios like auto-deployments.

Also when addPropertyOverride is mentioned as a potential solution to a problem in the issue tracker / forum, it would be good to add this caveat (and any other apis that may be affected by using addPropertyOverride).

---

This is 🐛 Bug Report

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.