TAN-8139: Source the public API project and folder descriptions from the Content Builder - #14668
Open
EdwinKato wants to merge 16 commits into
Open
TAN-8139: Source the public API project and folder descriptions from the Content Builder#14668EdwinKato wants to merge 16 commits into
EdwinKato wants to merge 16 commits into
Conversation
1 similar comment
Collaborator
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of TAN-8139. Lands before #14434 so that PR no longer has to remove anything from the public API.
The legacy WYSIWYG
description_multilocis on its way out, but three public API fields read it:description_htmlon/api/v1/projectsand/api/v2/projects, anddescription_multiloc/descriptionon/api/v2/project_folders. Dropping the keys would break integrations — our own Power BI template names them explicitly in its M query, so a missing key fails the wholeprojectstable on the next refresh, not just one column.So the fields stay, rebuilt from the layout that superseded the column:
project_pagefor a project,project_folder_descriptionfor a folder.ContentBuilder::Craftjs::VisibleTextualMultilocsalready did the extraction for the admin API; the new service just picks the right layout and hands back a multiloc.Only text widgets carry over. For a project migrated and not edited since, the original HTML sits in one bridge widget and comes back intact — the v1 acceptance spec's existing exact-HTML assertion passes untouched. For a project rebuilt in the page builder, it is a text-only rendering, which is all a plain HTML field can express anyway.
List endpoints preload
content_builder_layoutsand the service scans the loaded association, so there is no N+1. Each record still costs a craftjs walk; worth watching if these endpoints turn out to be busy.Changelog
Technical
builder content instead of the old description field, so they keep working once
that field is removed.