Contrib.social

Document what this module actually does and what the settings mean

Open on Drupal.org →
Created on 24 March 2022, over 2 years ago
Updated 11 September 2024, 3 months ago

I was initially quite confused about the purpose of this module. Why would you use it rather than using core JSON:API includes → ?

The main benefit I can see using this module is simpler/shorter urls, as you don't need to specify the relationship you want to include.
Are there any other benefits?

It would be great to have a summary on the module homepage. As I think it can be confusing to users, they would assume that this module is providing functionality that isn't already part of Drupal core, when this isn't really the case.

I also see disadvantages to using this module. You are deviating away from Drupal core JSON:API functionality, and possibly away from the JSON:API spec. Also there could be performance issues with bringing in lots of relationship data. Would be useful to let new users know about these also.

📌 Task
Status

Fixed

Version

1.0

Component

Documentation

Created by

🇬🇧United Kingdom Leon Kessler

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024