Skip to main content
Renvoie de manière paginée les documents développeur visibles du site actuel, utilisables pour la recherche, l’indexation ou la construction autonome de la navigation côté client. La liste contient actuellement le content et les informations parent imbriquées de chaque document, la réponse peut être volumineuse.

Aperçu de l’interface

Paramètres de requête

L’interface de liste actuelle ne prend pas en charge le filtrage par alias ou parent_id. Lorsque l’alias est connu, appelez directement les détails du document ; lors de la construction d’une navigation arborescente, récupérez les pages une fois puis regroupez côté client en utilisant parent.id de chaque élément.

Exemple de requête

Structure de la réponse

La liste utilise DocumentIndexSerializer et renvoie actuellement les champs du modèle ainsi que les relations imbriquées ; les documents API associés peuvent également contenir api_method. Des champs peuvent être ajoutés de manière rétrocompatible, le client doit les lire selon ses besoins. Lorsque children, la langue de contenu analysée et le hachage du contenu sont nécessaires, utilisez l’interface de détails. Pour les enregistrements publics associés à des documents sources, content_source fournit l’identifiant du document source, le hachage du contenu source, la langue demandée, l’heure de mise à jour de la traduction et les états ready, stale, missing, missing_source ou ambiguous ; pour les autres enregistrements, ce champ est null. Le content_hash lorsque l’état est ready correspond à la traduction dans cette langue. Le corps du texte est toujours affiché selon les règles existantes, y compris le repli de langue en cas de traduction manquante ; les clients devant synchroniser les documents doivent vérifier simultanément l’état et le hachage, et ne peuvent pas déterminer qu’une mise à jour est effectuée uniquement parce que le corps du texte n’est pas vide.

Recommandations d’utilisation

  • La réponse contient le corps du texte ; lors de synchronisations par lots, utilisez la pagination et définissez un délai d’attente raisonnable, ne récupérez pas la même page simultanément.
  • L’alias est l’identifiant stable de l’URL de la page publique ; lorsque l’alias est connu, demandez directement /api/v1/documents/{alias}.
  • L’interface actuelle ne peut pas filtrer côté serveur par parent ; lors de la construction de la navigation, regroupez côté client par parent.id.

Interfaces associées