Retrait dans la documentation du support XML (#6495) #6698
Conversation
| $ curl -H "Accept: application/xml" https://zestedesavoir.com/api/membres/ | ||
|
|
||
| Les `formats de sortie (en) <http://www.django-rest-framework.org/api-guide/renderers/>`_ sont renseignés dans le fichier ``settings.py`` sous l'attribut ``DEFAULT_RENDERER_CLASSES`` du dictionnaire ``REST_FRAMEWORK``. Pour Django Rest Framework, tous les formats de sorties sont des ``renderer``. | ||
| Par défaut, le serveur renvoie les réponses au format ``JSON``. Les `formats de sortie (en) <http://www.django-rest-framework.org/api-guide/renderers/>`_ sont renseignés dans le fichier ``settings.py`` sous l'attribut ``DEFAULT_RENDERER_CLASSES`` du dictionnaire ``REST_FRAMEWORK``. Pour Django Rest Framework, tous les formats de sorties sont des ``renderer``. |
There was a problem hiding this comment.
Dans le projet zds le fichier settings.py n'existe pas.
Le fichier dans lequel se trouve le dictionnaire REST_FRAMEWORK est le suivant : zds/settings/abstract_base/django.py.
|
|
||
| .. sourcecode:: bash | ||
|
|
||
| $ curl -H "Content-Type: application/xml" https://zestedesavoir.com/api/membres/ | ||
| $ curl -H "Content-Type: application/x-www-form-urlencoded" https://zestedesavoir.com/api/membres/ | ||
|
|
||
| Les `formats d'entrée (en) <http://www.django-rest-framework.org/api-guide/parsers/>`_ sont renseignés dans le fichier ``settings.py`` sous l'attribut ``DEFAULT_PARSER_CLASSES`` du dictionnaire ``REST_FRAMEWORK``. Pour Django Rest Framework, tous les formats d'entrée sont des ``parser``. |
There was a problem hiding this comment.
Idem ici : dans le projet zds le fichier settings.py n'existe pas.
Le fichier dans lequel se trouve le dictionnaire REST_FRAMEWORK est le suivant : zds/settings/abstract_base/django.py.
There was a problem hiding this comment.
J'ai commit un correctif de ça mais vais le fusionner dans une PR associée à un nouveau ticket (je le renseignerai dans cette conversation).
Par contre, j'ai observé que setting.py était aussi mentionné pour la configuration de la pagination, mais je ne suis pas parvenu à trouver les champs spécifiés dans d'autres fichiers du dépôt.
Ligne 166 du fichier au commit 1db39b9
La pagination peut être configurée directement dans les vues de l'API mais aussi dans le fichier ``settings.py`` pour s'appliquer à l'ensemble des listes des ressources de l'API. Dans le fichier ``settings.py``, ``PAGINATE_BY`` renseigne la taille d'une page, ``PAGINATE_BY_PARAM`` permet aux clients de modifier la taille d'une page et ``MAX_PAGINATE_BY`` permet d'imposer une taille maximale.Si quelqu'un a une idée de comment modifier en conséquence ce paragraphe, je suis preneur.
There was a problem hiding this comment.
J'ai ouvert une PR pour ce problème ici : #6708
Le commit `eb70ffd` a retiré le support XML de l'API, mais des mentions dans la documentation de son support étaient toujours présentes. Fix zestedesavoir#6495
Le support XML n'étant plus supporté par l'API depuis le commit
Fix #6495eb70ffd, cette PR retire de la documentation toutes les mentions restantes de ce support.Contrôle qualité
make generate-docpython3 -m http.server 8080 -d doc/build/html//api.html(dans l'exemple, à la pagelocalhost:8080/api.html)