Skip to main content
Retorna de forma paginada os documentos de desenvolvedor visíveis no site atual, que podem ser usados para pesquisa, indexação ou para construir navegação no cliente. A lista atualmente contém o content e informações de pai aninhadas para cada documento, e a resposta pode ser grande.

Visão Geral da Interface

Parâmetros de Consulta

A interface de lista atual não suporta filtragem por alias ou parent_id. Quando o alias for conhecido, chame diretamente os detalhes do documento; ao construir navegação em árvore, após buscar uma página de cada vez, use o parent.id de cada item para agrupar no cliente.

Exemplo de Solicitação

Estrutura da Resposta

A lista usa DocumentIndexSerializer e atualmente retorna campos do modelo e relações aninhadas; documentos de API associados também podem incluir api_method. Campos podem ser adicionados de forma retrocompatível, e o cliente deve ler conforme necessário. Quando forem necessários children, o idioma de conteúdo analisado e o hash de conteúdo, use a interface de detalhes. Para registros públicos associados a documentos de origem, content_source fornece o identificador do documento de origem, o hash do conteúdo de origem, o idioma solicitado, a hora de atualização da tradução e o status ready, stale, missing, missing_source ou ambiguous; para outros registros, esse campo é null. O content_hash quando ready corresponde à tradução nesse idioma. O corpo ainda é exibido segundo as regras originais, incluindo o fallback de idioma quando falta uma tradução; clientes que precisam sincronizar documentos devem verificar simultaneamente o status e o hash, e não podem determinar que foi atualizado apenas porque o corpo não está vazio.

Recomendações de Uso

  • A resposta contém o corpo do texto; ao sincronizar em lote, use paginação e defina um tempo limite razoável, não busque a mesma página simultaneamente.
  • alias é o identificador estável da URL da página pública; quando o alias for conhecido, solicite diretamente /api/v1/documents/{alias}.
  • A interface atual não pode filtrar por pai no servidor; ao construir a navegação, agrupe no cliente por parent.id.

Interfaces Relacionadas