[DOCU-2727] Change templateId is optional for block text Created: 22/May/23  Updated: 22/May/23  Resolved: 22/May/23

Status: Resolved
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Chuck Aksamit Assignee: Alex Mansell
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: File basicText.yaml    
Documentation page URL: https://docs.magnolia-cms.com/product-docs/6.2/Apps/Developing-an-app/Developing-a-custom-content-editor-app/Block-definition.html
Reporter Name: Chuck Aksamit

 Description   

In a headless environment where no FTL templates are being created and the pages app is not used, block definitions have no need for a templateId. Without it, the block functions as expected and has no errors. When templateId is added, because the docs say it's required, it results in an error shown in the definitions/problems app similar to this:

Documentation needs to be updated to say it's optional 

Steps to Replicate on Demo instance:

  1. Import the attached yaml to /travel-demo-stories-app/blocks in the resources workspace
  2. Look at the definitions app and see a MAJOR error in the problems tab
  3. Modify basicText.yaml by commenting out the templateId line and save
  4. Look at the definitions app again and see the error is removed

basicText block can be added to /travel-demo-stories-app/decorations/stories-app/apps/stories.yaml and used with or without the templateId property.


Generated at Mon Feb 12 01:29:43 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.