Skip to main content
Restituisce in modo paginato i documenti per sviluppatori visibili nel sito corrente, utilizzabile per la ricerca, l’indicizzazione o la costruzione autonoma della navigazione nel client. L’elenco include attualmente il content e le informazioni sul genitore annidato di ciascun documento, e la risposta potrebbe essere grande.

Panoramica dell’interfaccia

Parametri di query

L’attuale interfaccia elenco non supporta il filtraggio per alias o parent_id. Se l’alias è noto, chiamare direttamente i dettagli del documento; quando si costruisce la navigazione ad albero, dopo aver recuperato una pagina, raggruppare nel client usando parent.id di ciascun elemento.

Esempio di richiesta

Struttura della risposta

L’elenco utilizza DocumentIndexSerializer e attualmente restituisce i campi del modello e le relazioni annidate; i documenti API associati possono anche includere api_method. I campi potrebbero essere aggiunti in modo retrocompatibile e il client dovrebbe leggerli secondo necessità. Quando sono necessari children, la lingua del contenuto analizzato e l’hash del contenuto, utilizzare l’interfaccia dei dettagli. Per i record pubblici associati a documenti sorgente, content_source fornisce l’identificatore del documento sorgente, l’hash del contenuto sorgente, la lingua richiesta, il momento di aggiornamento della traduzione e lo stato ready, stale, missing, missing_source o ambiguous; per gli altri record questo campo è null. L’content_hash quando lo stato è ready corrisponde alla traduzione in quella lingua. Il corpo viene comunque visualizzato secondo le regole originali, incluso il fallback della lingua quando manca una traduzione; i client che devono sincronizzare i documenti devono controllare sia lo stato sia l’hash e non possono stabilire che sia aggiornato solo perché il corpo non è vuoto.

Suggerimenti per l’uso

  • La risposta contiene il corpo del testo; durante la sincronizzazione in batch utilizzare la paginazione e impostare timeout ragionevoli, non recuperare in parallelo la stessa pagina.
  • alias è l’identificatore stabile dell’URL della pagina pubblica; quando l’alias è noto, richiedere direttamente /api/v1/documents/{alias}.
  • L’interfaccia attuale non consente il filtraggio lato server per genitore; quando si costruisce la navigazione, raggruppare nel client per parent.id.

Interfacce correlate