Skip to content

fix: correct inaccurate code examples and broken links in /integrate/storage/ - #394

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1782145820-PRDCT-367-storage-audit-fixes
Closed

fix: correct inaccurate code examples and broken links in /integrate/storage/#394
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1782145820-PRDCT-367-storage-audit-fixes

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-367

Changes:

  • php-client.md (A1): Add missing required 'url' param to all 5 new Client([...]) examples — current storage-api-php-client throws InvalidArgumentException('url must be set') without it
  • r-client.md (A3): Add missing required url param to all 4 SapiClient$new(...) examples — sapi-r-client/R/client.R initialize(token, url, ...) has no default for url; also fix the prose that said "only required argument is a token"
  • import-export.md (A5): Replace deprecated Apiary link (keboola.docs.apiary.io/...) with api.keboola.com/?service=storage#post-/.../export-async
  • importer.md (A6): Fix broken anchor #clients#storage-api-clients (actual heading in index.md)
  • importer.md (C1): Fix typo avaialableavailable
  • docker-cli-client.md (C2): Fix grammar other thenother than the

This PR contains only unambiguous fixes from the PRDCT-367 audit (4 code-accuracy items + 2 hygiene items). Zero needs_human rows 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 url constructor 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

…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>
@Iamfle4ka Iamfle4ka self-assigned this Jun 22, 2026
@linear

linear Bot commented Jun 22, 2026

Copy link
Copy Markdown

PRDCT-367

@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@Iamfle4ka
Iamfle4ka marked this pull request as ready for review July 10, 2026 13:53

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

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:

  • storage-api-php-client, Client::__construct: if (!isset($config[url])) { throw new \InvalidArgumentException('url must be set'); }
  • sapi-r-client, R/client.R: initialize = function(token, url, userAgent = ...)url has no default, and the constructor calls trimws(url, ...) on it immediately. Its own docstring calling url "Optional" is wrong, which is probably where the page got it.

Branch stays cherry-pickable.

@Iamfle4ka Iamfle4ka closed this Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants