Problem/Motivation

@param $request is missing from get() function of rest/resource/EntityResource.php

Proposed resolution

Add the param in docblock

Remaining tasks

N/A

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A

Original report by [username]

N/A

CommentFileSizeAuthor
#2 3091509-docblock-param-2.patch717 bytessubson

Comments

subson created an issue. See original summary.

subson’s picture

subson commented
Status: Needs work » Needs review
StatusFileSize
new 3091509-docblock-param-2.patch717 bytes

Adding the param to the docblock.

john cook’s picture

john cook commented
Status: Needs review » Reviewed & tested by the community

This improves the documentation by adding the missing parameters to the docblock. The text is in line with other uses of the request in as a parameter.

The patch applies cleanly to the 8.9.x.

There is no changes in functionality and no change of scope.

Setting to RTBC!

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: Missing param from a docblock in get() function of rest/resource/EntityResource.php » Missing param from a docblock in \Drupal\rest\Plugin\rest\resource\EntityResource::get()
Category: Bug report » Task
Priority: Normal » Minor
Issue tags: +API-First Initiative, +Documentation
wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented

👍 Thanks!

🚢 Confirming RTBC.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed a62fb3106a to 9.0.x and 3d3c9b39d0 to 8.9.x and 489f2b8781 to 8.8.x. Thanks!

Backporting to 8.8.x as a docs only fix.

  • alexpott committed a62fb31 on 9.0.x 
    Issue #3091509 by subson, Wim Leers, John Cook: Missing param from a...

  • alexpott committed 3d3c9b3 on 8.9.x 
    Issue #3091509 by subson, Wim Leers, John Cook: Missing param from a...

  • alexpott committed 489f2b8 on 8.8.x 
    Issue #3091509 by subson, Wim Leers, John Cook: Missing param from a...

Status: Fixed » Closed (fixed)

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