Skip to main content
Devuelve de forma paginada los documentos para desarrolladores visibles en el sitio actual, que pueden utilizarse para búsquedas, indexación o para construir la navegación en el cliente. Actualmente, la lista incluye el content y la información del padre anidado de cada documento, por lo que la respuesta puede ser grande.

Resumen de la interfaz

Parámetros de consulta

La interfaz de lista actual no admite el filtrado por alias o parent_id. Cuando se conoce el alias, llame directamente a los detalles del documento; al construir una navegación en árbol, después de recuperar una página, agrupe en el cliente usando el parent.id de cada elemento.

Ejemplo de solicitud

Estructura de la respuesta

La lista utiliza DocumentIndexSerializer y actualmente devuelve los campos del modelo y las relaciones anidadas; los documentos de API asociados también pueden incluir api_method. Los campos pueden añadirse de forma compatible hacia atrás, y el cliente debe leer según sea necesario. Cuando se necesiten children, el idioma del contenido analizado y el hash del contenido, utilice la interfaz de detalles. Para los registros públicos asociados a documentos fuente, content_source proporciona el identificador del documento fuente, el hash del contenido fuente, el idioma solicitado, la hora de actualización de la traducción y los estados ready, stale, missing, missing_source o ambiguous; para otros registros este campo es null. El content_hash en estado ready corresponde a la traducción en ese idioma. El cuerpo aún se muestra conforme a las reglas originales, incluido el retroceso de idioma cuando falta una traducción; los clientes que necesiten sincronizar documentos deben comprobar tanto el estado como el hash, y no pueden determinar que se ha actualizado únicamente porque el cuerpo no esté vacío.

Recomendaciones de uso

  • La respuesta contiene el cuerpo; al sincronizar en lote, utilice paginación y establezca un tiempo de espera razonable, no recupere la misma página de forma simultánea.
  • El alias es el identificador estable de la URL de la página pública; cuando se conoce el alias, solicite directamente /api/v1/documents/{alias}.
  • La interfaz actual no puede filtrar en el servidor por padre; al construir la navegación, agrupe en el cliente por parent.id.

Interfaces relacionadas