Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7k
Drop coreapi support for DRF 3.17#9583
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
951c960 toe8c0236CompareTGoddessana commentedMar 21, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Question while working with PR. Thedocumentation says: “Support for generating default schemas will be moved to a separate package and then removed”. For this PR, should we remove coreapi and everything related to it, or all code related to the whole If you need to remove everything related to schemas from the |
TGoddessana commentedMar 30, 2025
@auvipy I'm sorry if the tags are annoying. But this is the only place we can make design decisions about PR, and I'd love to hear your thoughts on what I should do.. |
auvipy commentedApr 16, 2025
yes please fix the merge conflicts as we have to remove it |
14956c8 tod43bae2CompareTGoddessana commentedJun 3, 2025
I guess this is where we need to make a decision on where we stop supporting it... For example, should we remove all schema-related references in rest_framework.settings since schema generation will stop? The documentation certainly mentions that we will be removing API documentation, but I'm confused if removing all code like |
TGoddessana commentedJun 3, 2025
browniebroke commentedAug 10, 2025
That's a big one! I didn't expect to see some much code deleted, but I can see there was a lot of tests...
Would be interesting to see what drf-spectacular or drf-yasg are using to hook into DRF, and make sure we don't break their integration point. Might be a good idea to coordinate this with them. |
e9b4d76 to30c338aCompareTGoddessana commentedSep 21, 2025
Alright, I think it's best to restart the PR, so I've reverted the commit. Both packages directly depend on this part of rest_framework. Let's see this.. (Some parts of this content were generated using AI. :) I think it's a really useful tool for situations like this. But basically, I found and verified all the code references myself.) drf-spectacularEssential Components to Maintain
Components Safe to Remove
Critical Interfaces to Preserve
drf-yasgEssential Components to Maintain
Components Safe to Remove
Critical Interfaces to Preserve
Key Differences from drf-spectacular
|
TGoddessana commentedSep 21, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
In my view, there are two possible approaches:
From a maintenance perspective, I tend to favor Option 1 (removing all schema-related code). The deprecation of |
TGoddessana commentedSep 27, 2025
drf-spectacular directly uses these items from the existing DRF's As long as DRF does not participate in schema creation, could removing the |
30c338a tod635fe8Comparebrowniebroke commentedOct 29, 2025
Sorry about the lack of feedback here, I'm not too sure how to get this one across the line without breaking other documentation packages like drf-spectacular, and will need some time to understand that. We are aiming to move the project to@django-commons on Friday and as part of the move, we're planning to do a release. With the list of unreleased changes on main, we will have to bump the minor digit to 3.17, but realistically this PR won't make the cut. Would you be interested in sending a pull request to update the deprecation warning from 3.17 to 3.18? feel free to say no if you won't have time... Thanks! |
browniebroke commentedOct 30, 2025
As this is a bit time sensitive, I've done it in#9810 Let's go back to this once it's merged. Thanks for your patience. |
auvipy commentedOct 30, 2025
lets wait until 3.18 |
TGoddessana commentedNov 7, 2025
I apologize for the delayed response. I've been personally busy and going through a difficult time. Thank you for working on the package. As you suggested, I think it would be best to consider up to version 3.18. As mentioned, I think the cleanest approach is to remove all schema-related code (packages, tests). It won't be easy to maintain the code without breaking the integration points for both packages ( |

Description
refs#8453
As discussed in#8453, we are deprecating the coreapi for drf 3.17.
I read the discussion in detail, and I'm wondering if it was decided to “leave all schema generation logic in the library that generates the schema (drf-spectacular), and drf will not be involved in schema generation” (drf-spectacular will be part of drf?) The comments in the linked discussion say that...