Skip to content

Commit eef84e3

Browse files
committed
Few incremental improvements
1 parent a6419e2 commit eef84e3

File tree

7 files changed

+27
-137
lines changed

7 files changed

+27
-137
lines changed

src/version2/issueSearch.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,8 @@ export class IssueSearch {
468468
* Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately
469469
* visible in the returned search results.
470470
*
471-
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency,
472-
* you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
471+
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/)
472+
* consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
473473
*
474474
* If the JQL query expression is too large to be encoded as a query parameter, use the
475475
* [POST](#searchforissuesusingjqlenhancedsearchpost) version of this resource.
@@ -492,8 +492,8 @@ export class IssueSearch {
492492
* Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately
493493
* visible in the returned search results.
494494
*
495-
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency,
496-
* you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
495+
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/)
496+
* consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
497497
*
498498
* If the JQL query expression is too large to be encoded as a query parameter, use the
499499
* [POST](#searchforissuesusingjqlenhancedsearchpost) version of this resource.
@@ -538,11 +538,11 @@ export class IssueSearch {
538538
/**
539539
* Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).
540540
*
541-
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency,
542-
* you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
541+
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/)
542+
* consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
543543
*
544-
* There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL query
545-
* expressions.
544+
* There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL
545+
* query expressions.
546546
*
547547
* This operation can be accessed anonymously.
548548
*
@@ -561,11 +561,11 @@ export class IssueSearch {
561561
/**
562562
* Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).
563563
*
564-
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency,
565-
* you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
564+
* If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/)
565+
* consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances.
566566
*
567-
* There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL query
568-
* expressions.
567+
* There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL
568+
* query expressions.
569569
*
570570
* This operation can be accessed anonymously.
571571
*

src/version2/jiraExpressions.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -343,9 +343,9 @@ export class JiraExpressions {
343343
/**
344344
* Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint
345345
* uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly
346-
* consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for
347-
* JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view
348-
* (backed by `startAt` and `totalCount`).
346+
* consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for JQL
347+
* evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by
348+
* `startAt` and `totalCount`).
349349
*
350350
* This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible
351351
* way. Consult the [Jira expressions
@@ -382,8 +382,8 @@ export class JiraExpressions {
382382
* The current customer request. Available only when the customer request is provided in the request context
383383
* object.
384384
*
385-
* In addition, you can pass custom context variables along with their types. You can then access them from
386-
* the Jira expression by key. You can use the following variables in a custom context:
385+
* In addition, you can pass custom context variables along with their types. You can then access them from the Jira
386+
* expression by key. You can use the following variables in a custom context:
387387
*
388388
* - `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)
389389
* specified as an Atlassian account ID.
@@ -406,9 +406,9 @@ export class JiraExpressions {
406406
/**
407407
* Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint
408408
* uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly
409-
* consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for
410-
* JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view
411-
* (backed by `startAt` and `totalCount`).
409+
* consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for JQL
410+
* evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by
411+
* `startAt` and `totalCount`).
412412
*
413413
* This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible
414414
* way. Consult the [Jira expressions
@@ -445,8 +445,8 @@ export class JiraExpressions {
445445
* The current customer request. Available only when the customer request is provided in the request context
446446
* object.
447447
*
448-
* In addition, you can pass custom context variables along with their types. You can then access them from
449-
* the Jira expression by key. You can use the following variables in a custom context:
448+
* In addition, you can pass custom context variables along with their types. You can then access them from the Jira
449+
* expression by key. You can use the following variables in a custom context:
450450
*
451451
* - `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)
452452
* specified as an Atlassian account ID.

src/version3/models/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
export * from './jiraExpressionEvaluateRequest';
21
export * from './updateDefaultProjectClassification';
32
export * from './workflowUpdateRequest';
43
export * from './mappingsByIssueTypeOverride';

src/version3/models/jExpEvaluateMetaData.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ import { JiraExpressionsComplexity } from './jiraExpressionsComplexity';
33

44
export interface JExpEvaluateMetaData {
55
/**
6-
* Contains information about the expression complexity. For example, the number of steps it took to
7-
* evaluate the expression.
6+
* Contains information about the expression complexity. For example, the number of steps it took to evaluate the
7+
* expression.
88
*/
99
complexity?: JiraExpressionsComplexity;
1010
/**
11-
* Contains information about the `issues` variable in the context. For example, is the issues were loaded
12-
* with JQL, information about the page will be included here.
11+
* Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL,
12+
* information about the page will be included here.
1313
*/
1414
issues?: JExpEvaluateIssuesMeta;
1515
}

src/version3/models/jiraExpressionEvaluateRequest.ts

Lines changed: 0 additions & 11 deletions
This file was deleted.

src/version3/parameters/evaluateJSISJiraExpression.ts

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 1 addition & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1 @@
1-
export interface SearchAndReconsileIssuesUsingJql {
2-
/**
3-
* A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this field requires a
4-
* bounded query. A bounded query is a query with a search restriction.
5-
*
6-
* Example of an unbounded query: `order by key desc`. Example of a bounded query: `assignee = currentUser() order by
7-
* key`.
8-
*/
9-
jql?: string;
10-
/**
11-
* The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the
12-
* `nextPageToken` to fetch the next page of issues.
13-
*/
14-
nextPageToken?: string;
15-
/**
16-
* The maximum number of items to return. Depending on search criteria, real number of items returned may be smaller.
17-
* It returns max 5000 issues.
18-
*/
19-
maxResults?: number;
20-
/**
21-
* A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a
22-
* comma-separated list. Expand options include:
23-
*
24-
* - `*all` Returns all fields.
25-
* - `*navigable` Returns navigable fields.
26-
* - `id` Returns only issue IDs.
27-
* - Any issue field, prefixed with a minus to exclude.
28-
*
29-
* The default is `id`.
30-
*
31-
* Examples:
32-
* - `summary,comment` Returns only the summary and comments fields only.
33-
* - `-description` Returns all navigable (default) fields except description.
34-
* - `*all,-comment` Returns all fields except comments.
35-
*
36-
* Multiple `fields` parameters can be included in a request.
37-
*
38-
* Note: By default, this resource returns IDs only. This differs from [GET
39-
* issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
40-
*/
41-
fields?: ('*all' | '*navigable' | 'id' | `-${string}` | string)[] | '*all' | '*navigable' | 'id' | string;
42-
/**
43-
* Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional
44-
* information about issues in the response. Note that, unlike the majority of instances where `expand` is specified,
45-
* `expand` is defined as a list of values. The expand options are:
46-
*
47-
* - `renderedFields` Returns field values rendered in HTML format.
48-
* - `names` Returns the display name of each field.
49-
* - `schema` Returns the schema describing a field type.
50-
* - `transitions` Returns all possible transitions for the issue.
51-
* - `operations` Returns all possible operations for the issue.
52-
* - `editmeta` Returns information about how each field can be edited.
53-
* - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
54-
* - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each
55-
* version of a field's value, with the highest numbered item representing the most recent version.
56-
*/
57-
expand?:
58-
| 'renderedFields'
59-
| 'names'
60-
| 'schema'
61-
| 'transitions'
62-
| 'operations'
63-
| 'editmeta'
64-
| 'changelog'
65-
| 'versionedRepresentations'
66-
| string
67-
| (
68-
| 'renderedFields'
69-
| 'names'
70-
| 'schema'
71-
| 'transitions'
72-
| 'operations'
73-
| 'editmeta'
74-
| 'changelog'
75-
| 'versionedRepresentations'
76-
| string
77-
)[];
78-
/** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */
79-
properties?: string[];
80-
/** Reference fields by their key (rather than ID). The default is `false`. */
81-
fieldsByKeys?: boolean;
82-
/** Fail this request early if we can't retrieve all field data. */
83-
failFast?: boolean;
84-
/** Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. All issues must exist. */
85-
reconcileIssues?: number[];
86-
}
1+

0 commit comments

Comments
 (0)