Skip to main content
Returnerar synliga utvecklardokument för den aktuella webbplatsen sida för sida, vilket kan användas för sökning, indexering eller för att själv bygga navigering i klienten. Listan innehåller för närvarande varje dokuments content och kapslad överordnad information, och svaret kan vara stort.

API-översikt

Frågeparametrar

Det aktuella list-API:t stöder inte filtrering på alias eller parent_id. Vid känt alias, anropa direkt dokumentdetaljer; vid konstruktion av trädnavigation, hämta en sida i taget och gruppera sedan efter varje posts parent.id i klienten.

Exempel på begäran

Svarsstruktur

Listan använder DocumentIndexSerializer och returnerar för närvarande modellfält och kapslade relationer; relaterade API-dokument kan även innehålla api_method. Fält kan läggas till på ett bakåtkompatibelt sätt, och klienten bör läsa dem vid behov. När children, det parsade innehållsspråket och innehållshashen behövs, använd detalj-API:t. För offentliga poster som är associerade med källdokument tillhandahåller content_source källdokumentets identifierare, källinnehållshash, det begärda språket, uppdateringstid för översättning samt statusen ready, stale, missing, missing_source eller ambiguous; för andra poster är fältet null. content_hash vid ready motsvarar översättningen för det språket. Brödtexten visas fortfarande enligt de ursprungliga reglerna, inklusive språkåterställning när översättning saknas; klienter som behöver synkronisera dokument bör kontrollera både status och hash och kan inte enbart avgöra om uppdateringen har skett utifrån att brödtexten inte är tom.

Användningsrekommendationer

  • Svaret innehåller brödtext; använd sidindelning och ange rimlig timeout vid batchsynkronisering, och hämta inte samma sida parallellt.
  • alias är den stabila identifieraren för den offentliga sidans URL; vid känt alias, begär direkt /api/v1/documents/{alias}.
  • Det aktuella API:t kan inte filtrera efter överordnad på serversidan; gruppera efter parent.id i klienten när navigering byggs.

Relaterade API:er