Problem/Motivation

This came up in a discussion with @xjm.

This is similar to #3037804: Document the extent of JSON:API's multilingual support..

The difference is that unlike translations, there is no Drupal magic happening automatically that may set different expectations and results in confusing outcomes. For revisions, it's fortunately simpler: you can only read them.

Proposed resolution

Status report
Help page

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#5 3039966-5.patch2.28 KBwim leers
#5 interdiff.txt1.47 KBwim leers
#3 Screenshot 2019-03-13 at 20.10.07.png386.65 KBwim leers
#3 Screenshot 2019-03-13 at 20.09.32.png129.01 KBwim leers
#3 3039966-3.patch2.32 KBwim leers
#3 interdiff.txt1.04 KBwim leers
#2 3039966-2.patch2.35 KBwim leers

Comments

Wim Leers created an issue. See original summary.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Status: Active » Needs review
StatusFileSize
new 3039966-2.patch2.35 KB
wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Issue summary: View changes
StatusFileSize
new interdiff.txt1.04 KB
new 3039966-3.patch2.32 KB
new Screenshot 2019-03-13 at 20.09.32.png129.01 KB
new Screenshot 2019-03-13 at 20.10.07.png386.65 KB 
jess.myrbo [20:00]
@wim.leers I think we can omit the words "due to limitations in Drupal core" since JSON:API is going to be a part of core. :slightly_smiling_face:
jess.myrbo [20:01]
@wim.leers Proposed changes (and things not to change) LGTM other than that. SS?

Done.

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Needs review » Needs work 
+++ b/jsonapi.module
@@ -99,6 +99,9 @@ function jsonapi_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<dd>' . t('Revision support is currently read-only and only for the "Content" and "Media" entity types in JSON:API due to limitations in Drupal core. See the <a href=":jsonapi-docs">JSON:API revision support documentation</a> for more information on the current status of revision support.', [
+          ':jsonapi-docs' => 'https://www.drupal.org/docs/8/modules/jsonapi/revisions',
+        ]) . '</dd>';

One more. :)

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Status: Needs work » Needs review
StatusFileSize
new interdiff.txt1.47 KB
new 3039966-5.patch2.28 KB

Did #4 and fixed the indentation that caused the coding standards test fail.

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Simple and seems sufficient, thanks @Wim Leers!

Wim Leers credited gabesullice.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented

Also crediting @gabesullice since he played a key role in #3037804: Document the extent of JSON:API's multilingual support., which this was based off.

  • Wim Leers committed 3c7bec2 on 8.x-2.x 
    Issue #3039966 by Wim Leers, xjm, gabesullice: Document the extent of...
wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Status: Reviewed & tested by the community » Fixed

🚢

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.