feat: Add support for the FailOnWarnings property on AWS::Serverless::Api

[nialdaly]

Issue

• This PR attempts to close Feature request: Support FailOnWarnings for AWS::Serverless::Api #2402.

Description of changes:

Description of how you validated changes:

Checklist:

• Add/update unit tests using:
  • Correct values
  • Bad/wrong values (None, empty, wrong type, length, etc.)
  • Intrinsic Functions
• Add/update integration tests
• make pr passes
• Update documentation
• Verify transformed template deploys and application functions as expected

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[codecov-commenter]

Codecov Report

Merging #2417 (3e88c04) into develop (e7a1496) will increase coverage by 0.85%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #2417      +/-   ##
===========================================
+ Coverage    93.58%   94.44%   +0.85%     
===========================================
  Files           90       98       +8     
  Lines         6124     7269    +1145     
  Branches      1260     1512     +252     
===========================================
+ Hits          5731     6865    +1134     
- Misses         183      195      +12     
+ Partials       210      209       -1     

Impacted Files	Coverage Δ
samtranslator/region_configuration.py	77.77% <0.00%> (-22.23%)	⬇️
samtranslator/model/codedeploy.py	90.90% <0.00%> (-9.10%)	⬇️
samtranslator/validator/validator.py	91.80% <0.00%> (-3.85%)	⬇️
samtranslator/model/exceptions.py	97.67% <0.00%> (-2.33%)	⬇️
samtranslator/open_api/open_api.py	90.16% <0.00%> (-1.81%)	⬇️
samtranslator/model/s3_utils/uri_parser.py	68.42% <0.00%> (-0.81%)	⬇️
samtranslator/yaml_helper.py	89.47% <0.00%> (-0.53%)	⬇️
samtranslator/translator/logical_id_generator.py	90.62% <0.00%> (-0.29%)	⬇️
samtranslator/model/api/api_generator.py	94.11% <0.00%> (-0.25%)	⬇️
samtranslator/model/apigateway.py	96.98% <0.00%> (-0.18%)	⬇️
... and 46 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 30f206a...3e88c04. Read the comment docs.

[mildaniel]

Hi @nialdaly, thank you for submitting a pull request! Can you please add unit and integration tests to your PR so that we can validate these changes and guard against regressions in the future.

[nialdaly]

No problem! @mildaniel Sorry I forgot to put a comment here. I'm unsure on how to generate an API creation warning to ensure that the rollback occurs with FailOnWarnings: true as described in the documentation. Would you have any advice on that?

[hawflau]

I'm unsure on how to generate an API creation warning to ensure that the rollback occurs with FailOnWarnings: true as described in the documentation.

@nialdaly, sorry I don't quite get what you mean. If you want to make sure a stack/API gets rollback due to "FailOnWarnings: true", this has to been done when the stack is being deployed. SAM Transform happens before the stack is deployed.

[hawflau]

Overall LGTM. Just one comment. And thanks for your contribution!

[mndeveci]

Thanks for your contribution, looks good to me as well!