strawberry
strawberry copied to clipboard
Deprecate Chalice's `render_graphiql` parameter by adding a warning
Deprecate the parameter render_graphiql
in favour of graphiql
in Chalice view.
Description
Chalice's view is the only one with a different parameter name for enabling/disabling graphiql. Would like to uniform to the others.
Types of Changes
- [ ] Core
- [ ] Bugfix
- [ ] New feature
- [x] Enhancement/optimization
- [ ] Documentation
Issues Fixed or Closed by This PR
Checklist
- [x My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I have read the CONTRIBUTING document.
- [x] I have added tests to cover my changes.
- [x] I have tested the changes and verified that they work and don't break anything (as well as I can manage).
Codecov Report
Merging #1587 (e181cd0) into main (430ebd9) will decrease coverage by
0.06%
. The diff coverage is100.00%
.
@@ Coverage Diff @@
## main #1587 +/- ##
==========================================
- Coverage 98.21% 98.15% -0.07%
==========================================
Files 130 139 +9
Lines 4594 5257 +663
Branches 794 956 +162
==========================================
+ Hits 4512 5160 +648
- Misses 43 52 +9
- Partials 39 45 +6
Thanks for adding the RELEASE.md
file!
Here's a preview of the changelog:
With this release in Chalice's GraphQLView
the parameter render_graphiql
is now
deprecated and has been replaced with graphiql
. It will be removed in releases of
Strawberry made after 2022-07-13.
Here's the preview release card for twitter:
Here's the tweet text:
🆕 Release (next) is out! Thanks to @esterbeltrami for the PR 👏
Get it here 👉 https://github.com/strawberry-graphql/strawberry/releases/tag/(next)
Just occurred to me that we should also probably adjust the removal date to be one month after PR close before we merge this, so that users actually get a full month of deprecation.
ah, sorry I forgot about this PR!