Skip to content

Update Azure Files docs for connector 1.0.1 and drop version pins - #653

Merged
daneshk merged 2 commits into
wso2:5.1.xfrom
YasanPunch:azure-files-docs-1.0.1
Sep 7, 2026
Merged

Update Azure Files docs for connector 1.0.1 and drop version pins#653
daneshk merged 2 commits into
wso2:5.1.xfrom
YasanPunch:azure-files-docs-1.0.1

Conversation

@YasanPunch

@YasanPunch YasanPunch commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #617, syncing the merged Azure Files docs to ballerinax/azure.storage.files 1.0.1, plus a small convention change.

1.0.1 sync

  • RetryPolicyType.FIXEDFIXED_INTERVAL — renamed in 1.0.1. The configuration value stays "fixed", so only the enum member name changes. LeaseDuration.FIXED is a different enum and is deliberately left alone.
  • Catalog card icon — added, now that the package is published on Ballerina Central. The card was falling back to a letter tile because icon was omitted back when 1.0.0 was unpublished.
  • Handler panics — the trigger reference's afterError row now says "returns an error or panics", matching both the 1.0.1 behaviour fix and the wording already in the file-integration guide.

Version pins dropped (Azure Files + FTP)

Rather than bump the Azure Files overview to v1.0.1, the pin is removed. A pinned version goes stale on the next release with nothing to update it — this page was stale within two days of publishing — and readers get the current version from Ballerina Central, which the catalog card already links to. FTP's (v2.19.0) pin is removed for the same reason, as the other file-integration page our team owns that carries one.

The card icon URL keeps its version deliberately: Central's icon CDN requires one in the filename (the versionless URL 404s) and old URLs keep serving, so a pinned icon is invisible to readers.

The remaining pinned pages across the catalog belong to other teams and are tracked in wso2-enterprise/integration-engineering#2751.

The restored onFileCsv string row forms, the other notable 1.0.1 change, were already documented in #632.

Verified by compiling the documented samples against 1.0.1 resolved from Ballerina Central, including files:FIXED_INTERVAL. Site build is clean apart from two pre-existing 5.1.x warnings unrelated to these pages.

- Rename the RetryPolicyType member FIXED to FIXED_INTERVAL (the
  configuration value stays "fixed"); LeaseDuration.FIXED is a separate
  enum and is unchanged.
- Pin the overview to v1.0.1.
- Add the catalog card icon, now that the package is published on
  Ballerina Central.
- Note that a handler panic also triggers afterError, matching the
  file-integration guide.

Claude-Session: https://claude.ai/code/session_01Fei1vWUdteHyjXBFaYUmMT
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: bf2ee644-6026-465c-97ca-6030d164a06e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

Comment thread en/docs/connectors/catalog/storage-file/azure.storage.files/overview.md Outdated
A pinned version goes stale on the next release with nothing to update
it, as the Azure Files page did within two days of publishing. Readers
get the current version from Ballerina Central, which the catalog card
already links to.

The remaining pinned pages are tracked in
wso2-enterprise/integration-engineering#2751.

Claude-Session: https://claude.ai/code/session_01Fei1vWUdteHyjXBFaYUmMT
@YasanPunch YasanPunch changed the title Update Azure Files connector docs for 1.0.1 Update Azure Files docs for connector 1.0.1 and drop version pins Sep 7, 2026
@daneshk
daneshk merged commit 04b3dd9 into wso2:5.1.x Sep 7, 2026
2 checks passed
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.

4 participants