Clarify `ApiBase::request()` vs `OCS::request()` return contract
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 36.9k
- Forks
- 5.2k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 713
Description
OCS::request() overrides ApiBase::request() but changes the effective return contract.
ApiBase::request()returns the rawIResponse::getBody()valueOCS::request()decodes that response and returns OCS data as an array
This is currently only a PHPDoc mismatch, but it makes the API contract unclear and complicates adding native return types.
Follow-up: consider splitting raw-response and decoded-OCS responsibilities into separate methods before adding explicit return types.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading lib/private/Remote/Api/ApiBase.php and lib/private/Remote/Api/OCS.php at the referenced request() methods, then compare their PHPDoc with lib/public/Http/Client/IResponse.php. Done means the documentation clearly distinguishes the raw response body from decoded OCS data; the proposed method split is noted as follow-up work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, backend
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100