Skip to content

Commit 29ce1c8

Browse files
MrRefactoringMrRefactoring
committed
Few incremental improvements
1 parent 6a05e80 commit 29ce1c8

7 files changed

+286
-0
lines changed

‎src/version3/models/bulkFetchIssueRequest.ts

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
export interface BulkFetchIssueRequest {
2+
/**
3+
* Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the
4+
* majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options
5+
* are:
6+
*
7+
* - `renderedFields` Returns field values rendered in HTML format.
8+
* - `names` Returns the display name of each field.
9+
* - `schema` Returns the schema describing a field type.
10+
* - `transitions` Returns all possible transitions for the issue.
11+
* - `operations` Returns all possible operations for the issue.
12+
* - `editmeta` Returns information about how each field can be edited.
13+
* - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
14+
* - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each
15+
* version of a field's value, with the highest numbered item representing the most recent version.
16+
*/
17+
expand?:
18+
| 'renderedFields'
19+
| 'names'
20+
| 'schema'
21+
| 'transitions'
22+
| 'operations'
23+
| 'editmeta'
24+
| 'changelog'
25+
| 'versionedRepresentations'
26+
| string
27+
| (
28+
| 'renderedFields'
29+
| 'names'
30+
| 'schema'
31+
| 'transitions'
32+
| 'operations'
33+
| 'editmeta'
34+
| 'changelog'
35+
| 'versionedRepresentations'
36+
| string
37+
)[];
38+
/**
39+
* A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a
40+
* comma-separated list. Expand options include:
41+
*
42+
* - `*all` Returns all fields.
43+
* - `*navigable` Returns navigable fields.
44+
* - Any issue field, prefixed with a minus to exclude.
45+
*
46+
* The default is `*navigable`.
47+
*
48+
* Examples:
49+
* - `summary,comment` Returns the summary and comments fields only.
50+
* - `-description` Returns all navigable (default) fields except description.
51+
* - `*all,-comment` Returns all fields except comments.
52+
*
53+
* Multiple `fields` parameters can be included in a request.
54+
*
55+
* Note: All navigable fields are returned by default. This differs from [GET
56+
* issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
57+
*/
58+
fields?: ('*all' | '*navigable' | string)[];
59+
/** Reference fields by their key (rather than ID). The default is `false`. */
60+
fieldsByKeys?: boolean;
61+
/** An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query. */
62+
issueIdsOrKeys: string[];
63+
/**
64+
* A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys
65+
* can be specified.
66+
*/
67+
properties?: string[];
68+
}

‎src/version3/models/idSearchRequestBean.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
export interface IdSearchRequestBean {
2+
/** A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. Order by clauses are not allowed. */
3+
jql?: string;
4+
/** The maximum number of items to return per page. */
5+
maxResults?: number;
6+
/** The continuation token to fetch the next page. This token is provided by the response of this endpoint. */
7+
nextPageToken?: string;
8+
}

‎src/version3/models/index.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
export * from './versionRelatedWork';
2+
export * from './component';
3+
export * from './worklogsMoveRequest';
4+
export * from './searchAndReconcileRequest';
5+
export * from './searchAndReconcileResults';
6+
export * from './idSearchRequestBean';
7+
export * from './idSearchResults';
8+
export * from './jqlCountRequest';
9+
export * from './jqlCount';
10+
export * from './pageOfCreateMetaIssueTypeWithField';
11+
export * from './issueLimitReport';
12+
export * from './pageOfCreateMetaIssueTypes';
13+
export * from './bulkFetchIssueRequest';
14+
export * from './bulkIssue';
15+
export * from './bulkChangelogRequest';
16+
export * from './bulkChangelog';
17+
export * from './workflowUpdateValidateRequestBean';
18+
export * from './workflowUpdate';
19+
export * from './workflowValidationErrorList';
20+
export * from './workflowCreateRequest';
21+
export * from './workflowCreate';
22+
export * from './workflowCapabilities';
23+
export * from './workflowRead';
24+
export * from './jqlFunctionPrecomputationGetByIdRequest';
25+
export * from './jqlFunctionPrecomputationGetByIdResponse';
126
export * from './bulkOperationProgress';
227
export * from './issueBulkTransitionPayload';
328
export * from './bulkTransitionGetAvailableTransitions';

‎src/version3/models/searchAndReconcileRequest.ts

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

‎src/version3/models/workflowUpdateValidateRequestBean.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { WorkflowUpdateRequest } from './workflowUpdateRequest';
2+
import { ValidationOptionsForUpdate } from './validationOptionsForUpdate';
3+
4+
export interface WorkflowUpdateValidateRequestBean {
5+
payload: WorkflowUpdateRequest;
6+
validationOptions?: ValidationOptionsForUpdate;
7+
}

‎src/version3/parameters/searchAndReconsileIssuesUsingJql.ts

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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](#expansion) to include additional information about issues in the response. Note that, unlike the
44+
* majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options
45+
* 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+
}

‎src/version3/parameters/searchAndReconsileIssuesUsingJqlPost.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { SearchAndReconcileRequest } from '../models';
2+
3+
export interface SearchAndReconsileIssuesUsingJqlPost extends SearchAndReconcileRequest {}

0 commit comments

Comments
 (0)