From 5a2b31ac71d639d093e76ee91ba843f0ab461978 Mon Sep 17 00:00:00 2001 From: pdogra1299 Date: Wed, 4 Jun 2025 17:57:13 +0530 Subject: [PATCH] docs: update README with author filter notes for Bitbucket Server - Add note that Bitbucket Server requires email address for author filter - Clarify difference between Cloud (username) and Server (email) for author parameter --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8347d4e..bd236f3 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ Returns detailed information about the pull request including: "workspace": "PROJ", // Required - your project key "repository": "my-repo", "state": "OPEN", // Optional: OPEN, MERGED, DECLINED, ALL (default: OPEN) - "author": "username", // Optional: filter by author + "author": "username", // Optional: filter by author (see note below) "limit": 25, // Optional: max results per page (default: 25) "start": 0 // Optional: pagination start index (default: 0) } @@ -139,6 +139,10 @@ Returns a paginated list of pull requests with: - Total count of matching PRs - Pagination info (has_more, next_start) +**Note on Author Filter:** +- For Bitbucket Cloud: Use the username (e.g., "johndoe") +- For Bitbucket Server: Use the full email address (e.g., "john.doe@company.com") + ## Development - `npm run dev` - Watch mode for development