Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(event_handler): fix format for OpenAPI path templating #3399

Merged
merged 1 commit into from
Nov 22, 2023

Conversation

rubenfonseca
Copy link
Contributor

@rubenfonseca rubenfonseca commented Nov 22, 2023

Issue number: #3398

Summary

Changes

Please provide a summary of what's being changed

This PR makes the OpenAPI generation return the proper path templating format expected by consumers.

User experience

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

After this change, standard tooling (e.g: Swagger UI) will be able to understand path parameters.

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.

@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 22, 2023
@rubenfonseca rubenfonseca added this to the OpenAPI in Event Handler milestone Nov 22, 2023
@rubenfonseca rubenfonseca linked an issue Nov 22, 2023 that may be closed by this pull request
Copy link

sonarcloud bot commented Nov 22, 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

@rubenfonseca rubenfonseca changed the title fix(event_handler): replace <> with {} when generating OpenAPI specs fix(event_handler): fix format for OpenAPI path templating Nov 22, 2023
@rubenfonseca rubenfonseca marked this pull request as ready for review November 22, 2023 20:30
@rubenfonseca rubenfonseca requested a review from a team as a code owner November 22, 2023 20:30
@codecov-commenter
Copy link

codecov-commenter commented Nov 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0cc687a) 95.41% compared to head (ff7f545) 95.41%.

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

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3399   +/-   ##
========================================
  Coverage    95.41%   95.41%           
========================================
  Files          209      209           
  Lines         9646     9647    +1     
  Branches      1768     1769    +1     
========================================
+ Hits          9204     9205    +1     
  Misses         329      329           
  Partials       113      113           

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

@heitorlessa heitorlessa merged commit 9f59374 into develop Nov 22, 2023
26 checks passed
@heitorlessa heitorlessa deleted the rf/fix-openapi-path-template branch November 22, 2023 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
event_handlers size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: OpenAPI generation doesn't follow Path templating specs
3 participants