content и вложенную информацию о родительском элементе каждой статьи, ответ может быть большим.
Обзор интерфейса
Параметры запроса
Текущий интерфейс списка не поддерживает фильтрацию по
alias или parent_id. При известном alias напрямую вызывайте детали документа; при построении древовидной навигации после однократного постраничного получения группируйте на клиенте по parent.id каждого элемента.
Пример запроса
Структура ответа
DocumentIndexSerializer и в настоящее время возвращает поля модели и вложенные связи; связанные API-документы также могут содержать api_method. Поля могут добавляться с сохранением обратной совместимости, клиенту следует считывать только необходимое. Когда требуются children, разобранный язык содержимого и хеш содержимого, используйте интерфейс деталей.
Для публичных записей, связанных с исходными документами, content_source предоставляет идентификатор исходного документа, хеш исходного содержимого, запрошенный язык, время обновления перевода и статус ready, stale, missing, missing_source или ambiguous; для остальных записей это поле равно null. content_hash при ready соответствует переводу на этом языке. Основной текст по-прежнему отображается согласно исходным правилам, включая языковой откат при отсутствии перевода; клиентам, которым требуется синхронизация документов, следует одновременно проверять статус и хеш, а не судить об обновлении только по непустому основному тексту.
Рекомендации по использованию
- Ответ содержит основной текст; при пакетной синхронизации используйте пагинацию и задавайте разумный тайм-аут, не загружайте одну и ту же страницу параллельно.
- alias — стабильный идентификатор URL публичной страницы; при известном alias напрямую запрашивайте
/api/v1/documents/{alias}. - Текущий интерфейс не позволяет выполнять серверную фильтрацию по родительскому элементу; при построении навигации группируйте на клиенте по
parent.id.

