REST views: Add API support for top-level property additions

Created on 20 June 2016, over 9 years ago
Updated 22 September 2025, 9 days ago

Problem/Motivation

Currently REST Views displays cannot make use of Header or Footer areas. These are commonly used for typical HTML views to feature information about the first row, add aggregation data, or simply inject arbitrary content. The same is also needed in collections, such as introducing result counts or adding a "version" property.

Proposed resolution

Add support for Header Areas or a new type of views row plugin that allows one or more properties to be added to the view for merge into the collection structure.

Remaining tasks

Identify path forward, implement.

User interface changes

This would open up new options in the Views UI. This would allow additions to REST collection output.

These are not breaking changes, except in anti-pattern API clients that fail on unrecognized properties in data payloads.

API changes

?

Data model changes

None.

✨ Feature request
Status

Postponed: needs info

Version

11.0 πŸ”₯

Component

rest.module

Created by

πŸ‡ΊπŸ‡ΈUnited States Grayside

Live updates comments and jobs are added and updated live.
  • VDC

    Related to the Views in Drupal Core initiative.

  • Needs issue summary update

    Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

  • API addition

    Enhances an existing API or introduces a new subsystem. Depending on the size and impact, possibly backportable to earlier major versions.

  • Needs change record

    A change record needs to be drafted before an issue is committed. Note: Change records used to be called change notifications.

  • stale-issue-cleanup

    To track issues in the developing policy for closing stale issues, [Policy, no patch] closing older issues

Sign in to follow issues

Comments & Activities

Not all content is available!

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

No activities found.

Production build 0.71.5 2024