From 69b632fe6135bb19d37e119ec0e1a1082324eb9c Mon Sep 17 00:00:00 2001 From: git_repo_user Date: Thu, 4 Jun 2026 10:09:44 -0400 Subject: [PATCH 1/4] Update engine OAS file in docs with updated description for Engine getItem --- source/_static/api/engine.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_static/api/engine.html b/source/_static/api/engine.html index 398c55a69..afa240905 100644 --- a/source/_static/api/engine.html +++ b/source/_static/api/engine.html @@ -404,9 +404,9 @@
CrafterCMS - Engine

content

Content retrieval operations

Get Item

Module: Engine
-Get an Item from the content store.
This API is used to get pages, components and folders. It returns the content and other metadata such as url, descriptorUrl, folder flag, and extra properties

Note: This API also returns 'disabled' items when Crafter Engine is in preview mode to support authoring use cases.

+Get an Item from the content store.
This API is used to get pages, components and folders. It returns the content and other metadata such as url, descriptorUrl, folder flag, and extra properties

To render the response (content and other metadata) in JSON, use /api/1/site/content_store/item.json

To render the response (content and other metadata) in XML, use /api/1/site/content_store/item.xml

Note: This API also returns 'disabled' items when Crafter Engine is in preview mode to support authoring use cases.

query Parameters
url
required
string

The item’s url (e.g. /site/website/index.xml)

flatten
boolean

OK

Response samples

Content type
application/json
"<!-- Feature Component -->\\n <article class=\"feature\" data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" > <span class=\"icon fa-smile far\" data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"icon_s\" ></span> <div class=\"content\"> <h3 data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"title_t\" > Smile </h3> <div data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"body_html\" > <p>Smile, aenean ornare velit lacus, ac varius enim lorem ullamcorper dolore. Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p> </div> </div> </article> <!-- /Feature Component -->"
-.. code-block:: html + .. code-block:: html :force: :linenos: :emphasize-lines: 5 @@ -167,18 +151,20 @@ In your ``studio-ui`` code, add the new locale files to ``ui/app/src/translation :caption: *studio-ui/static-assets/components/cstudio-common/resources/ja/base.js* :linenos: - CStudioAuthoring.Messages.registerBundle("siteDashboard", "ja", { - dashboardTitle: "ダッシュボード", + CStudioAuthoring.Messages.registerBundle('siteDashboard', 'ja', { + dashboardTitle: 'ダッシュボード', - dashboardCollapseAll: "すべて折りたたむ", + dashboardCollapseAll: 'すべて折りたたむ', ... -Remember to change the language code in the all the ``registerBundle`` calls in the ``base.js`` file + Remember to change the language code in all the ``registerBundle`` calls in the ``base.js`` file .. code-block:: js - CStudioAuthoring.Messages.registerBundle("dialogs", "ja", { - + CStudioAuthoring.Messages.registerBundle('siteDashboard', 'ja', { + ... + CStudioAuthoring.Messages.registerBundle('contextnav', 'ja', { + ... -------------------------------------- 6. Build, deploy and test your changes From 600f377352035acd8c35adbc4cd020d794fe172a Mon Sep 17 00:00:00 2001 From: git_repo_user Date: Tue, 18 Aug 2026 09:22:42 -0400 Subject: [PATCH 3/4] Update based on cr review --- source/by-role/developer/common/adding-a-new-language.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/by-role/developer/common/adding-a-new-language.rst b/source/by-role/developer/common/adding-a-new-language.rst index ee8e65b5e..a78d1b406 100644 --- a/source/by-role/developer/common/adding-a-new-language.rst +++ b/source/by-role/developer/common/adding-a-new-language.rst @@ -29,9 +29,9 @@ Before we begin, we need to pick the two letter language code for the new langua Let's begin adding the language ``Japanese`` to Crafter Studio: ----------------------------------------------------------- -1. Add the new language to the available_languages API ----------------------------------------------------------- +-------------------------------------------------------- +1. Add the new language to the getAvailableLanguages API +-------------------------------------------------------- * To add the new language to the :base_url:`getAvailableLanguages <_static/api/studio.html#tag/system/operation/getAvailableLanguages>`, in your Studio configuration override file, ``studio-config-override.yaml``, add the new language: .. code-block:: yaml From 19ab6388044903b125142069be0394b7e143cfca Mon Sep 17 00:00:00 2001 From: git_repo_user Date: Tue, 18 Aug 2026 09:32:41 -0400 Subject: [PATCH 4/4] Update based on cr review --- .../common/adding-a-new-language.rst | 39 ++++++++++--------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/source/by-role/developer/common/adding-a-new-language.rst b/source/by-role/developer/common/adding-a-new-language.rst index a78d1b406..4e19b9967 100644 --- a/source/by-role/developer/common/adding-a-new-language.rst +++ b/source/by-role/developer/common/adding-a-new-language.rst @@ -32,25 +32,26 @@ Let's begin adding the language ``Japanese`` to Crafter Studio: -------------------------------------------------------- 1. Add the new language to the getAvailableLanguages API -------------------------------------------------------- -* To add the new language to the :base_url:`getAvailableLanguages <_static/api/studio.html#tag/system/operation/getAvailableLanguages>`, in your Studio configuration override file, ``studio-config-override.yaml``, add the new language: - - .. code-block:: yaml - :caption: *CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/studio/extension/studio-config-override.yaml* - :emphasize-lines: 10-11 - :linenos: - - studio.configuration.availableLanguages: - - id: en - label: English - - id: es - label: Español - - id: ko - label: 한국어 - - id: de - label: Deutsch - - id: ja - label: 日本語 - +To add the new language to the :base_url:`getAvailableLanguages <_static/api/studio.html#tag/system/operation/getAvailableLanguages>`, in your Studio configuration override file, ``studio-config-override.yaml``, add the new language: + +.. code-block:: yaml + :caption: *CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/studio/extension/studio-config-override.yaml* + :emphasize-lines: 10-11 + :linenos: + + studio.configuration.availableLanguages: + - id: en + label: English + - id: es + label: Español + - id: ko + label: 한국어 + - id: de + label: Deutsch + - id: ja + label: 日本語 + +If you are running a cluster and would like your new language configuration to replicate across your cluster, use the global override under *CRAFTER_HOME/data/repos/global/configuration*. --------------------------------------------------------- 2. Add the New Language to the React Translations Manager