Skip to content

docs(event_handlers): new data validation and OpenAPI feature#3386

Merged
rubenfonseca merged 37 commits intodevelopfrom
rf/openapi-docs
Nov 23, 2023
Merged

docs(event_handlers): new data validation and OpenAPI feature#3386
rubenfonseca merged 37 commits intodevelopfrom
rf/openapi-docs

Conversation

@rubenfonseca
Copy link
Copy Markdown
Contributor

@rubenfonseca rubenfonseca commented Nov 21, 2023 •
edited
Loading

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

image

Checklist

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

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

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Nov 21, 2023
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Nov 21, 2023
@rubenfonseca rubenfonseca linked an issue Nov 21, 2023 that may be closed by this pull request
Docs: New Data validation for Event Handler REST #3324
Closed
1 task
@rubenfonseca rubenfonseca marked this pull request as ready for review November 22, 2023 08:46
@rubenfonseca rubenfonseca requested a review from a team November 22, 2023 08:46
@heitorlessa
Copy link
Copy Markdown
Contributor

heitorlessa commented Nov 22, 2023 •
edited
Loading

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 and others added 20 commits November 22, 2023 12:29
@heitorlessa
docs(apigateway): add install section for new data validation feat
b5f438c 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs(apigateway): add new data validation section
d78bfc3 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs(apigateway): improve wording to emphasize validation error
ffb6c0e 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs: improve data validation example using a DTO
a7f9662
@heitorlessa
docs: add handling validation errors section
26cf7c0 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs: bring validation errors pydantic upfront to discuss later
3c741d8
@heitorlessa
docs: add initial validating payloads section
3beb9c4 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs(apigateway): complete catching validation errors
9513959 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs: correct validating payload output filename
3e8347b 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
fix: restore file name in older location
4db84ab
@rubenfonseca
chore: move first example to REST API
b4a8fe8
@rubenfonseca
chore: rewrote the other examples
47f3894
@heitorlessa
docs: add validating query strings section
5c55490 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs: improve examples with list type inference
7e382e0 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs: add path validation section
0ccfc2c
@heitorlessa
docs: add missing highlight for path validation
b611700
@heitorlessa
docs: document how to inject query strings w/o validation
bb404fc 
Signed-off-by: heitorlessa <[email protected]>
@rubenfonseca
chore: add query strings to Param, Path and Query
2caa5b1
@heitorlessa
docs: add OpenAPI and Swagger UI advanced
e5bbc0a 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
docs: add openapi parameters section
f052551 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa
Copy link
Copy Markdown
Contributor

heitorlessa commented Nov 23, 2023

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

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Nov 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 23, 2023 •
edited
Loading

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.

@heitorlessa heitorlessa changed the title chore(docs): added validation and OpenAPI docs docs(event_handlers): new data validation and OpenAPI feature Nov 23, 2023
@rubenfonseca rubenfonseca merged commit 765781c into develop Nov 23, 2023
@rubenfonseca rubenfonseca deleted the rf/openapi-docs branch November 23, 2023 13:47
@rubenfonseca rubenfonseca mentioned this pull request Nov 23, 2023
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@heitorlessa heitorlessa heitorlessa approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation event_handlers size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: New Data validation for Event Handler REST

3 participants

@rubenfonseca @heitorlessa @codecov-commenter