Problem/Motivation

In #2835767: Media + REST: comprehensive test coverage for Media + MediaType entity types, we excluded the Media module's entities from being exposed as REST resources. We did that because while a lot of effort had been put in making sure the Media entity was rock solid for 8.4.0, no attention had been paid at all yet to the normalization (and serialization) of Media entities.

Rather than causing regressions and BC breaks in the future by needing to fix the normalizations of the Media module's entities, we chose to limit the API surface. Which means we'll be able to ship a well-considered normalization of Media & Media Type entities, and not cause BC breaks.

At #2835767-38: Media + REST: comprehensive test coverage for Media + MediaType entity types, it was decided to ship the current Media module entities' normalization (primarily to provide a stable upgrade path from Media in contrib), and warn in the release notes that they're bound to change. In this issue, we should decide how we need that normalization to evolve.

Proposed resolution

TBD

Remaining tasks

User interface changes

None.

API changes

None: only API addition.

Data model changes

None.

Comments

Wim Leers created an issue. See original summary.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented
Title: Agree on normalization of Media module entities » Decide on normalization of Media module entities
Issue summary: View changes
Related issues: +#2825487: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field

As of #2835767-44: Media + REST: comprehensive test coverage for Media + MediaType entity types, #2835767 changed direction. Updated this IS accordingly.

xjm’s picture

xjm
she/her
Primary language English
CreditAttribution: xjm at Acquia commented

Note that I think this should be directly postponed on #2825487: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field as well.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented
Title: Decide on normalization of Media module entities » [PP-1] Decide on normalization of Media module entities

Done. Also posted that at #2825487-78: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented
Title: [PP-1] Decide on normalization of Media module entities » [PP-2] Decide on normalization of Media module entities
Related issues: +#2871591: Allow ComplexData in TypedData to specify computed properties that should be exposed in normalization and other contexts

#2825487: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field is itself also postponed on an issue (#2871591: Allow ComplexData in TypedData to specify computed properties that should be exposed in normalization and other contexts), so postponing this on that too.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented

Note that I don't fully agree with #3 — I think there are things we could already work on and discuss. But I do agree that at the very least, #2825487: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field may set the necessary precedent that will help guide this to the right place.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

chr.fritsch’s picture

chr.fritsch
he/him
Primary language German
Location 🇩🇪🇪🇺🌍
CreditAttribution: chr.fritsch at Thunder commented
Title: [PP-2] Decide on normalization of Media module entities » [PP-1] Decide on normalization of Media module entities

#2871591: Allow ComplexData in TypedData to specify computed properties that should be exposed in normalization and other contexts landed, so this is coming closer.

chr.fritsch’s picture

chr.fritsch
he/him
Primary language German
Location 🇩🇪🇪🇺🌍
CreditAttribution: chr.fritsch at Thunder commented
Title: [PP-1] Decide on normalization of Media module entities » Decide on normalization of Media module entities
Status: Postponed » Active

#2825487: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field landed. Unblocked

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.