PRDCT-348: fix code-vs-docs discrepancies in extractors/other - #975
PRDCT-348: fix code-vs-docs discrepancies in extractors/other#975Iamfle4ka wants to merge 4 commits into
Conversation
🤖 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:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: needs_human (risk 3/5) · profile docs
Needs human review: multiple pages introduce new product-behaviour claims that can't be verified from the diff.
Concerns:
src/content/docs/components/extractors/other/github/index.md: Entire config rewritten to v2 PAT/endpoint model; product-behaviour claim unverifiable from diff.src/content/docs/components/extractors/other/azure-cost/index.md: New Type/Aggregation/Granularity fields and 19 dimension enums added; needs product confirmation.src/content/docs/components/extractors/other/airtable/index.md: New Use View and Sync Options params/defaults added; unverifiable product-behaviour claim.
Suggested reviewers: @keboola/docs
Review summaryVerdict: safe to merge with product sign-off. Structurally build-safe — 15 Markdown files, no frontmatter/admonition/code-fence changes, no broken links or images introduced. Typo/hygiene fixes are unambiguously correct. The substantive changes rewrite documented product behavior for several connectors and can't be verified from the docs repo. Please confirm before publishing:
Minor nits:
Automated review pass (Claude Code), flagged for a human maintainer — not an approval. |
|
Thanks @jordanrburger. Notes on the flagged items: Nits — addressed:
Substantive behavior changes — all verified against component source, not guessed. Each was checked against the deployed component's
Full report with exact file/line citations is attached to PRDCT-348. Agree this still warrants product sign-off before publishing — the above is the code evidence to make that check quick. |
Fixes verified against source code repos: - aws-cur-reports: fix copy-paste error in Maximum date description - azure-cost: fix 'art of' typo - time-doctor-2: fix garbled text, rename mislabeled 'users' param to 'increment' - weather-api: add forecast_days limit (1-14), clarify continue_on_failure scope, fix typos - geocoding-augmentation: fix yandex apiKey requirement (not needed per code) - google-search-console: fix sitemaps section text - hibob: add human_readable scope limitation - servicenow: fix screenshot alt text - dynamodb-streams: fix alt text typo - mapbox/pingdom/yourpass: fix typos Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…RDCT-348) - airtable: remove non-existent filter_by_formula, add use_view/view_name and sync_options (sync_mode, date_from, date_to) documentation - github: rewrite config section for v2 component (PAT auth, endpoint multiselect, row-based config with org/repo/issue/commit params) - azure-cost: add type/aggregation/granularity params, enumerate grouping dimension and time frame values, document Service Principal auth - google-search-console: add search_type and include_fresh params, document service account auth option - geocoding: fix provider name openstreetmap -> nominatim to match code - what3words: document lang parameter (default: en) Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
5e575cb to
df3dcbc
Compare
Jira issue(s): PRDCT-348
Changes:
Code-vs-docs audit of all 23 connectors under
components/extractors/other. Compared documented fields, options, defaults, limits and behavior against source code schemas (configSchema.json,configRowSchema.json, PHPConfigDefinition). 20 findings total across 12 connectors with source access.Code-accuracy fixes (schema evidence cited)
Airtable — removed non-existent
filter_by_formulaUI field; addeduse_view/view_nameparams; addedsync_options(sync_mode,date_from,date_to)component-airtable/component_config/configRowSchema.json:47-69, 90-137GitHub — rewrote entire config section: docs described v1 Generic Extractor (OAuth + templates); deployed component is
keboola.ex-github-v2(PAT + endpoint multiselect + row config withorganization_name,repository_owner,repository_name,issue_state,commits_since)component-github/component_config/configSchema.json,configRowSchema.jsonAzure Cost Management — added
type(ActualCost/AmortizedCost/Usage),aggregation(5 values),granularity(None/Daily/Monthly); enumerated all 19 grouping dimension values and 6 time frame options; documented Service Principal authex-azure-cost-management/src/ConfigDefinition.php:16-89Google Search Console — added
search_typefilter,include_freshoption, service account authcomponent-google-search-console/component_config/configRowSchema.json:37-46, 87-98, 183-199Geocoding Augmentation — fixed provider name
openstreetmap→nominatim; fixed Yandex apiKey claim (code passes no key)geocoding-augmentation/src/.../Augmentation.php:224-236,ParametersValidation.php:50-52What3words — added undocumented
langparameter (defaulten)app-what3words/main.php:38-42AWS CUR Reports — "lowest report date" → "highest" (copy-paste from Minimum date)
component-aws-cost-and-usage-reports/component_config/configSchema.json:133Time Doctor 2 — parameter mislabeled
users→ actual nameincrement; fixed garblededit-–ime→edit-time; normalized dash style across the endpoints list to--component-time-doctor-2/component_config/configSchema.json:106-112Weather API — added
forecast_dayslimit (1–14); clarifiedcontinue_on_failureonly in input-table modecomponent-weather-api/component_config/configSchema.json:84-85, 117-119HiBob — added scope clarification:
human_readableonly affects employees tablecomponent-hibob/component_config/configSchema.json:54-58Doc hygiene fixes (typos, alt-text)
yourpass: "YourPasss" → "YourPass", "output tale" → "output table"pingdom: "Last 3O days" → "Last 30 days" (letter O → digit 0)mapbox: "columns with in" → "columns in"dynamodb-streams: alt text "Confguration" → "Configuration"servicenow: alt text "DynamoDB Streams Configuration" → "ServiceNow Configuration"google-search-console: "search analytics report" → "sitemaps report" in Sitemaps sectionazure-cost: "art of the primary key" → "part of"weather-api: "dispite" → "despite", "occurr" → "occur"time-doctor-2: normalized mixed en-dash/--style in endpoints list (per review nit)11 connectors had no accessible source repo and could not be verified: DynamoDB Streams, Dark Sky, Currency Rates, Mapbox, Okta, ServiceNow, YourPass, Pingdom, Papertrail, Stripe, Generic Extractor.
Note:
github/index.mdv2 rewrite is now image-less — the old v1 screenshot no longer matches. A maintainer with UI access should capture a currentkeboola.ex-github-v2screenshot.Release Notes
Justification, description
Documentation accuracy fixes based on code-vs-docs audit of extractors/other connectors. Aligns documented fields, options, defaults, and behavior with actual component schemas.
Plans for Customer Communication
N/A — documentation-only changes.
Impact Analysis
No code changes. Documentation corrections only.
Deployment Plan
Merge to main → auto-deploy to help.keboola.com.
Rollback Plan
Revert PR.
Post-Release Support Plan
N/A
Link to Devin session: https://app.devin.ai/sessions/c360b6efa9804125940654b8cd841f3d
Requested by: @Iamfle4ka