From a661e92da971d896d891beb8a4026f1262ad888d Mon Sep 17 00:00:00 2001 From: Daniel Schiavone Date: Mon, 25 Sep 2023 16:20:11 -0400 Subject: [PATCH] VACMS-15055: Add documentation for JSON API breadcrumb configuration. --- READMES/jsonapi.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/READMES/jsonapi.md b/READMES/jsonapi.md index a886fab99e9..9166c8fe7b6 100644 --- a/READMES/jsonapi.md +++ b/READMES/jsonapi.md @@ -19,3 +19,9 @@ See `/admin/config/services/jsonapi/resource_types` for a full list of informati If you expect to see a field's data included in the response and it is not there, check the overwrites, if any, for that resource and adjust appropriately. See the config at `admin/config/services/jsonapi/resource_types/node--news_story/edit?destination=/admin/config/services/jsonapi/resource_types` for an example. + +**Breadcrumbs and JSON:API** + +In order for breadcrumb data to appear in JSONAPI the computed_breadcrumbs module has been installed. The computed_breadcrumbs module adds a hidden field to content types that stores breadcrumb data via the request. This results in breadcrumb data being included with nodes in the JSON feed. + +Because the primary vehicle for populating breadcrumbs, the menu_breadcrumbs module, is not configured for all content types the easy_breadcrumb module has been added. The easy_breadcrumb module fills in the gap left by menu_breadcrumbs by populating breadcrumbs based on path for content types without breadcrumb data.