Add a description key to entities

Created on 19 August 2014, about 11 years ago
Updated 22 August 2025, 26 days ago

Problem/Motivation

Split off/Follow up of #1740492: Implement a default entity views data handler β†’

In order to generate the views data, views wants to display some one line description to the user about each entity type.
This functionality could be helpful in various other places.

Proposed resolution

Add a description key to the entity definition and provide a proper description for each entity type.

Remaining tasks

User interface changes

API changes

πŸ“Œ Task
Status

Postponed: needs info

Version

11.0 πŸ”₯

Component

entity system

Created by

πŸ‡©πŸ‡ͺGermany dawehner

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

    Related to the Views in Drupal Core initiative.

  • 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.

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Thank you for creating this issue to improve Drupal.

    We are working to decide if this task is still relevant to a currently supported version of Drupal. There hasn't been any discussion here for over 8 years which suggests that this has either been implemented or is no longer relevant. Your thoughts on this will allow a decision to be made.

    Since we need more information to move forward with this issue, the status is now Postponed (maintainer needs more info). If we don't receive additional information to help with the issue, it may be closed after three months.

    Thanks!

  • πŸ‡ΊπŸ‡ΈUnited States mglaman WI, USA

    This would be great for OpenAPI documentation and other JSON schema documentation generation of entities beyond Views.

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Sure!

Production build 0.71.5 2024