I think we should add a json (not json-ld) example to the rest_help() for GET.

CommentFileSizeAuthor
#5 1909178-rest-help-update-5.patch5.1 KBwiifm
#5 rest4.png57.46 KBwiifm
#4 rest3.png55.95 KBwiifm
#4 1909178-rest-help-update-4.patch5.17 KBwiifm
#2 rest1.png38.21 KBwiifm
#2 rest2.png52.25 KBwiifm
#2 1909178-rest-help-update.patch3.72 KBwiifm
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

moshe weitzman’s picture

moshe weitzman CreditAttribution: moshe weitzman commented

Furthermore, I think we should enhance CreateTest for json content-type. The current test only creates with json-ld

wiifm’s picture

wiifm
Primary language English
Location Wellington, NZ
CreditAttribution: wiifm commented
Status: Active » Needs review
FileSize
1909178-rest-help-update.patch3.72 KB
rest2.png52.25 KB
rest1.png38.21 KB

Attached is a patch to clean up the hook_help() for the rest module. It also adds in additional information next to each checkbox to denote the path the resource will be available on.

@moshe - can the test enhancements be placed in a follow up issue?

Before patch:

rest1.png

After patch:

rest2.png

wiifm’s picture

wiifm
Primary language English
Location Wellington, NZ
CreditAttribution: wiifm commented
Title: Add CURL example for GET to admin/config/services/rest » Cleanup the administration screen and add better help on admin/config/services/rest

Updating the title to reflect the slightly larger scope. Next steps will be to implement the new table select magic from admin/modules.

wiifm’s picture

wiifm
Primary language English
Location Wellington, NZ
CreditAttribution: wiifm commented
FileSize
1909178-rest-help-update-4.patch5.17 KB
rest3.png55.95 KB

Have now implemented theme_tableselect() upon the admin page. This at least provides an extensible way to show more information for each web service.

E.g. possible additions could be 'supported methods', 'permissions' etc

rest3.png

wiifm’s picture

wiifm
Primary language English
Location Wellington, NZ
CreditAttribution: wiifm commented
FileSize
rest4.png57.46 KB
1909178-rest-help-update-5.patch5.1 KB

Improvements based on @moshe weitzman's feedback (text only changes). Now there is also a cURL accept header for JSON LD as an example.

rest4.png

moshe weitzman’s picture

moshe weitzman CreditAttribution: moshe weitzman commented
Status: Needs review » Reviewed & tested by the community
Issue tags: +WSCCI

I think this is a great improvement in text and layout. We could eventually ask plugin implementations to declare their Path instead of special casing for Entity.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented
Status: Reviewed & tested by the community » Fixed

Yay for giving people non-destructive instructions first! ;) This looks like a great improvement.

Committed and pushed to 8.x. Thanks!

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented

Hm. Something is not right. Not sure if it's a problem w/ this patch or not: #1912692: REST module seems to be borked atm.

klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
CreditAttribution: klausi commented
Status: Fixed » Needs work

Yep, the GET help text for nodes is useless right now, since nodes are not converted to EntityNG yet. You need to use entity_test in the GET example.

moshe weitzman’s picture

moshe weitzman CreditAttribution: moshe weitzman commented
Category: bug » feature
Status: Needs work » Postponed
Issue tags: +revisit before beta

Lets just focus on moving nodes to EntityNG. Marking as postponed.

klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
CreditAttribution: klausi commented
Status: Postponed » Closed (won't fix)

The REST admin page has been removed from core. Please help to improve to doc page at https://drupal.org/documentation/modules/rest or report any REST UI problems to the contrib module: https://drupal.org/project/restui

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented
Issue tags: -revisit before beta

Since the screen doesn't exist anymore, there's nothing to revisit before release.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented
Issue summary: View changes

Updated issue summary.