Skip to content

Commit 22095b2

Browse files
committed
docs(openapi): translate Redoc override guidance to English
1 parent 42d62a2 commit 22095b2

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

docs/release-notes/whats-new-3.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,9 @@ Redoc CDN Default Updated
8989
-------------------------
9090

9191
The :class:`~litestar.openapi.plugins.RedocRenderPlugin` now defaults to the ReDocly CDN
92-
(``https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js``) instead of jsDelivr. この変更により
93-
``version="latest"`` を指定した場合でも安定したバンドルを取得できます。自前 CDN や社内ホストを利用する
94-
必要がある場合は、``js_url`` 引数を設定すると従来どおり手動で URL を上書きできます。詳細なサンプルは
95-
``usage/openapi/ui_plugins`` に追記されています。
92+
(``https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js``) instead of jsDelivr. This change ensures that
93+
``version="latest"`` consistently resolves to a working bundle. If you rely on a private CDN or internal host,
94+
set the ``js_url`` argument to override the URL as before. See ``usage/openapi/ui_plugins`` for an updated example.
9695

9796
Changes to Endpoint Configuration
9897
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/usage/openapi/ui_plugins.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ Here's some example plugin configurations:
121121

122122
.. tip::
123123

124-
``js_url`` 引数を指定すると、ReDoc のバンドル取得先を任意の CDN や社内ホストへ切り替えられます。
125-
例えば ``redoc_config.py`` では ``https://cdn.company.internal/redoc/custom-redoc.js`` を指すように
126-
上書きしており、``version`` の値よりも ``js_url`` が優先されます。
124+
Setting ``js_url`` lets you point the ReDoc bundle to any CDN or internal host. In ``redoc_config.py``
125+
we override it to ``https://cdn.company.internal/redoc/custom-redoc.js``. When provided, ``js_url`` takes
126+
precedence over ``version``.
127127

128128
.. tab-item:: stoplight
129129
:sync: stoplight

0 commit comments

Comments
 (0)