Skip to content

Commit

Permalink
Add new fields, operators and functions
Browse files Browse the repository at this point in the history
  • Loading branch information
@albiberto
albiberto committed Jan 30, 2024
1 parent d01e0e9 commit ee6913b
Showing 1 changed file with 68 additions and 52 deletions.
120 changes: 68 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,58 +97,73 @@ JqlBuilder.Query

The following table lists the supported fields and their corresponding types, along with the supported functions and operations grouped by type

### Supported Fields

| Fields | TYPE |
|-----------------|-----------------|
| AffectedVersion | VERSION |
| Assignee | HISTORICAL_USER |
| Attachment | ATTACHMENT |
| Category | CATEGORY |
| Component | COMPONENT |
| Creator | USER |
| Due | DATE |
| DueDate | DATE |
| FixVersion | VERSION |
| Id | ISSUE |
| Issue | ISSUE |
| IssueKey | ISSUE |
| IssueType | TYPE |
| Key | ISSUE |
| Labels | LABELS |
| Parent | PARENT |
| Priority | PRIORITY |
| Project | PROJECT |
| Reporter | HISTORICAL_USER |
| Sprint | SPRINT |
| Status | STATUS |
| Summary | TEXT |
| Type | TYPE |
| Voter | USER |
| Watcher | USER |

### Supported Operators

| Fields | TYPE |
|-----------------|------------------------------------------------------------------------------------------------|
| VERSION | = , != , > , >= , < , <=, IS, IS NOT, IN, NOT IN |
| HISTORICAL_USER | = , !=, IS, IS NOT, IN, NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
| ATTACHMENT | IS, IS NOT |
| CATEGORY | =, !=, IS, IS NOT, IN, NOT IN |
| TEXT | ~ , !~ |
| COMPONENT | = , !=, IS , IS NOT , IN , NOT IN |
| DATE | = , != , > , >= , < , <= IS , IS NOT , IN , NOT IN |
| USER | ~ , !~ , > , >= , < , <= CHANGED, WAS, WAS IN, WAS NOT, WAS NOT IN |
| ISSUE | = , != , > , >= , < , <=, IN, NOT IN |
| LABELS | = , !=, IS, IS NOT, IN, NOT IN |
| PARENT | =, !=, IN, NOT IN |
| PRIORITY | = , != , > , >= , < , <= IS , IS NOT, IN , NOT IN , WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
| PROJECT | = , !=, IS , IS NOT, IN , NOT IN |
| SPRINT | = , !=, IS , IS NOT, IN , NOT IN |
| STATUS | = , != , > , >= , < , <= IS , IS NOT, IN , NOT IN , WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
| Type | = , !=, IS , IS NOT , IN , NOT IN |

### Supported Functions
### Supported Fields by Type

| Fields | TYPE | Notes |
|-----------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------|
| affectedVersion | VERSION | |
| assignee | HISTORICAL_USER | |
| attachment | ATTACHMENT | |
| category | CATEGORY | |
| component | COMPONENT | |
| creator | USER | |
| due | DATE | |
| dueDate | DATE | |
| fixVersion | VERSION | |
| id | ISSUE | |
| issue | ISSUE | |
| issueKey | ISSUE | |
| issueType | TYPE | |
| key | ISSUE | |
| labels | LABELS | |
| parent | PARENT | |
| priority | PRIORITY | |
| project | PROJECT | |
| reporter | HISTORICAL_USER | |
| sprint | SPRINT | |
| status | STATUS | |
| summary | TEXT | |
| type | TYPE | |
| voter | USER | |
| watcher | USER | |
| "epic link" | EPIC_LINK | |
| filter | FILTER | |
| request | FILTER | |
| savedFilter | FILTER | |
| searchRequest | FILTER | |
| projectType | PROJECT_TYPE | |
| issueLink | ISSUE_LINK | |
| issueLinkType | ISSUE_LINK | Where LinkType is a variable you replace with the issue link type (blocks, duplicates, or is blocked by, for example) |
| issueLink["LinkType"] | ISSUE_LINK | Where LinkType is a variable you replace with the issue link type (blocks, duplicates, or is blocked by, for example) |
| issueLinkType | ISSUE_LINK_TYPE | |

### Supported Operators by Type

| Fields | TYPE |
|-----------------|---------------------------------------------------------------------------------------|
| VERSION | =, !=, >, >=, <, <=, IS, IS NOT, IN, NOT IN |
| HISTORICAL_USER | =, !=, IS, IS NOT, IN, NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
| ATTACHMENT | IS, IS NOT |
| CATEGORY | =, !=, IS, IS NOT, IN, NOT IN |
| TEXT | ~, !~ |
| COMPONENT | =, !=, IS, IS NOT, IN, NOT IN |
| DATE | =, !=, >, >=, <, <=, IS, IS NOT, IN, NOT IN |
| USER | ~, !~, >, >=, <, <= CHANGED, WAS, WAS IN, WAS NOT, WAS NOT IN |
| ISSUE | =, !=, >, >=, <, <=, IN, NOT IN |
| LABELS | =, !=, IS, IS NOT, IN, NOT IN |
| PARENT | = !=, IN, NOT IN |
| PRIORITY | =, !=, >, >=, <, <= IS, IS NOT, IN, NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
| PROJECT | =, !=, IS, IS NOT, IN, NOT IN |
| SPRINT | =, !=, IS, IS NOT, IN, NOT IN |
| STATUS | =, !=, >, >=, <, <= IS, IS NOT, IN, NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
| TYPE | =, !=, IS, IS NOT, IN, NOT IN |
| EPIC_LINK | =, !=, IS, IS NOT, IN, NOT IN |
| FILTER | =, !=, IN, NOT IN |
| PROJECT_TYPE | =, !=, IN, NOT IN |
| ISSUE_LINK | =, !=, IN, NOT IN |
| ISSUE_LINK_TYPE | =, !=, IN, NOT IN |

### Supported Functions by Type

| Type | Functions |
|-----------------|------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -160,3 +175,4 @@ The following table lists the supported fields and their corresponding types, al
| HISTORICAL_USER | membersOf, currentUser |
| SPRINT | openSprints, closedSprints |
| COMPONENT | componentsLeadByUser |
| PROJECT_TYPE | issueHistory, votedIssues, watchedIssues, linkedIssues |

0 comments on commit ee6913b

Please sign in to comment.