Skip to content

Incorrect return type annotations for batch requests #179

Open
@marekdedic

Description

@marekdedic

Environment details

  • OS: Debian testing
  • PHP version: 7.3.8

The return type of many API functions is incorrect, missing the option that many functions can return Request, if batch requests are enabled.

For example, the function Google_Service_Drive_Resource_Files::get() normally returns a Google_Service_Drive_DriveFile, as is written in the doc comment.

However, if batch requests are turned on, this function won't return the actual file, but instead a GuzzleHttp\Psr7\Request. This is because the function Google_Service_Drive_Resource_Files::get() calls Google_Service_Resource::call(), which (if batching is enabled) returns the request instead of the response (source).

So the correct PHPDoc return signature for Google_Service_Drive_Resource_Files::get() should be

/**
 * ...
 *
 * @return Google_Service_Drive_DriveFile|Request
 */

Of course, this applies to many more functions than just this one - possibly to all of them, but I am not really sure.

Metadata

Metadata

Assignees

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions