Skip to content

Conversation

Viicos
Copy link
Member

@Viicos Viicos commented Aug 19, 2024

Add the necessary deprecation and user warnings
Update tests

Fixes #8732

Change Summary

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Add the necessary deprecation and user warnings
Update tests
@github-actions github-actions bot added the relnotes-fix Used for bugfixes. label Aug 19, 2024
Copy link

cloudflare-workers-and-pages bot commented Aug 19, 2024

Deploying pydantic-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 28dae6b
Status: ✅  Deploy successful!
Preview URL: https://5d85676f.pydantic-docs.pages.dev
Branch Preview URL: https://json-schema-examples.pydantic-docs.pages.dev

View logs

Copy link
Contributor

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Looks great, just one change request. Thanks!

Comment on lines 2453 to 2457
warnings.warn(
'Updating existing JSON Schema examples of type dict with examples of type list. '
'Only the existing examples values will be retained.',
UserWarning,
)
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's warn here (and on the next one) that dict is deprecated as well - I realize this will be raised in a separate warning, but I think it makes sense to reiterate in this one.

Copy link

codspeed-hq bot commented Aug 19, 2024

CodSpeed Performance Report

Merging #10181 will not alter performance

Comparing json-schema-examples (28dae6b) with main (782b0cf)

Summary

✅ 17 untouched benchmarks

@sydney-runkle sydney-runkle added relnotes-change Used for changes to existing functionality which don't have a better categorization. and removed relnotes-fix Used for bugfixes. labels Aug 19, 2024
@sydney-runkle
Copy link
Contributor

Great, go ahead and merge when you're ready 👍

Copy link
Contributor

github-actions bot commented Aug 19, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

@Viicos Viicos enabled auto-merge (squash) August 20, 2024 06:08
@Viicos Viicos merged commit f6f1264 into main Aug 20, 2024
59 checks passed
@Viicos Viicos deleted the json-schema-examples branch August 20, 2024 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes-change Used for changes to existing functionality which don't have a better categorization.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Type of examples parameter is not checked, which may lead to invalid JSON schema generation
2 participants