# Входные и выходные структуры

# RetrieveDocumentRequest

tld
Домен верхнего уровня.

doccenterParams
Объект doccenterParams. Содержит параметры запроса документа, которые передаются в DaaS. DaaS формирует документ с учетом указанных параметров.
userInfo
Объект userInfo. Содержит информацию о пользователе.
components
Массив компонентов документа (по умолчанию html_heads, menu(json=true), content, lang). Список всех компонентов перечислен в словаре . Можно передавать названия и параметры компонентов.
lang

Предпочитаемый язык документа. Допустимые значения:

- ar
  — арабский;
- az
  — азербайджанский;
- be
  — белорусский;
- en
  — английский;
- et
  — эстонский;
- fi
  — финский;
- fr
  — французский;
- he
  — иврит;
- hy
  — армянский;
- id
  — индонезийский;
- ka
  — грузинский;
- kk
  — казахский;
- ky
  — киргизский;
- lt
  — литовский;
- lv
  — латышский;
- ro
  — румынский;
- ru
  — русский;
- sk
  — словацкий;
- sl
  — словенский;
- sr
  — сербский;
- tg
  — таджикский;
- tr
  — турецкий;
- uk
  — украинский;
- uz
  — узбекский.

Если документ не переведен на указанный язык, то начинается поиск перевода с учетом таблицы:

Домен | Последовательность поиска перевода
--- | ---
ru | ru, en, uk
ua | uk, ru, en
by | ru, en
kz | kk, ru, en
uz | uz, ru, en
com | en, ru, uk
com.tr | tr, en

isolated
Признак. Включает изоляцию скриптов и стилей. Все классы в документе будут иметь префикс doc-c-. Значение по умолчанию: true.
bidi
Признак. Включает поддержку RTL в стилях. Чтобы поддержка RTL заработала, добавьте атрибут dir со значением rtl или ltr для тега <html или <body>. Значение по умолчанию: false.
forceFullLinks
Признак. Разворачивает все относительные ссылки на странице в абсолютные (с протоколом и хостом). Значение по умолчанию: false.
formsParams
Объект formsParams. Содержит параметры, которые будут переданы во все формы Конструктора форм в виде query-параметров. Используется для построения адреса формы, которая показывается в iframe.
customParams
Объект customParams. Содержит произвольные параметры для DaaS.
isMobile
Признак. Пользователь использует телефон или планшет. Если значение true, то в формы передаются параметры ?mobile=yes&media-type=mobile.
service
Имя сервиса, который зарегистрирован в Конструкторе форм.
path
Путь/директория относительно кластера, где лежит документ с формой в DaaS. Формат параметра: cluster/alias/document_name.html, например, /support/connect-mail/web/letter/create.html. <alias> — это имя проекта в рамках кластера. Имя проекта можно посмотреть с помощью операции .
url
Полный URL документа с формой.
theme
Тема для формы. Настраивается в Конструкторе форм.
key
Название параметра.
value
Значение параметра.

# RetrieveDocumentResponse

doccenterResponse
JSON-строка с ответом из DaaS.

# SearchRequest

text
Текст поискового запроса.
tld

Параметр является фильтром и ограничивает область поиска.

page
Номер страницы выдачи. Значение по умолчанию: 0. Одна страница содержит ограниченное количество результатов, поэтому доступна пагинация.
projectAlias
Имя проекта в рамках кластера. Если значение параметра не передано, поиск идет по всем проектам. Чтобы узнать имя проекта, воспользуйтесь операцией .
lang

Язык документа. Параметр является фильтром и ограничивает область поиска. Если значение параметра не передано, поиск может работать некорректно. Рекомендуется передавать всегда. Допустимые значения:

# SearchResponse

documents
Массив объектов. Содержит список найденных документов.
projects
Список проектов кластера, в которых были найдены документы.
title
Название документа.
url
Полный URL документа на конечном сервисе, например .
path

projectAlias
Имя проекта в рамках кластера (используется для формирования ссылок), в котором находится документ.
projectName
Человекочитаемое имя проекта, в котором находится документ.
matchedFragments
Массив найденных фрагментов в одном документе через запятую, которые содержат искомый текст.

# SuggestRequest

lang

items
Массив объектов. Содержит список найденных поисковых подсказок.
type
Тип поисковой подсказки. Допустимые значения:

- document
  — объектная подсказка. В качестве подсказки выдаются документы, найденные по первым буквам поискового запроса. Поиск ведется по названию документа;
- search-text
  — контент-саджест (подсказка по содержанию документов). В качестве подсказки выдаются варианты формулировки поискового запроса.

text
Текст поисковой подсказки.
path

Параметр используется с подсказкой типа document.

url

# SitemapResponse

sitemap
Файл sitemap.xml со всеми документами кластера.
documents
Массив объектов. Содержит документы кластера (список документов совпадает со списком в файле sitemap.xml).
details
Подробная информация о документе.
/
project
Слаг документа. Обычно совпадает с параметром projectAlias.
lang
Язык документа. Параметр отдается, если у документа несколько языков на указанном домене. Допустимые значения:

# Project Links

items
Массив связей между кластером и проектом.
id
Идентификатор связи.
meta
Произвольные метаданные.
isCanonical
Является ли кластер каноническим для проекта. Допустимые значения:

- true
  — кластер является каноническим, т.е. документы проекта указывают на текущий кластер;
- false
  — кластер не является каноническим, т.е. документы проекта указывают на другой кластер.

alias
Имя проекта в рамках кластера, используется для формирования ссылок. Допустимые символы: a-z, 0-9, -.
basePath
Базовый путь до документации проекта на фронте. Начинается и заканчивается символом /.
root
Путь до директории в проекте, внутри которой находится документация. Начинается и заканчивается символом /.
project
Информация о проекте кластера.
id
Идентификатор проекта.
slug
Человекочитаемое имя проекта, определяет директорию, например, browser. Допустимые символы: a-z, 0-9, -.
documentsCluster
Источник документов проекта.
authType

Тип авторизации в проекте. Допустимые значения:

- idm
  — используется для внутренних проектов, проверяется роль в IDM;
- staff
  — используется для внешних проектов, проверяется связка внешнего аккаунта пользователя (login@yandex.ru) с аккаунтом на staff.

meta
Произвольные метаданные для проекта.