fix: correct inaccurate code examples and broken links in /integrate/storage/ - #394
fix: correct inaccurate code examples and broken links in /integrate/storage/#394Iamfle4ka wants to merge 1 commit into
Conversation
…storage/ docs Fixes PRDCT-367 - Add missing required 'url' parameter to all PHP Client constructor examples - Add missing required 'url' parameter to all R SapiClient constructor examples - Replace deprecated Apiary link with api.keboola.com link for async export - Fix broken anchor #clients -> #storage-api-clients in importer.md - Fix typo 'avaialable' -> 'available' in importer.md - Fix grammar 'other then' -> 'other than the' in docker-cli-client.md Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: needs_human (risk 2/5) · profile docs
Docs PR with verified hygiene fixes plus unverifiable product-behaviour claims in code examples — route to a human.
Concerns:
integrate/storage/r-client.md: Prose now claims url is a required constructor arg — unverifiable from diff.integrate/storage/php-client.md: Adds required url param to 5 code examples — product behaviour unverifiable.
Suggested reviewers: @keboola/docs
|
Superseded by #410, which carries all five files unchanged. Open 43 days with no human review. The bot escalated the two claims it could not check from the diff, and both are now confirmed against the client sources — they were not style changes, the examples were unrunnable without them:
Branch stays cherry-pickable. |
Jira issue(s): PRDCT-367
Changes:
'url'param to all 5new Client([...])examples — currentstorage-api-php-clientthrowsInvalidArgumentException('url must be set')without iturlparam to all 4SapiClient$new(...)examples —sapi-r-client/R/client.Rinitialize(token, url, ...)has no default forurl; also fix the prose that said "only required argument is a token"keboola.docs.apiary.io/...) withapi.keboola.com/?service=storage#post-/.../export-async#clients→#storage-api-clients(actual heading in index.md)avaialable→availableother then→other than theThis PR contains only unambiguous fixes from the PRDCT-367 audit (4 code-accuracy items + 2 hygiene items). Zero
needs_humanrows are touched. The full audit log (Block 0 + A/B/C + summary) is posted as a comment on the Linear issue.Release Notes
Justification, description
Fix broken code examples (missing required
urlconstructor param in PHP and R client docs), replace a deprecated Apiary link, fix a broken internal anchor, and correct two typos. All verified against current source repos.Plans for Customer Communication
N/A
Impact Analysis
N/A — docs-only changes, no runtime impact.
Deployment Plan
Merge to master → auto-deploy.
Rollback Plan
Revert the commit.
Post-Release Support Plan
N/A
Link to Devin session: https://app.devin.ai/sessions/3e7314816f4c44c081662be3da903e5b
Requested by: @Iamfle4ka