docs(event_handlers): new data validation and OpenAPI feature

[rubenfonseca]

Issue number: #3324

Summary

Changes

Please provide a summary of what's being changed

This PR adds documentation for the validation and OpenAPI features.

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Todo list

•  separate validation documents and include them as part of the REST API docs
• rebase the changes with develop

[heitorlessa]

Adding here to more easily orient progress

• Extract data validation and move under Getting Started
  • Install section
  • Explain how to use it
  • Explain Payload data validation
  • Explain validation errors
    • Demonstrate standard validation error
    • Override validation errors
  • Explain Query string data validation
  • Explain Path data validation
• Extract Swagger UI and move under Getting Started
• Extract OpenAPI to Advanced
• Extract OpenAPI parameters
• Confirm whether we can make Swagger UI dynamic routes param work with our <param>
• Test code snippets with real deployment
• Extract embed=True and create a new section altogether
• List out what features don't work with data validation for update
• Convert snippets to use REST Resolver instead of HTTP
  • Resolver name
  • Input
  • Output
• Update key features section
• [ ] Move back OpenAPI to their specific section
  • Improve intro
  • Link back to data validation section
  • Revisit examples

[heitorlessa]

adding Swagger UI routes in getting started template that I forgot 🤦🏻

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (89a92b7) 95.41% compared to head (345fd0b) 95.39%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3386      +/-   ##
===========================================
- Coverage    95.41%   95.39%   -0.03%     
===========================================
  Files          209      209              
  Lines         9648     9648              
  Branches      1770      809     -961     
===========================================
- Hits          9206     9204       -2     
- Misses         329      330       +1     
- Partials       113      114       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.