(PC-31554)[API]docs: updated API documentation. externalTicketOfficeUrl field of offer model is now deprecated #13952
Conversation
There was a problem hiding this comment.
Bon là je demande des changements parce que ça casse le design 😬.
Pour les changements concernant la documentation, il faut mettre les screenshots dans la PR car ce sont des "changements graphiques" (dernier point de la checklist de PR). Ça permet d'attraper le genre d'erreur que je t'ai remontée.
Tu peux générer la documentation en local. Toute la doc est dans ce README 🙂. Si jamais elle n'est pas claire, ou plus à jour, n'hésite pas à la modifier.
| :::warning | ||
| Offer field `externalTicketOfficeUrl` is now deprecated and is going to be removed in the coming months. | ||
|
|
There was a problem hiding this comment.
Il manque::: après ton texte ce qui casse le design (cf. screenshot)
| :::warning | |
| Offer field `externalTicketOfficeUrl` is now deprecated and is going to be removed in the coming months. | |
| :::warning | |
| Offer field `externalTicketOfficeUrl` is now deprecated and is going to be removed in the coming months. | |
| ::: |
| @@ -146,7 +146,7 @@ class CategoryRelatedFields(ExtraDataModel): | |||
| CATEGORY_RELATED_FIELD = pydantic_v1.Field(..., description=CATEGORY_RELATED_FIELD_DESCRIPTION) | |||
| EXTERNAL_TICKET_OFFICE_URL_FIELD = pydantic_v1.Field( | |||
| None, | |||
| description="Link displayed to users wishing to book the offer but who do not have credit.", | |||
| description="**(deprecated)** Link displayed to users wishing to book the offer but who do not have credit.", | |||
There was a problem hiding this comment.
tu peux en profiter pour déplacer le field dans le fichier fields.py. Toutes les descriptions des champs doivent être migrées dans ce fichier à terme
| } |
There was a problem hiding this comment.
L'ajout de ce retour chariot me donne l'impression que tu as modifié ce fichier à la main, ce qu'il ne faut pas faire.
Pour le mettre à jour il faut utiliser la commande generate_expected_openapi_json :
- Si tu utilises docker, il suffit de lancer la commande
pc generate_expected_openapi_json - si tu run flask en local,
flask generate_expected_openapi_json
C'est beaucoup plus pratique 😃
…rl field of offer model is now deprecated
pcharlet-pass
force-pushed
the
pcharlet/pc-31554-doc-update-field-deprecated
branch
from
b750835
to
bb4defc
Compare
|
Abandon de la dépréciation de ce champ |
But de la pull request
Ticket Jira : https://passculture.atlassian.net/browse/PC-31554
Vérifications