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

Consider pinning drf-yasg in setup.py install_requires #40

Open
kdmccormick opened this issue May 20, 2020 · 0 comments
Open

Consider pinning drf-yasg in setup.py install_requires #40

kdmccormick opened this issue May 20, 2020 · 0 comments

Comments

@kdmccormick
Copy link
Member

Different versions of drf-yasg may break or change the behavior of api-doc-tools.

Thus, if drf-yasg is upgraded in a service, it may seem like api-doc-tools changed, even if that package's version did not change.

I recommend that we require a specific version of drf-yasg as an installation requirement of edx-api-doc-tools. Ideally, this pin could be continuously updated by make upgrade PRs in this repo.

As far as I know, no edX repository other than this one directly depends on drf-yasg, so we shouldn't see issues with conflicting version constraints.

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

No branches or pull requests

1 participant