Améliore le design de la documentation de l'API

[Situphen]

Q	R
Correction de bugs ?	non
Nouvelle Fonctionnalité ?	non
Tickets (issues) concernés	Aucun

QA : Vérifier que la documentation de l'API fonctionne toujours correctement (d'autant plus que la version de Django Rest Swagger a changée)

Il faut lancer pip install --upgrade -r requirements.txt avant pour mettre à jour les dépendances et générer le front (npm run gulp -- build) ! ;)

Aperçu : Voici un aperçu :

[GerardPaligot]

Est-ce qu'il serait possible d'utiliser la sidebar en mettant "membres" dedans ? Pour l'instant, il n'y aura que lui mais à terme, nous aurons beaucoup de ressources.

[coveralls]

Coverage remained the same at 78.0% when pulling 131cf67 on Situphen:doc-api into 3dac021 on zestedesavoir:dev.

[Situphen]

@GerardPaligot : La documentation restera utilisable sans barre latérale mais je vais voir si c'est faisable !

[GerardPaligot]

Merci, ça serait super. En tout cas, merci de t'être penché sur le sujet. Ca donne bien ! :)

[coveralls]

Coverage remained the same at 78.0% when pulling e26bb50 on Situphen:doc-api into 3dac021 on zestedesavoir:dev.

[landscape-bot]

Repository health decreased by 0.00% when pulling e26bb50 on Situphen:doc-api into 3dac021 on zestedesavoir:dev.

• 652 new problems were found (including 12 errors and 301 code smells).
• 652 problems were fixed (including 12 errors and 301 code smells).

[firm1]

GG ça rend bien et avec moins de code.

[coveralls]

Coverage remained the same at 78.0% when pulling fb390a6 on Situphen:doc-api into 3dac021 on zestedesavoir:dev.

[Fulbert]

Le menu sur desktop est aussi trop gros.

Je vois pas d'intérêt à [ Base URL: ...]

Si on test avec de mauvais paramètres (pk inexistant par exemple), il y a de gros trous dans la présentation. En testant patch /api/membres/{pk}/, même avec un pk existant, on obtient une "TypeError". J'imagine qu'il envoie la pk comme une chaîne de caractères. Et en plus la présentation est pleine de "bugs".

Et il y a aussi les liens Connexion et Inscription qui sont plus petits que la normale.

[gustavi]

[ Base URL: ...] est là par défaut.

[Situphen]

Je vois pas d'intérêt à [ Base URL: ...]

Ça ne vient pas de moi mais grâce à la magie du CSS il est devenu invisible !

En testant patch /api/membres/{pk}/, même avec un pk existant, on obtient une "TypeError". J'imagine qu'il envoie la pk comme une chaîne de caractères. Et en plus la présentation est pleine de "bugs".

Ça ne vient pas de moi, la même erreur existe sur le dépôt actuellement ! Tu peux le reporter sur le sujet de la ZEP ?

[landscape-bot]

Repository health decreased by 0.34% when pulling f52b3fe on Situphen:doc-api into c490264 on zestedesavoir:dev.

• 52 new problems were found (including 0 errors and 0 code smells).
• 2 problems were fixed (including 0 errors and 0 code smells).

[GerardPaligot]

patch n'est pas supportée. Il ne devrait pas apparaitre dans la doc, je l'ai spécifié dans la configuration de Swagger mais il s'agit là d'une regression de la bibliothèque par rapport à une ancienne version. Etant donné que l'API (et donc la documentation) sont encore en bêta, j'ai jugé ça non important d'y prêter attention puisqu'il va suffire d'attendre la prochaine release de la bibliothèque pour qu'il ne s'affiche plus.

[Eskimon]

Ca marche MAIS la police a l'air grossi (on le voit dans le footer du screenshot de l'OP mais aussi dans le fil d'ariane, par contre pas dans le header)

[Situphen]

Je me cite :

