Skip to content

Removed built-in OpenAPI support #1288

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

Merged
merged 2 commits into from
Jul 21, 2025
Merged

Conversation

sliverc
Copy link
Member

@sliverc sliverc commented Jul 18, 2025

Description of the Change

Planning a new major release 8.0.0 I thought it is time to also remove built-in OpenAPI support as it has been deprecated for quite a while now and it also does not work with the newest django-filter version anymore.

In case there are any concerns removing it please let me know.

Checklist

  • PR only contains one change (considered splitting up PR)
  • unit-test added
  • documentation updated
  • CHANGELOG.md updated (only for user relevant changes)
  • author name in AUTHORS

@sliverc sliverc requested a review from n2ygk July 18, 2025 13:20
@sliverc
Copy link
Member Author

sliverc commented Jul 19, 2025

@n2ygk Just saw that I missed removing some code, pushed that now. In case you consider this for merging, could you also test in an actual project that schema generation still works with drf-spectacular-json-api and these changes?
I do not have an actual project, so won't be able to check on that.

@n2ygk
Copy link
Contributor

n2ygk commented Jul 21, 2025

@n2ygk Just saw that I missed removing some code, pushed that now. In case you consider this for merging, could you also test in an actual project that schema generation still works with drf-spectacular-json-api and these changes? I do not have an actual project, so won't be able to check on that.

Looks like breaking changes to setuptools that I have to resolve first... It has to do with setuptools no longer accepting local filesystem paths.

Tested locally without using tox and it looks good.

Copy link
Contributor

@n2ygk n2ygk left a comment

Choose a reason for hiding this comment

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

Looks good. I tested my demo project to confirm that nothing breaks.

Not sure if we want to document the new way using drf-spectacular-jsonapi but that is certainly appropriate for a separate documentation PR if deemed useful.

@n2ygk n2ygk merged commit e9a7f5f into django-json-api:main Jul 21, 2025
9 checks passed
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 this pull request may close these issues.

2 participants