Skip to content

Commit

Permalink
VACMS-15055: Add documentation for JSON API breadcrumb configuration.
Browse files Browse the repository at this point in the history
  • Loading branch information
@schiavo
schiavo committed Sep 25, 2023
1 parent e722c88 commit a661e92
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions READMES/jsonapi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit a661e92

Please sign in to comment.