Add Pricefx connector documentation - #608
Merged
Merged
Conversation
RDPerera
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
August 3, 2026 06:29
Contributor
📝 WalkthroughWalkthroughAdded Pricefx connector documentation for authentication, setup, catalog navigation, automation examples, business operations, data management, and platform administration. ChangesPricefx connector documentation
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/connectors/catalog/erp-business/pricefx/action-reference.md`:
- Around line 9886-9890: Remove the duplicate Calculation Grids documentation
block beginning with the acceptCalculationGridItem details section, including
all repeated operations and content through the end of that section. Preserve
the earlier canonical Calculation Grids section and do not merely rename the
heading.
- Around line 18-32: Update the authentication introduction near the
ConnectionConfig field table to replace the inaccurate “three combinations”
count with an explicit list of supported combinations: API-key authentication
using pricefxKey with partition, HTTP Basic authentication using partition,
username, and password without pricefxKey, OAuth 2.0 using oauth2ClientId and
oauth2RefreshToken (with its optional secret), and external JWT using
externalJwtSystemName and externalJwt. Clearly state which fields are mutually
exclusive and preserve the existing optional supporting fields such as tfaCode
and csrfToken.
- Line 248: Update the non-H1 prose headings in the document to sentence case,
including User admin, Product extensions, and Condition records; preserve
capitalization for API identifiers and proper names.
- Line 11673: Replace every occurrence of the Type Codes link in the affected
ERP business action-reference entries with the canonical lowercase hyphenated
URL
https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/data-model-reference/type-codes,
including the entries identified by the review. Preserve the surrounding
descriptions and type-code lists unchanged.
In `@en/docs/connectors/catalog/erp-business/pricefx/overview.md`:
- Line 10: Update the H2 heading in the Pricefx overview documentation from
title case to sentence case, changing “Key Features” to “Key features” while
preserving the heading level.
In `@en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md`:
- Around line 12-21: Align Pricefx authentication documentation so pricefxKey is
presented only as an optional part of the username/password flow, not as a
standalone method. In
en/docs/connectors/catalog/erp-business/pricefx/overview.md at line 21, replace
the standalone “an API key” wording with the optional API-key flow; in
en/docs/connectors/catalog/index.mdx at line 134, remove “API Key” from the auth
summary. The anchor setup-guide.md lines 12-21 requires no direct change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 0f1ff105-8db6-4687-9733-39c850e32f37
📒 Files selected for processing (5)
en/docs/connectors/catalog/erp-business/pricefx/action-reference.mden/docs/connectors/catalog/erp-business/pricefx/overview.mden/docs/connectors/catalog/erp-business/pricefx/setup-guide.mden/docs/connectors/catalog/index.mdxen/sidebars.ts
|
|
||
| [Pricefx](https://www.pricefx.com/) is a cloud-native pricing and revenue management platform that helps enterprises manage price lists, calculation grids, quotes, contracts, and rebate agreements across their sales organization. The `ballerinax/pricefx` connector provides a client for the [Pricefx Backend API](https://api.pricefx.com/), covering master data (products, customers, sellers), pricing (price lists, manual price lists, calculation grids, condition records), sales (quotes, contracts, rebate agreements, sales compensations), and platform administration (users, workflow, data manager, notifications, comments, custom forms, and more). | ||
|
|
||
| ## Key Features |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use sentence case for the H2 heading.
Change ## Key Features to ## Key features.
As per path instructions, non-H1 headings must use sentence case.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@en/docs/connectors/catalog/erp-business/pricefx/overview.md` at line 10,
Update the H2 heading in the Pricefx overview documentation from title case to
sentence case, changing “Key Features” to “Key features” while preserving the
heading level.
Source: Path instructions
Comment on lines
+12
to
+21
| ## Choose an authentication method | ||
|
|
||
| The connector supports several ways to authenticate with Pricefx. Provide exactly one of the following credential combinations. | ||
|
|
||
| ### Username, password, and partition | ||
|
|
||
| The most common setup. Sign in to your Pricefx partition to confirm your user name, password, and partition name. | ||
|
|
||
| :::tip | ||
| Contact Pricefx Support for an API key (`pricefxKey`) if you want the faster `POST /token` exchange. Without one, the connector falls back to HTTP Basic auth (`<partition>/<username>:<password>` on every request), which needs no separate key but is slower per request. |
Contributor
There was a problem hiding this comment.
🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n -C 6 'pricefxKey|oauth2ClientId|externalJwtSystemName|externalJwt' . \
-g '!node_modules/**' \
-g '!build/**'Repository: wso2/docs-integrator
Length of output: 6761
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== docs overview and setup relevant lines =="
sed -n '1,80p' en/docs/connectors/catalog/erp-business/pricefx/overview.md
printf '\n--- setup-guide ---\n'
sed -n '1,80p' en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md
printf '\n--- action reference action/ConnectionConfig ---\n'
sed -n '1,70p' en/docs/connectors/catalog/erp-business/pricefx/action-reference.md
echo "== catalog line =="
sed -n '130,138p' en/docs/connectors/catalog/index.mdx
echo "== auth field mentions =="
rg -n 'auth:\s*"([^"]*)'|Authenticate with|Authentication|API Key|API key' en/docs/connectors en/docs -g '!node_modules/**' -g '!build/**'Repository: wso2/docs-integrator
Length of output: 14294
Align the Pricefx API-key authentication wording.
The setup guide and action reference describe pricefxKey as an optional field inside username/password authentication. The overview and catalog summary still list API Key as a separate method, which can mislead users to configure credentials outside the supported contract.
en/docs/connectors/catalog/erp-business/pricefx/overview.md: Replace “an API key” with wording that matches the optional API-key flow for username/password.en/docs/connectors/catalog/index.mdx: Update theauthsummary to remove standaloneAPI Keyunless a standalone API-key configuration is documented.
📍 Affects 3 files
en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md#L12-L21(this comment)en/docs/connectors/catalog/erp-business/pricefx/overview.md#L21-L21en/docs/connectors/catalog/index.mdx#L134-L134
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md` around lines
12 - 21, Align Pricefx authentication documentation so pricefxKey is presented
only as an optional part of the username/password flow, not as a standalone
method. In en/docs/connectors/catalog/erp-business/pricefx/overview.md at line
21, replace the standalone “an API key” wording with the optional API-key flow;
in en/docs/connectors/catalog/index.mdx at line 134, remove “API Key” from the
auth summary. The anchor setup-guide.md lines 12-21 requires no direct change.
Broken links, images & orphan pages
Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by Summary
Broken links & imagesIntroduced by this PRNo new broken link(s)/image(s) introduced by this PR. ✅ Already on
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/connectors/catalog/erp-business/pricefx/action-reference.md`:
- Around line 1-4: Update the frontmatter title in the action-reference page to
include the primary “Action Reference” keywords matching the URL slug, while
keeping the title more descriptive and longer than the concise slug; ensure the
rendered H1 derives from this updated title.
- Line 4176: Update the `exportQuotePdf` sample assignment and the corresponding
occurrences at the specified locations to use a complete inline Ballerina record
type, replacing the incomplete `record result` declaration with `record {}
result` while preserving the existing calls and variables.
- Line 31: Update the authentication-mode descriptions in the Pricefx action
reference, including the direct jwt entry and the re-authenticating client
entry, to explicitly document refresh and retry behavior for each mode.
Distinguish retries for idempotent read-like operations from POST, PUT, PATCH,
and DELETE operations, and preserve the direct jwt behavior of surfacing
rejected-token errors without refresh.
In `@en/docs/connectors/catalog/erp-business/pricefx/setup-guide.md`:
- Line 16: Update the authentication headings in the setup guide, including the
headings near the referenced sections, to use sentence case by lowercasing
generic words while preserving protocol names and acronyms such as “Basic” and
“API” where applicable.
- Around line 90-99: Update the PEM code fence in the setup guide to include the
supported bash language identifier, changing the opening fence while preserving
the key contents and closing fence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 801db0df-1f82-459a-b741-3668f2afdae5
📒 Files selected for processing (3)
en/docs/connectors/catalog/erp-business/pricefx/action-reference.mden/docs/connectors/catalog/erp-business/pricefx/overview.mden/docs/connectors/catalog/erp-business/pricefx/setup-guide.md
🚧 Files skipped from review as they are similar to previous changes (1)
- en/docs/connectors/catalog/erp-business/pricefx/overview.md
| | `username` | <code>string</code> | Optional | Your Pricefx username | | ||
| | `password` | <code>string</code> | Optional | Your Pricefx password | | ||
| | `partition` | <code>string</code> | Optional | Your Pricefx partition name | | ||
| | `jwt` | <code>string</code> | Optional | A Pricefx-issued JWT you already hold, sent directly as the `X-PriceFx-jwt` header, with no exchange. Intended for the non-expiring integration tokens produced by `generateJwtToken` (or the time-limited ones from `generateTimedJwtToken`). Cannot be refreshed by the connector - a rejected token surfaces as an error rather than being retried, so avoid pasting in a short-lived session token here | |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n -C 3 're-authenticat|retry|jwt|externalJwt|oauth2RefreshToken' --glob '*.bal' --glob '*.md' .Repository: wso2/docs-integrator
Length of output: 50379
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Locate the referenced Pricefx connector files without relying on the exact path.
printf 'Candidate files:\n'
find . -path '*/pricefx/*' -type f | sed 's#^\./##' | sort
printf '\nReferenced markdown section:\n'
sed -n '1,90p' en/docs/connectors/catalog/erp-business/pricefx/action-reference.md 2>/dev/null || true
printf '\nBallina connector code snippets:\n'
rg -n -C 4 'Jwt|jwt|externalJwt|oauth2RefreshToken|unauth|retry|M401|401' --glob '*.bal' --glob '*.md' .Repository: wso2/docs-integrator
Length of output: 50379
🏁 Script executed:
#!/bin/bash
set -euo pipefail
TARGET="en/docs/connectors/catalog/erp-business/pricefx/action-reference.md"
printf 'Referenced markdown section:\n'
sed -n '1,110p' "$TARGET"
printf '\nPricefx balance file list:\n'
find . -path '*/pricefx/*' -name '*.bal' -type f | sort
printf '\nSharp authentication/retry search in tracked files:\n'
rg -n -C 5 'JwtIssuerConfig|externalJwtToken|oauth2RefreshToken|oauth2Config|oauth2RefreshTokenGrant|unauthenticated|unauth|retry|idempot|non-idemp|side-effect|POST|PATCH|DELETE|PUT' --glob '*.bal' --glob '*.md' .Repository: wso2/docs-integrator
Length of output: 50379
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Referenced file:\n'
sed -n '1,110p' en/docs/connectors/catalog/erp-business/pricefx/action-reference.md
printf '\nDirect pricefx Bal source files:\n'
fd -a -t f '\.bal$' . | rg '/pricefx/|pricefx' || true
printf '\nFocused Balance connector search (no large md output):\n'
rg -n -C 4 'JwtIssuerConfig|externalJwtToken|oauth2RefreshToken|oauth2Config|oauth2RefreshTokenGrant|unauthenticated|unauth|retry|idempot|non-idemp|side-effect|POST|PATCH|DELETE|PUT' --glob '*.bal' --glob '!en/docs/connectors/catalog/erp-business/pricefx/**' .Repository: wso2/docs-integrator
Length of output: 6075
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf 'Repo files containing pricefx:\n'
git ls-files | rg 'pricefx|ballerinax/pricefx' || true
printf '\nFocused Balance connector search:\n'
rg -n -C 4 'JwtIssuerConfig|externalJwtToken|oauth2RefreshToken|oauth2Config|oauth2RefreshTokenGrant|unauthenticated|unauth|retry|idempot|non-idemp|side-effect|POST|PATCH|DELETE|PUT' --glob '*.bal' --glob 'en/docs/connectors/catalog/**' .Repository: wso2/docs-integrator
Length of output: 50379
Document the retry policy for each authentication mode.
Line 31 says the direct jwt mode fails on a rejected token without refresh or retry, while line 41 says the client re-authenticates and retries for unauthenticated responses. Make the policy explicit for each supported mode, and add behavior for idempotent read-like operations versus POST/PUT/PATCH/DELETE operations.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@en/docs/connectors/catalog/erp-business/pricefx/action-reference.md` at line
31, Update the authentication-mode descriptions in the Pricefx action reference,
including the direct jwt entry and the re-authenticating client entry, to
explicitly document refresh and retry behavior for each mode. Distinguish
retries for idempotent read-like operations from POST, PUT, PATCH, and DELETE
operations, and preserve the direct jwt behavior of surfacing rejected-token
errors without refresh.
Contributor
Author
There was a problem hiding this comment.
Intentional — jwt mode has no refresh path and surfaces the error directly, since it holds no credentials to re-authenticate with. Username/password, OAuth 2.0, and external-JWT all get one retry after re-authenticating. That difference is by design, not an oversight.
Contributor
There was a problem hiding this comment.
@RDPerera, understood. The authentication-mode difference is intentional.
The finding concerns documentation clarity, not a functional defect. Please state that jwt mode does not refresh or retry, and that username/password, OAuth 2.0, and external-JWT modes re-authenticate and retry once. Also state whether that single retry applies to POST, PUT, PATCH, and DELETE operations.
🐇
✏️ Learnings added
Learnt from: RDPerera
Repo: wso2/docs-integrator PR: 608
File: en/docs/connectors/catalog/erp-business/pricefx/action-reference.md:0-0
Timestamp: 2026-08-03T17:00:11.681Z
Learning: In `wso2/docs-integrator` Pricefx connector documentation, direct `jwt` authentication has no credentials for re-authentication. If its token is rejected, the connector surfaces the error without refresh or retry. Username/password, OAuth 2.0, and external-JWT authentication modes re-authenticate and retry once after an authentication failure.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
🧠 Learnings used
Learnt from: Nuvindu
Repo: wso2/docs-integrator PR: 528
File: en/docs/connectors/catalog/storage-file/microsoft.sharepoint.pages/overview.md:39-39
Timestamp: 2026-06-12T05:15:37.704Z
Learning: In wso2/docs-integrator, the connector catalog documentation pages under `en/docs/connectors/catalog/` (e.g., `overview.md`, `setup-guide.md`, `action-reference.md`) are produced by an automated workflow from a shared template. During code reviews, do not propose wording/spelling/punctuation or style edits (for example changing hyphenation like `open source` → `open-source`) that would diverge from the template’s consistent, auto-generated catalog style and could cause mismatches with the rest of the generated connector documentation.
You are interacting with an AI system.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
en/docs/connectors/catalog/erp-business/pricefx/example.md (1)
93-97: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winAdd the log-action details.
State where to select the log action and how to set its message to the result variable configured in Step 7. The current instruction does not provide enough text to reproduce the final flow without relying on the screenshot.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/docs/connectors/catalog/erp-business/pricefx/example.md` around lines 93 - 97, Expand Step 8 to specify where to select the log action in the visual flow and how to configure its message using the result variable created in Step 7, so users can reproduce the completed flow without relying on the screenshot.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/connectors/catalog/erp-business/pricefx/example.md`:
- Around line 103-105: Update the “Deploy to Devant” and “View source on GitHub”
links in the sample documentation to reference the verified companion sample’s
existing path, using a lowercase hyphen-only slug; if that sample is deferred,
remove the entire links section instead.
---
Nitpick comments:
In `@en/docs/connectors/catalog/erp-business/pricefx/example.md`:
- Around line 93-97: Expand Step 8 to specify where to select the log action in
the visual flow and how to configure its message using the result variable
created in Step 7, so users can reproduce the completed flow without relying on
the screenshot.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 406c752c-dd7b-4649-be65-f1a9d7d84c2a
⛔ Files ignored due to path filters (6)
en/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_01_palette.pngis excluded by!**/*.pngen/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_02_connection_form.pngis excluded by!**/*.pngen/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_03_connections_list.pngis excluded by!**/*.pngen/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_04_operations_panel.pngis excluded by!**/*.pngen/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_05_operation_form.pngis excluded by!**/*.pngen/static/img/connectors/catalog/erp-business/pricefx/example/ballerinax_pricefx_screenshot_06_completed_flow.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/docs/connectors/catalog/erp-business/pricefx/example.mden/sidebars.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- en/sidebars.ts
daneshk
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ballerinax/pricefxconnector (currently unreleased, tracked in Add Pricefx connector ballerina-platform/module-ballerinax-pricefx#1)client.bal, grouped by resource area (Products, Customers, Sellers, Price Lists, Manual Price Lists, Calculation Grids, Quotes, Contracts, Rebate Agreements, Sales Compensations, Attachments, Authentication, and more), generated from the real source and the connector's OpenAPI spec tagsScreen.Recording.2026-08-03.at.22.04.58.mov
Summary by CodeRabbit