Le fil d'ariane, le bas de page et le menu pour mobile sont en plus gros que sur le reste du site. Je ne peux pas régler ce problème sans copier/coller les fichiers statiques de django-rest-swagger donc j'ai envoyé une PR pour éviter qu'on alourdisse notre dépôt !

Il n'y a pas eu encore de réaction à ma PR marcgibbons/django-rest-swagger#213.

[Eskimon]

et on a pas de workaround ? Dommage :(

[Situphen]

"workaround" ?

[Eskimon]

Rustine

[Eskimon]

C'est possible de donner un titre à la page autre que "Swagger" ?

[Situphen]

et on a pas de workaround ? Dommage :(

Il y en a une mais j'aimerais l'éviter : copier/coller les fichiers statiques de django-rest-swagger.

C'est possible de donner un titre à la page autre que "Swagger" ?

"Documentation de l'API • Zeste de Savoir" est le nom de la page sur cette branche !

[Situphen]

Ma PR a été mergée et le problème est réglé ! \o/ Il ne reste plus qu'à attendre qu'une release sorte pour que je puisse mettre à jour requirements.txt et que l'on puisse merger !

EDIT : Le mainteneur du projet m'a dit qu'une release aura lieu dans la semaine !

[landscape-bot]

Repository health decreased by 0.34% when pulling f52b3fe on Situphen:doc-api into c490264 on zestedesavoir:dev.

• 52 new problems were found (including 0 errors and 0 code smells).
• 2 problems were fixed (including 0 errors and 0 code smells).

[SpaceFox]

@Situphen des nouvelles ?

[Situphen]

Pas pour l'instant. J'attends un jour ou deux et je le relance !

[Situphen]

Voilà, une nouvelle version est sortie ! Pour voir les changements entre l'ancienne version et la nouvelle, c'est ici que ça se passe.

EDIT : Il faut lancer pip install --upgrade -r requirements.txt avant pour mettre à jour les dépendances ! ;)

[landscape-bot]

Code quality remained the same when pulling 8a443e8 on Situphen:doc-api into 0b6276f on zestedesavoir:dev.

[Fulbert]

QA ok pour moi avec la version 0.2.9 de django-rest-swagger (nécessite de modifier de requirements.txt). Les menus sont à la bonne taille.

Par contre le base URL s'affiche, et il faut (faudra ?) rajouter un menu latéral pour les différentes API.

Je viens de remarquer ça dans les logs du serveur :
[10/Mar/2015 19:31:03] "GET /api/undefinedrest_framework_swagger/images/throbber.gif HTTP/1.1" 404 7223

[Situphen]

Par contre le base URL s'affiche

Tu n'as pas oublié de générer le front (npm run gulp -- build) ? (J'avais oublié de le préciser)

il faut (faudra ?) rajouter un menu latéral pour les différentes API

Peut-être une autre fois, ce n'est pas urgent.

---

Je regarde l'erreur de log demain !

[Fulbert]

Par contre le base URL s'affiche

Tu n'as pas oublié de générer le front (npm run gulp -- build) ? (J'avais oublié de le préciser)

Si. Tout bon alors.

[Situphen]

Je viens de remarquer ça dans les logs du serveur : [10/Mar/2015 19:31:03] "GET /api/undefinedrest_framework_swagger/images/throbber.gif HTTP/1.1" 404 7223

Je viens de tester et je n'ai pas d'erreur. J'ai [11/Mar/2015 14:38:53] "GET /static/rest_framework_swagger/images/throbber.gif HTTP/1.1" 200 9257.

As-tu toujours cette ligne quand tu vas sur la page ?

[pierre-24]

Moi je l'ai pas, si jamais. On peut merger, du coup ?

[GerardPaligot]

@Fulbert : Tu as toujours l'erreur ou nous pouvons merger ?

[Fulbert]

C'est bon, plus de 404, à merger Marceline. :)

2015-03-15 2:56 GMT-07:00 Gérard Paligot notifications@github.com:

@Fulbert https://github.com/Fulbert : Tu as toujours l'erreur ou nous
pouvons merger ?

—
Reply to this email directly or view it on GitHub
#2264 (comment)
.