Document that the ?include parameter is needed for this to work

Created on 3 April 2024, 9 months ago
Updated 28 August 2024, 4 months ago

Problem/Motivation

The module description points out the use of &jsonapi_include=1 parameter.

But it misses to point out that this requires the ?include parameter to be used for this to work.

Eventually you could also mark that part in the screenshot on the module page and not just the &jsonapi_include=1 parameter?

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Closed: works as designed

Version

1.0

Component

Documentation

Created by

🇩🇪Germany Anybody Porta Westfalica

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

Comments & Activities

  • Issue created by @Anybody
  • Status changed to Closed: works as designed 4 months ago
  • 🇯🇵Japan ptmkenny

    I think this was addressed by the changes to the README and project page in 📌 Document what this module actually does and what the settings mean Fixed . The `?include` parameter is part of JSON:API and not specific to this module.

    That said, it is now shown clearly in the example URL on the project page and in the README.

    It's also worth noting (and now added to the README) that you can use JSON:API Extras module to set the include parameter automatically so you don't need it in the URL.

Production build 0.71.5 2024