Confusing UI: POST URL differs from GET/PATCH/DELETE URL, but UI doesn't indicate this! [#2800097]

(Blocked / Solved through #2293697: EntityResource POST routes all use the confusing default: use entity types' https://www.drupal.org/link-relations/create link template if available. See comment #2800097-8: Confusing UI: POST URL differs from GET/PATCH/DELETE URL, but UI doesn't indicate this!)

REST UI is a great tool for quickly setting up settings but isn't accurate in it's display of endpoints.

GET Node is /node/{node} but POST node is /entity/node however this is not shown on the UI as seen in the screenshot.

Screenshot

Can this be updated?

Comment	File	Size	Author
#18	Screen Shot 2017-06-08 at 15.19.15.png	283.31 KB	Wim Leers
#14	interdiff-2800097-12-14.txt	906 bytes	clemens.tolboom
#14	confusing_ui_post_url-2800097-14.patch	3.7 KB	clemens.tolboom
#14	8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 Patch Failed to Apply PHP 7 & MySQL 5.5, D8.4 Patch Failed to Apply
#12	2800097-12.patch	3.86 KB	Wim Leers
#12	8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 1 pass PHP 7 & MySQL 5.5, D8.4 1 pass
#12	REST UI — improved path column — user registration.png	4.21 KB	Wim Leers
#12	REST UI — improved path column — 8.4.x.png	118.44 KB	Wim Leers
#12	REST UI — improved path column — 8.3.x.png	120.31 KB	Wim Leers
	Selection_208.png	45 KB	Andy_D

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

14 September 2016 at 16:34

Andy_D created an issue. See original summary.

Comment #2

Andy_D CreditAttribution: Andy_D at Investis Digital commented 14 September 2016 at 16:35

Issue summary:

View changes

Comment #3

Andy_D CreditAttribution: Andy_D at Investis Digital commented 14 September 2016 at 16:36

Issue summary:

View changes

Comment #4

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 17 November 2016 at 22:32

Priority:

Normal

» Major

Major at least I think.

Comment #5

clemens.tolboom

Dutch

Groningen, 🇳🇱/🇪🇺

CreditAttribution: clemens.tolboom as a volunteer commented 23 November 2016 at 13:59

Priority:

Major

» Normal

According to https://www.drupal.org/docs/8/core/modules/rest/3-post-for-creating-cont... aka https://www.drupal.org/node/2098511

In all examples below, we POST to the URL /entity/node. Since Drupal 8.2.0, you are able to POST to /node instead, but /entity/node will continue to work until Drupal 9. [Note: This didn't work with trunk as of 2016/10/15, but the path /entity/node did work. ]

The issue is #2293697: EntityResource POST routes all use the confusing default: use entity types' https://www.drupal.org/link-relations/create link template if available

@Andy_D can you confirm this POST @ /node works on Drupal 8.2.0 then please close the issue as Works as designed.

Comment #6

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 21 November 2016 at 15:21

Well, that was tantalizingly close to being committed, but then eventually didn't make it into Drupal 8.3.

Fixed the docs: https://www.drupal.org/node/2098511/revisions/view/10162711/10216654 (sadly that diff is completely wrong because of the docs migration — the right change is in there, but lots of irrelevant changes are attributed to this new revision too…)

IMO this cannot be closed as working as designed. For the entire Drupal 8.2 cycle, this will continue to confuse end users. It should be fixed.

Comment #7

gvso

Spanish

CreditAttribution: gvso at Google Code-In commented 3 December 2016 at 22:46

Now that we have 1.13 version which works for Drupal >=8.2, could this change be done in versions <= 1.12?

Comment #8

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 9 February 2017 at 12:58

Title:	Confusing interface	» [PP-1] Confusing interface
Category:	Feature request	» Task
Status:	Active	» Postponed
Issue tags:		+Usability

#7: you need to update from Drupal <8.2 to 8.2 anyway: 8.0 and 8.1 are no longer supported. So that doesn't make sense.

Let's just mark this blocked on #2293697: EntityResource POST routes all use the confusing default: use entity types' https://www.drupal.org/link-relations/create link template if available, then this problem will disappear automatically.

Comment #9

clemens.tolboom

Dutch

Groningen, 🇳🇱/🇪🇺

CreditAttribution: clemens.tolboom as a volunteer commented 24 April 2017 at 17:57

Issue summary:

View changes

Comment #10

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 15 May 2017 at 12:24

Title:	[PP-1] Confusing interface	» Confusing UI: POST URL differs from GET/PATCH/DELETE URL, but UI doesn't indicate this!
Version:	8.x-1.11	» 8.x-1.x-dev
Assigned:	Unassigned	» Wim Leers
Status:	Postponed	» Active

#2800097: Confusing UI: POST URL differs from GET/PATCH/DELETE URL, but UI doesn't indicate this! is in! This is now unblocked!

On this now.

Comment #11

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 1 June 2017 at 09:24

Sorry, lost track of this. Will finish it today.

Comment #12

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 1 June 2017 at 12:40

Issue summary:	View changes
Status:	Active	» Needs review

File	Size
REST UI — improved path column — 8.3.x.png	120.31 KB
REST UI — improved path column — 8.4.x.png	118.44 KB
REST UI — improved path column — user registration.png	4.21 KB
2800097-12.patch	3.86 KB
8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 1 pass PHP 7 & MySQL 5.5, D8.4 1 pass

Done.

Changes:

Now shows the POST path (i.e. the create link relation type URI path).
But not if it's a config entity, because config entities remain read-only until #2300677: JSON:API POST/PATCH support for fully validatable config entities is fixed. Related: #2869724: Convert module to use short array syntax (new coding standard)..
If a REST resource plugin supports only canonical (GET/PATCH/DELETE) or only create (POST), it's shown on a single line. Otherwise, we use a <dl> to make it visually clear.
If this REST resource plugin is configured (and either enabled or disabled), it shows the methods that are configured to be disabled as struck through.
Supports both 8.3.x and 8.4.x.

8.3.x
8.4.x
Notes: These are both the exact same configuration (exact same site).; Note that the DELETE method is disabled for Comment.; Note that all methods except POST are disabled for Contact message.; Note that all config entities have that same simplified single-line representation. As does the User registration resource. So this also fixes #2877569: Path /user/register is not presented in the UI:

Comment #13

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 1 June 2017 at 12:41

Comment #14

clemens.tolboom

Dutch

Groningen, 🇳🇱/🇪🇺

CreditAttribution: clemens.tolboom as a volunteer commented 8 June 2017 at 10:53

File	Size
confusing_ui_post_url-2800097-14.patch	3.7 KB
8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 Patch Failed to Apply PHP 7 & MySQL 5.5, D8.4 Patch Failed to Apply
interdiff-2800097-12-14.txt	906 bytes

I don't like the DL and here doc. Changed and commit shortly.

Comment #15

8 June 2017 at 10:55

Wim Leers authored f960ed1 on 8.x-1.x

Issue #2800097 by Wim Leers, clemens.tolboom, Andy_D: Confusing UI: POST...

Comment #16

8 June 2017 at 10:59

Status:

Needs review

» Needs work

The last submitted patch, 14: confusing_ui_post_url-2800097-14.patch, failed testing. View results

Comment #17

clemens.tolboom

Dutch

Groningen, 🇳🇱/🇪🇺

CreditAttribution: clemens.tolboom as a volunteer commented 8 June 2017 at 11:08

Status:

Needs work

» Fixed

I was quicker with commit then testbot

Comment #18

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 8 June 2017 at 13:20

File	Size
Screen Shot 2017-06-08 at 15.19.15.png	283.31 KB

+++ b/src/Controller/RestUIController.php
@@ -188,14 +188,8 @@ class RestUIController implements ContainerInjectionInterface {
-          $uri_paths = <<<HTML
-<dl>
-  <dt><code>$canonical_uri_path

$canonical_methods

$create_uri_path

POST

-HTML;
+ $uri_paths = "$canonical_uri_path: $canonical_methods";
+ $uri_paths.= "$create_uri_path: POST";

This negatively impacted legibility IMHO. OTOH, it does make for higher information density. See screenshot:

Compare this to the screenshots in #12.

You're the maintainer, your call :)

Thanks for getting this committed and tagging a release: https://www.drupal.org/project/restui/releases/8.x-1.15 :)

Comment #19

clemens.tolboom

Dutch

Groningen, 🇳🇱/🇪🇺

CreditAttribution: clemens.tolboom as a volunteer commented 8 June 2017 at 13:51

Thanks for your work!!

Comment #20

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 8 June 2017 at 13:54

Issue tags:

+API-First Initiative

Thank Acquia for sponsoring my time on the API-first Initiative! That's why I'm able to work on these issues :)

Comment #21

clemens.tolboom

Dutch

Groningen, 🇳🇱/🇪🇺

CreditAttribution: clemens.tolboom as a volunteer commented 9 June 2017 at 09:06

I'm currently projectless so can spend time on my d.o projects finally

Comment #22

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers at Acquia commented 9 June 2017 at 14:45

Cool :) (Well, not cool if it lasts too long of course!)

P.S.: I wouldn't mind to see Acquia being added to the list of supporting organizations on the project page. I think that's fair? (Acquia didn't ask me to ask this, you just made me think of that!)