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(openapi): Allow values of any type in the examples of the Schema Object. #5575

Merged
merged 5 commits into from
Nov 19, 2024

Conversation

tonsho
Copy link
Contributor

@tonsho tonsho commented Nov 17, 2024

Issue number: #5573

Summary

Changes

Allow values of any type in the examples of the Schema Object.

User experience

Enable proper definition of examples in the Schema Object.

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.

Copy link

boring-cyborg bot commented Nov 17, 2024

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 17, 2024
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @tonsho! Thank you so much for this PR, you were super quick!

I just left a quick comment before we merge this.

@github-actions github-actions bot added the bug Something isn't working label Nov 17, 2024
Copy link

codecov bot commented Nov 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.16%. Comparing base (5426a7a) to head (e850444).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #5575   +/-   ##
========================================
  Coverage    96.16%   96.16%           
========================================
  Files          229      229           
  Lines        10836    10836           
  Branches      2015     2015           
========================================
  Hits         10420    10420           
  Misses         327      327           
  Partials        89       89           

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


🚨 Try these New Features:

@tonsho tonsho force-pushed the fix/openapi-examples branch from 6424392 to 372b7d2 Compare November 18, 2024 14:04
@tonsho tonsho changed the title fix(openapi): Allow values of any type in the examples of the Parameter Object. fix(openapi): Allow values of any type in the examples of the Schema Object. Nov 18, 2024
@leandrodamascena leandrodamascena self-assigned this Nov 19, 2024
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this and reporting a new error @tonsho!

APPROVED!

@sthulb sthulb merged commit 41ca97b into aws-powertools:develop Nov 19, 2024
12 checks passed
Copy link

boring-cyborg bot commented Nov 19, 2024

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working event_handlers size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Cannot provide examples of values other than str in the Schema examples for SwaggerUI
3 participants