Update or replace django-rest-swagger

[Jawayria]

We use the package django-rest-swagger in edx/course-discovery, edx/credentials, edx/demographics, edx/django-user-tasks, edx/ecommerce, edx/edx-analytics-data-api, edx/edx-notes-api, edx/enterprise-catalog, edx/license-manager, edx/portal-designer, edx/video-encode-manager. It hasn't yet added support for Django3.2. Please follow the guidance in https://openedx.atlassian.net/wiki/spaces/AC/pages/3036972032/Handling+Outdated+Dependencies to resolve the problem this poses for the Open edX Django 3.2 upgrade.

[NeOneSoft]

Hi @natabene, I would like to work in this issue if it's already available!! Thank you so much !!

[jmbowman]

I think she's still out for another day or two, but I can go ahead and assign it to you. Thanks for looking into this!

[NeOneSoft]

Hi @jmbowman !!!, Thank you so much for your support and I'll be working on!!!

[NeOneSoft]

Hi @jmbowman, django rest swagger is deprecated so as they mentioned in the repo, we can use drf-yasg, in fact we already using it and I ran the tests for Django3.2 successfully. I already created the PR for https://github.com/axnsan12/drf-yasg and waiting to be merged.

[natabene]

Thanks for an update, @NeOneSoft

[NeOneSoft]

Hi @natabene I suggest to keep using https://github.com/axnsan12/drf-yasg since tests were ran successfully for Django 3.2 even tough this is not mentioned in the repo and I could not contact with the maintainer yet>

[natabene]

@Jawayria Please let me know what you think.

[jmbowman]

It looks like there was a maintainer transition last year, although it sounds like it's still hard to get maintainer attention. Maybe create a new issue asking if more help is wanted to get the next release out with Django 3.2 support and/or if a move to Jazzband would be appropriate? In the meantime, it sounds like the only blocker for our Django 3.2 upgrade is finishing the switch from django-rest-swagger to drf-yasg. It sounds like we need to do this in multiple repos; @NeOneSoft , are you up for creating some PRs to kick off that effort?

[NeOneSoft]

Hi @jmbowman thank you for your response, I'm agree with you to switch django-rest-swagger to drf yasg so I'll be working with eduNEXT team to kick-off this effort and share updates or ask for help if we need it!!

[NeOneSoft]

Hi @jmbowman!!, we are wondering if its necessary to use https://github.com/edx/api-doc-tools in order to switch the repos to
drf-ysg or it could be done by simply do it directly in each repo. Thank you so much!!

[natabene]

@nedbat Could you help us out here? @jmbowman said you would have a better idea about this.

[NeOneSoft]

Hi @natabene @nedbat !!!,regarding to my last comment, do we have any update or suggestion to continue with this effort. Thank you so much!!! = )

[nedbat]

I'm looking at this now. Here is @NeOneSoft 's PR for drf-yasg adding Django 3.2 support: axnsan12/drf-yasg#735

[nedbat]

@NeOneSoft You don't have to switch the repos to using api-doc-tools. It would be nice to have all the repos using the same docs foundation, but api-doc-tools only generates docs for "/api" by default, so it might be more work than we want to take on right now to also move to api-doc-tools.

[NeOneSoft]

Thank you so much @nedbat !!!Yes the upgrade was done on axnsan12/drf-yasg#735 so we will start to work on each repo for this issue. Thanks for your support!!!

[NeOneSoft]

Hi @jmbowman I couldn't find edx/demographics repo. Do you know if it was moved to some other place? Thanks in advance!!

[NeOneSoft]

@natabene @awais786 I think that edx/video-encode-manager is also private

[ericfab179]

Quick update here:

• edx/portal-designer: PR to address this issue chore: switch to drf-yasg portal-designer#152
• edx/enterprise-catalog: This issue was already addressed here openedx/enterprise-catalog@1be9509
• edx/license-manager: This issue was already addressed here openedx/license-manager@3837626

[NeOneSoft]

Reviewing @ericfab179 update I found also this:

• edx/analytics-data-api: Merged on https://github.com/edx/edx-analytics-data-api/pull/471

[NeOneSoft]

Hi @natabene @awais786 @jmbowman !! I think that this issue is ready for review. Thank you so much for all your help and support!!

[awais786]

We are reviewing prs.

[natabene]

@awais786 What is still left here?

[awais786]

Repos still using django-rest-swagger
credentials, demographics, django-user-tasks, video-encode-manager, commerce-coordinator.
Few PRs already in review and few need PRs. Once all merged I will notify you.

[natabene]

@awais786 Just checking if those PRs have merged.

[Jawayria]

@natabene @NeOneSoft these 2 PRs are still not merged
openedx/credentials#1408
openedx/django-user-tasks#176

[Jawayria]

@NeOneSoft can you please create a PR to replace Django-rest-swagger in commerce-coordinator as well.

[NeOneSoft]

@Jawayria sorry about my delay to answer, I have been a little bit busy and I would like to know if you can help me with this repo please, commerce-coordinator