Skip to content

docs(s3): document region_name connection parameter#12428

Open
Beandon13 wants to merge 1 commit into
mindsdb:mainfrom
Beandon13:fix/mindsdb-12286-s3-docs
Open

docs(s3): document region_name connection parameter#12428
Beandon13 wants to merge 1 commit into
mindsdb:mainfrom
Beandon13:fix/mindsdb-12286-s3-docs

Conversation

@Beandon13
Copy link
Copy Markdown

Summary

  • Adds the missing region_name parameter to the Amazon S3 integration page (Required/Optional connection parameters list and the CREATE DATABASE example).
  • The parameter is already documented in docs/integrations/data-integrations/all-data-integrations.mdx and honored by the handler, but is absent from the standalone Amazon S3 page.
  • Without it, users hitting endpoints that require an explicit region (or who don't want the implicit GetBucketLocation round trip) have to discover it from issue trackers.

Refs: #12286

Testing

  • Doc-only change. Verified the rendered MDX renders alongside the existing parameter list. No code paths touched.

Adds the missing `region_name` parameter to the Amazon S3 integration
docs. It is already a documented option in
`docs/integrations/data-integrations/all-data-integrations.mdx` and is
honored by the handler, but is absent from the standalone S3 integration
page. Without it, users hitting endpoints that require an explicit
region (or who don't want the implicit `GetBucketLocation` round trip)
have to discover it from issue trackers.

Refs: mindsdb#12286
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


Beandon13 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@entelligence-ai-pr-reviews
Copy link
Copy Markdown
Contributor

EntelligenceAI PR Summary

This PR updates the Amazon S3 integration documentation to document the optional region_name connection parameter.

  • Added region_name to the CREATE DATABASE code snippet in amazon-s3.mdx
  • Included a parameter description covering its purpose and default fallback behavior when omitted
  • Noted potential performance and compatibility implications of not specifying the region

Confidence Score: 5/5 - Safe to Merge

Safe to merge — this PR makes a straightforward documentation-only change to amazon-s3.mdx, adding the optional region_name connection parameter to the CREATE DATABASE code snippet along with a clear description of its purpose, default fallback behavior, and performance/compatibility implications. No logic, runtime, or security concerns are present since this is purely additive documentation. The change accurately reflects real AWS SDK behavior where omitting region_name causes the SDK to fall back to environment/config-based resolution, which is a useful clarification for users.

Key Findings:

  • The change is confined entirely to documentation in amazon-s3.mdx with no code path, configuration logic, or runtime behavior modified.
  • The description of region_name correctly conveys its optional nature and the fallback behavior when omitted, which aligns with how boto3/AWS SDKs handle region resolution.
  • No review comments were generated and heuristic analysis found zero issues across all severity levels, making this a clean documentation-only addition.
Files requiring special attention
  • amazon-s3.mdx

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.

1 participant