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/3] 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 -->"