Skip to main content
Посторінково повертає документи розробника, видимі на поточному сайті, які можна використовувати для пошуку, індексації або самостійної побудови навігації на клієнті. Наразі список містить 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.

Пов’язані інтерфейси