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

Major schema changes not reported in 3.7.0 changelog #5493

Closed
5 of 6 tasks
mattjegan opened this issue Oct 11, 2017 · 2 comments · Fixed by #5501
Closed
5 of 6 tasks

Major schema changes not reported in 3.7.0 changelog #5493

mattjegan opened this issue Oct 11, 2017 · 2 comments · Fixed by #5501

Comments

@mattjegan
Copy link
Contributor

Checklist

  • I have verified that that issue exists against the master branch of Django REST framework.
  • I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
  • This is not a usage question. (Those should be directed to the discussion group instead.)
  • This cannot be dealt with as a third party library. (We prefer new functionality to be in the form of third party libraries where possible.)
  • I have reduced the issue to the simplest possible case.
  • I have included a failing test as a pull request. (If you are unable to do so we can still accept the issue.)

Steps to reproduce

Expected behavior

Ideally, there would be an entry noting a breaking change on something like SchemaGenerator().get_serializer_fields(...) since it is now a part of AutoSchema. For my use case I went from:

generator = SchemaGenerator()
return generator.get_serializer_fields('/', 'POST', view)

to

generator = AutoSchema()
generator.view = view
return generator.get_serializer_fields('/', 'POST')

however I needed to go through the issue tracker and recent PRs to find that this was the solution.

Actual behavior

The changelog should have a correct reference to the breaking change and the solution to fix it.

Also, thanks for the awesome work you guys do! 😄

@carltongibson
Copy link
Collaborator

Hmmm yes. It’s in the release announcement, but this is a an oversight.

I obviously forgot that bit.

I’d take a PR here. 👍🏽

And, you’re welcome.

@mattjegan
Copy link
Contributor Author

No worries, I'll make a PR when I get a chance, probably a couple days away.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants