diff --git a/ru/personal-domain-ya-cloud.md b/ru/personal-domain-ya-cloud.md index 850df347..459d61fe 100644 --- a/ru/personal-domain-ya-cloud.md +++ b/ru/personal-domain-ya-cloud.md @@ -60,11 +60,17 @@ 1. В поле **Сеть** выберите `default` или свой вариант. -1. Заполните поле **Спецификация**: используйте свою OpenAPI спецификацию или пример ниже, заменив необходимые параметры. +1. Заполните поле **Спецификация**: используйте свою OpenAPI спецификацию или пример. - {% cut "Пример спецификации OpenAPI" %} + {% cut "Пример OpenAPI спецификации" %} - #### Спецификация OpenAPI + {% note warning %} + + Вы открыли пример OpenAPI спецификации. Используйте его, но измените некоторые важные параметры, такие как: адрес внешнего домена или путь, на который должна проксироваться документация. + + {% endnote %} + + #### OpenAPI Спецификация ``` openapi: 3.0.0 @@ -95,26 +101,28 @@ type: string ``` - #### Описание параметров спецификации OpenAPI + #### Описание параметров OpenAPI спецификации #| || Параметр | Описание параметра || - || `servers` | Раздел содержит следующие вложенные параметры: + || `servers` | Настройка вложенных параметров `url` раздела `servers` позволит указать, по какому адресу необходимо проксировать документацию. + Заполните параметры по инструкции: + - Первый `url` параметр содержит адрес, на котором работает API Gateway, — оставьте значение по умолчанию. - - Для второго `url` параметра укажите свой домен. || - || `paths` | Содержит вложенное правило, которое позволяет с помощью параметров конфигурировать ответ на корень урла. Вложенный в раздел `paths`, параметр `/путь/{path+}:` указывает по какому адресу должна располагаться документация. + - Для второго `url` параметра укажите внешний домен, на который нужно проксировать документацию. || + || `paths` | Содержит вложенное правило, которое позволяет с помощью параметров конфигурировать ответ для параметра `url` из раздела `servers`. Параметр `/путь/{path+}:`, вложенный в раздел `paths`, указывает по какому пути должна располагаться документация. {% note info %} - Если вы используете пример OpenAPI спецификации, то документация будет разсположена по адресу `example-for-your-domain.net/docs`. + Если вы используете пример OpenAPI спецификации, то документация будет разсположена по пути `example-for-your-domain.net/docs`. {% endnote %}|| || `get` | Вложенное правило, которое обрабатывает все get-запросы. || - || `headers` | Параметр содержит служебные заголовки: - - x-real-host — домен - - x-docs-proxy-base: docs — в каком каталоге размещаться - - x-docs-project-name: diplodoc-platform--docs — - || + || `headers` | Параметр содержит служебные заголовки. Настройте служебные заголовки для своего домена: + + 1. Для параметра `x-real-host:` укажите адрес внешнего домена. + 1. Для параметра `x-docs-proxy-base:` — укажите в каком каталоге нужно размещать документацию. + 1. Для параметра `x-docs-project-name: ` — укажите .... || || `url` | Параметр, вложенный в правило `get`, содержит адрес, на который перенаправляется документация. {% note info %}