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

Remplace django-rest-swagger par drf-yasg #6171

Merged
merged 3 commits into from
Oct 3, 2021

Conversation

Situphen
Copy link
Member

@Situphen Situphen commented Sep 13, 2021

Remplace django-rest-swagger par drf-yasg car le premier n'a plus l'air très maintenu et le second l'est. L'affichage de la documentation est presque identique car ça se base toujours sur Swagger.

Fix #5436

QA :

  • source zdsenv/bin/activate && make update && make run-back
  • Aller sur /api et vérifier que la documentation fonctionne correctement

@Situphen Situphen added C-Docs Concerne la documentation C-API Concerne une API du site labels Sep 13, 2021
@coveralls
Copy link

coveralls commented Sep 13, 2021

Coverage Status

Coverage decreased (-0.002%) to 86.619% when pulling cedb132 on Situphen:api-doc into ead125e on zestedesavoir:dev.

@philippemilink
Copy link
Member

Je me suis permis d'éditer le message de la PR, pour fermer automatiquement l'issue liée.

@Arnaud-D
Copy link
Contributor

Arnaud-D commented Oct 3, 2021

QA OK ✔️

Je n'ai pas regardé le code dans tous ses détails. J'ai l'impression que tu as changé quelques petites bricoles en plus, je me trompe ?

@Situphen
Copy link
Member Author

Situphen commented Oct 3, 2021

J'ai fait quelques changements supplémentaires au delà de la simple adaptation du code et de la configuration oui. drf-yasg vient avec des validateurs qui vérifient certains points dans le code et émet des avertissements si ce n'est pas correct. J'ai donc corrigé les quelques avertissements émis, sans que normalement ça ne change quoi que ce soit au fonctionnement.

Il y a :

  • une URL dont la regex n'était pas fermée ;
  • une vue sans fonction get_queryset définie ;
  • une vue avec une fonction get_queryset qui retournait une erreur si une paramètre GET n'était pas présent ;
  • une vue dont la fonction get_serializer_class ne retournait rien lorsque la méthode PATCH était utilisée.

@Arnaud-D Arnaud-D merged commit 3259547 into zestedesavoir:dev Oct 3, 2021
@Situphen Situphen deleted the api-doc branch October 3, 2021 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-API Concerne une API du site C-Docs Concerne la documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Remplacer django-rest-swagger par drf-yasg
4 participants