diff --git a/src/version2/issueSearch.ts b/src/version2/issueSearch.ts index 54276f6b9..2ee45270b 100644 --- a/src/version2/issueSearch.ts +++ b/src/version2/issueSearch.ts @@ -236,8 +236,8 @@ export class IssueSearch { * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately * visible in the returned search results. * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * * If the JQL query expression is too large to be encoded as a query parameter, use the * [POST](#searchforissuesusingjqlenhancedsearchpost) version of this resource. @@ -260,8 +260,8 @@ export class IssueSearch { * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately * visible in the returned search results. * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * * If the JQL query expression is too large to be encoded as a query parameter, use the * [POST](#searchforissuesusingjqlenhancedsearchpost) version of this resource. @@ -306,11 +306,11 @@ export class IssueSearch { /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * - * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL query - * expressions. + * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL + * query expressions. * * This operation can be accessed anonymously. * @@ -329,11 +329,11 @@ export class IssueSearch { /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * - * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL query - * expressions. + * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL + * query expressions. * * This operation can be accessed anonymously. * diff --git a/src/version2/jiraExpressions.ts b/src/version2/jiraExpressions.ts index 2c71ee4ef..c14a691f3 100644 --- a/src/version2/jiraExpressions.ts +++ b/src/version2/jiraExpressions.ts @@ -194,9 +194,9 @@ export class JiraExpressions { /** * Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint * uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly - * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for - * JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view - * (backed by `startAt` and `totalCount`). + * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for JQL + * evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by + * `startAt` and `totalCount`). * * This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible * way. Consult the [Jira expressions @@ -233,8 +233,8 @@ export class JiraExpressions { * The current customer request. Available only when the customer request is provided in the request context * object. * - * In addition, you can pass custom context variables along with their types. You can then access them from - * the Jira expression by key. You can use the following variables in a custom context: + * In addition, you can pass custom context variables along with their types. You can then access them from the Jira + * expression by key. You can use the following variables in a custom context: * * - `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) * specified as an Atlassian account ID. @@ -257,9 +257,9 @@ export class JiraExpressions { /** * Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint * uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly - * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for - * JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view - * (backed by `startAt` and `totalCount`). + * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for JQL + * evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by + * `startAt` and `totalCount`). * * This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible * way. Consult the [Jira expressions @@ -296,8 +296,8 @@ export class JiraExpressions { * The current customer request. Available only when the customer request is provided in the request context * object. * - * In addition, you can pass custom context variables along with their types. You can then access them from - * the Jira expression by key. You can use the following variables in a custom context: + * In addition, you can pass custom context variables along with their types. You can then access them from the Jira + * expression by key. You can use the following variables in a custom context: * * - `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) * specified as an Atlassian account ID. diff --git a/src/version2/models/enhancedSearchRequest.ts b/src/version2/models/enhancedSearchRequest.ts index 401bf2b7b..538583a0d 100644 --- a/src/version2/models/enhancedSearchRequest.ts +++ b/src/version2/models/enhancedSearchRequest.ts @@ -1,7 +1,8 @@ export interface EnhancedSearchRequest { /** - * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. - * For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. + * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a + * bounded query. A bounded query is a query with a search restriction. + * * - Example of an unbounded query: `order by key desc`. * - Example of a bounded query: `assignee = currentUser() order by key`. * @@ -9,8 +10,8 @@ export interface EnhancedSearchRequest { */ jql?: string; /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. - * Use the `nextPageToken` to fetch the next page of issues. + * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the + * `nextPageToken` to fetch the next page of issues. */ nextPageToken?: string; /** @@ -44,8 +45,8 @@ export interface EnhancedSearchRequest { * * Multiple `fields` parameters can be included in a request. * - * Note: By default, this resource returns IDs only. This differs from - * [GET issue](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get) + * Note: By default, this resource returns IDs only. This differs from [GET + * issue](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get) * where the default is all fields. */ fields?: string[]; @@ -62,7 +63,7 @@ export interface EnhancedSearchRequest { * - `editmeta` Returns information about how each field can be edited. * - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each - * version of a field's value, with the highest numbered item representing the most recent version. + * version of a field's value, with the highest numbered item representing the most recent version. * * Examples: `names,changelog` Returns the display name of each field as well as a list of recent updates to an issue. */ @@ -87,9 +88,7 @@ export interface EnhancedSearchRequest { )[] | string | string[]; - /** - * A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. - */ + /** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */ properties?: string[]; /** Reference fields by their key (rather than ID). The default is `false`. */ fieldsByKeys?: boolean; diff --git a/src/version2/models/jExpEvaluateIssuesMeta.ts b/src/version2/models/jExpEvaluateIssuesMeta.ts index 18f849055..383f8138b 100644 --- a/src/version2/models/jExpEvaluateIssuesMeta.ts +++ b/src/version2/models/jExpEvaluateIssuesMeta.ts @@ -3,8 +3,8 @@ import { JExpEvaluateIssuesJqlMetaData } from './jExpEvaluateIssuesJqlMetaData'; /** Meta data describing the `issues` context variable. */ export interface JExpEvaluateIssuesMeta { /** - * The description of the page of issues loaded by the provided JQL query. - * This bean will be replacing IssuesJqlMetaDataBean bean as part of new `evaluate` endpoint + * The description of the page of issues loaded by the provided JQL query. This bean will be replacing + * IssuesJqlMetaDataBean bean as part of new `evaluate` endpoint */ jql?: JExpEvaluateIssuesJqlMetaData; } diff --git a/src/version2/models/jExpEvaluateMetaData.ts b/src/version2/models/jExpEvaluateMetaData.ts index ac7fec3ec..0ac32411d 100644 --- a/src/version2/models/jExpEvaluateMetaData.ts +++ b/src/version2/models/jExpEvaluateMetaData.ts @@ -3,13 +3,13 @@ import { JiraExpressionsComplexity } from './jiraExpressionsComplexity'; export interface JExpEvaluateMetaData { /** - * Contains information about the expression complexity. For example, the number of steps it took to - * evaluate the expression. + * Contains information about the expression complexity. For example, the number of steps it took to evaluate the + * expression. */ complexity?: JiraExpressionsComplexity; /** - * Contains information about the `issues` variable in the context. For example, is the issues were loaded - * with JQL, information about the page will be included here. + * Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, + * information about the page will be included here. */ issues?: JExpEvaluateIssuesMeta; } diff --git a/src/version2/models/jexpEvaluateCtxJqlIssues.ts b/src/version2/models/jexpEvaluateCtxJqlIssues.ts index 35d7ace75..4fc211b9d 100644 --- a/src/version2/models/jexpEvaluateCtxJqlIssues.ts +++ b/src/version2/models/jexpEvaluateCtxJqlIssues.ts @@ -1,6 +1,4 @@ -/** - * The JQL query that specifies the set of issues available in the Jira expression. - */ +/** The JQL query that specifies the set of issues available in the Jira expression. */ export interface JexpEvaluateCtxJqlIssues { /** * The maximum number of issues to return from the JQL query. Inspect `meta.issues.jql.maxResults` in the response to @@ -8,8 +6,8 @@ export interface JexpEvaluateCtxJqlIssues { */ maxResults?: number; /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. - * Use the `nextPageToken` to fetch the next page of issues. + * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the + * `nextPageToken` to fetch the next page of issues. */ nextPageToken?: string; /** The JQL query, required to be bounded. Additionally, `orderBy` clause can contain a maximum of 7 fields */ diff --git a/src/version2/models/jiraExpressionEvaluateContext.ts b/src/version2/models/jiraExpressionEvaluateContext.ts index 68322e2bf..78464888a 100644 --- a/src/version2/models/jiraExpressionEvaluateContext.ts +++ b/src/version2/models/jiraExpressionEvaluateContext.ts @@ -29,9 +29,5 @@ export interface JiraExpressionEvaluateContext { * or key. All the fields of the issue object are available in the Jira expression. `json`: A JSON object containing * custom content. `list`: A JSON list of `user`, `issue`, or `json` variable types. */ - custom?: ( - | UserContextVariable - | IssueContextVariable - | JsonContextVariable - )[]; + custom?: (UserContextVariable | IssueContextVariable | JsonContextVariable)[]; } diff --git a/src/version2/models/searchAndReconcileResults.ts b/src/version2/models/searchAndReconcileResults.ts index 0a650df61..26c78d14f 100644 --- a/src/version2/models/searchAndReconcileResults.ts +++ b/src/version2/models/searchAndReconcileResults.ts @@ -7,9 +7,8 @@ export interface SearchAndReconcileResults { /** The ID and name of each field in the search results. */ names?: {}; /** - * Continuation token to fetch the next page. - * If this result represents the last or the only page this token will be null. - * This token will expire in 7 days. + * Continuation token to fetch the next page. If this result represents the last or the only page this token will be + * null. This token will expire in 7 days. */ nextPageToken?: string; /** The schema describing the field types in the search results. */ diff --git a/src/version2/parameters/searchForIssuesUsingJqlEnhancedSearch.ts b/src/version2/parameters/searchForIssuesUsingJqlEnhancedSearch.ts index d278a8205..d40a56810 100644 --- a/src/version2/parameters/searchForIssuesUsingJqlEnhancedSearch.ts +++ b/src/version2/parameters/searchForIssuesUsingJqlEnhancedSearch.ts @@ -1,7 +1,8 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { /** - * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. - * For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. + * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a + * bounded query. A bounded query is a query with a search restriction. + * * - Example of an unbounded query: `order by key desc`. * - Example of a bounded query: `assignee = currentUser() order by key`. * @@ -9,8 +10,8 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { */ jql: string; /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. - * Use the `nextPageToken` to fetch the next page of issues. + * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the + * `nextPageToken` to fetch the next page of issues. */ nextPageToken?: string; /** @@ -44,8 +45,8 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { * * Multiple `fields` parameters can be included in a request. * - * Note: By default, this resource returns IDs only. This differs from - * [GET issue](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get) + * Note: By default, this resource returns IDs only. This differs from [GET + * issue](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get) * where the default is all fields. */ fields?: string[]; @@ -62,14 +63,12 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { * - `editmeta` Returns information about how each field can be edited. * - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each - * version of a field's value, with the highest numbered item representing the most recent version. + * version of a field's value, with the highest numbered item representing the most recent version. * * Examples: `names,changelog` Returns the display name of each field as well as a list of recent updates to an issue. */ expand?: string; - /** - * A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. - */ + /** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */ properties?: string[]; /** Reference fields by their key (rather than ID). The default is `false`. */ fieldsByKeys?: boolean; diff --git a/src/version3/issueSearch.ts b/src/version3/issueSearch.ts index 6aa74c845..ba485a74d 100644 --- a/src/version3/issueSearch.ts +++ b/src/version3/issueSearch.ts @@ -340,8 +340,8 @@ export class IssueSearch { * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately * visible in the returned search results. * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * * If the JQL query expression is too large to be encoded as a query parameter, use the * [POST](#searchforissuesusingjqlenhancedsearchpost) version of this resource. @@ -364,8 +364,8 @@ export class IssueSearch { * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be immediately * visible in the returned search results. * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * * If the JQL query expression is too large to be encoded as a query parameter, use the * [POST](#searchforissuesusingjqlenhancedsearchpost) version of this resource. @@ -410,11 +410,11 @@ export class IssueSearch { /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * - * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL query - * expressions. + * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL + * query expressions. * * This operation can be accessed anonymously. * @@ -433,11 +433,11 @@ export class IssueSearch { /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). * - * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) consistency, - * you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. + * If you need [read-after-write](https://developer.atlassian.com/cloud/jira/platform/search-and-reconcile/) + * consistency, you can utilize the `reconcileIssues` parameter to ensure stronger consistency assurances. * - * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL query - * expressions. + * There is a [GET](#searchforissuesusingjqlenhancedsearch) version of this resource that can be used for smaller JQL + * query expressions. * * This operation can be accessed anonymously. * diff --git a/src/version3/jiraExpressions.ts b/src/version3/jiraExpressions.ts index e586d1026..484b5b02f 100644 --- a/src/version3/jiraExpressions.ts +++ b/src/version3/jiraExpressions.ts @@ -196,9 +196,9 @@ export class JiraExpressions { /** * Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint * uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly - * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for - * JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view - * (backed by `startAt` and `totalCount`). + * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for JQL + * evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by + * `startAt` and `totalCount`). * * This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible * way. Consult the [Jira expressions @@ -235,8 +235,8 @@ export class JiraExpressions { * The current customer request. Available only when the customer request is provided in the request context * object. * - * In addition, you can pass custom context variables along with their types. You can then access them from - * the Jira expression by key. You can use the following variables in a custom context: + * In addition, you can pass custom context variables along with their types. You can then access them from the Jira + * expression by key. You can use the following variables in a custom context: * * - `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) * specified as an Atlassian account ID. @@ -259,9 +259,9 @@ export class JiraExpressions { /** * Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint * uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly - * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for - * JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view - * (backed by `startAt` and `totalCount`). + * consistent `eval` API. This allows for better performance and scalability. In addition, this API's response for JQL + * evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by + * `startAt` and `totalCount`). * * This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible * way. Consult the [Jira expressions @@ -298,8 +298,8 @@ export class JiraExpressions { * The current customer request. Available only when the customer request is provided in the request context * object. * - * In addition, you can pass custom context variables along with their types. You can then access them from - * the Jira expression by key. You can use the following variables in a custom context: + * In addition, you can pass custom context variables along with their types. You can then access them from the Jira + * expression by key. You can use the following variables in a custom context: * * - `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) * specified as an Atlassian account ID. diff --git a/src/version3/models/enhancedSearchRequest.ts b/src/version3/models/enhancedSearchRequest.ts index 206d2a3c6..73e8eed2a 100644 --- a/src/version3/models/enhancedSearchRequest.ts +++ b/src/version3/models/enhancedSearchRequest.ts @@ -1,7 +1,8 @@ export interface EnhancedSearchRequest { /** - * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. - * For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. + * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a + * bounded query. A bounded query is a query with a search restriction. + * * - Example of an unbounded query: `order by key desc`. * - Example of a bounded query: `assignee = currentUser() order by key`. * @@ -9,8 +10,8 @@ export interface EnhancedSearchRequest { */ jql?: string; /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. - * Use the `nextPageToken` to fetch the next page of issues. + * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the + * `nextPageToken` to fetch the next page of issues. */ nextPageToken?: string; /** @@ -44,8 +45,8 @@ export interface EnhancedSearchRequest { * * Multiple `fields` parameters can be included in a request. * - * Note: By default, this resource returns IDs only. This differs from - * [GET issue](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get) + * Note: By default, this resource returns IDs only. This differs from [GET + * issue](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get) * where the default is all fields. */ fields?: string[]; @@ -62,7 +63,7 @@ export interface EnhancedSearchRequest { * - `editmeta` Returns information about how each field can be edited. * - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each - * version of a field's value, with the highest numbered item representing the most recent version. + * version of a field's value, with the highest numbered item representing the most recent version. * * Examples: `names,changelog` Returns the display name of each field as well as a list of recent updates to an issue. */ @@ -87,9 +88,7 @@ export interface EnhancedSearchRequest { )[] | string | string[]; - /** - * A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. - */ + /** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */ properties?: string[]; /** Reference fields by their key (rather than ID). The default is `false`. */ fieldsByKeys?: boolean; diff --git a/src/version3/models/index.ts b/src/version3/models/index.ts index 2205a5db4..324e5e5c1 100644 --- a/src/version3/models/index.ts +++ b/src/version3/models/index.ts @@ -1,4 +1,3 @@ -export * from './jiraExpressionEvaluateRequest'; export * from './updateDefaultProjectClassification'; export * from './workflowUpdateRequest'; export * from './mappingsByIssueTypeOverride'; diff --git a/src/version3/models/jExpEvaluateMetaData.ts b/src/version3/models/jExpEvaluateMetaData.ts index ac7fec3ec..0ac32411d 100644 --- a/src/version3/models/jExpEvaluateMetaData.ts +++ b/src/version3/models/jExpEvaluateMetaData.ts @@ -3,13 +3,13 @@ import { JiraExpressionsComplexity } from './jiraExpressionsComplexity'; export interface JExpEvaluateMetaData { /** - * Contains information about the expression complexity. For example, the number of steps it took to - * evaluate the expression. + * Contains information about the expression complexity. For example, the number of steps it took to evaluate the + * expression. */ complexity?: JiraExpressionsComplexity; /** - * Contains information about the `issues` variable in the context. For example, is the issues were loaded - * with JQL, information about the page will be included here. + * Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, + * information about the page will be included here. */ issues?: JExpEvaluateIssuesMeta; } diff --git a/src/version3/models/jiraExpressionEvaluateRequest.ts b/src/version3/models/jiraExpressionEvaluateRequest.ts deleted file mode 100644 index d4a546566..000000000 --- a/src/version3/models/jiraExpressionEvaluateRequest.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { JiraExpressionEvaluateContext } from './jiraExpressionEvaluateContext'; - -/** - * The request to evaluate a Jira expression. This bean will be replacing `JiraExpressionEvaluateRequest` as part of new - * `evaluate` endpoint - */ -export interface JiraExpressionEvaluateRequest { - context?: JiraExpressionEvaluateContext; - /** The Jira expression to evaluate. */ - expression: string; -} diff --git a/src/version3/parameters/evaluateJSISJiraExpression.ts b/src/version3/parameters/evaluateJSISJiraExpression.ts deleted file mode 100644 index dc84cb8d3..000000000 --- a/src/version3/parameters/evaluateJSISJiraExpression.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { JiraExpressionEvaluateRequest } from '../models'; - -export interface EvaluateJSISJiraExpression extends JiraExpressionEvaluateRequest { - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional - * information in the response. This parameter accepts `meta.complexity` that returns information about the expression - * complexity. For example, the number of expensive operations used by the expression and how close the expression is - * to reaching the [complexity - * limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing - * and debugging your expressions. - */ - expand?: string; -} diff --git a/src/version3/parameters/index.ts b/src/version3/parameters/index.ts index 09cd96cf9..ecea7ab41 100644 --- a/src/version3/parameters/index.ts +++ b/src/version3/parameters/index.ts @@ -64,7 +64,6 @@ export * from './getNotificationSchemeForProject'; export * from './updateWorkflowSchemeMappings'; export * from './updateSchemes'; export * from './readWorkflowSchemes'; -export * from './evaluateJSISJiraExpression'; export * from './replaceCustomFieldOption'; export * from './getCustomFieldsConfigurations'; export * from './getPolicies'; diff --git a/src/version3/parameters/searchAndReconsileIssuesUsingJql.ts b/src/version3/parameters/searchAndReconsileIssuesUsingJql.ts index 762fdf09c..8b1378917 100644 --- a/src/version3/parameters/searchAndReconsileIssuesUsingJql.ts +++ b/src/version3/parameters/searchAndReconsileIssuesUsingJql.ts @@ -1,86 +1 @@ -export interface SearchAndReconsileIssuesUsingJql { - /** - * A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this field requires a - * bounded query. A bounded query is a query with a search restriction. - * - * Example of an unbounded query: `order by key desc`. Example of a bounded query: `assignee = currentUser() order by - * key`. - */ - jql?: string; - /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the - * `nextPageToken` to fetch the next page of issues. - */ - nextPageToken?: string; - /** - * The maximum number of items to return. Depending on search criteria, real number of items returned may be smaller. - * It returns max 5000 issues. - */ - maxResults?: number; - /** - * A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a - * comma-separated list. Expand options include: - * - * - `*all` Returns all fields. - * - `*navigable` Returns navigable fields. - * - `id` Returns only issue IDs. - * - Any issue field, prefixed with a minus to exclude. - * - * The default is `id`. - * - * Examples: - * - `summary,comment` Returns only the summary and comments fields only. - * - `-description` Returns all navigable (default) fields except description. - * - `*all,-comment` Returns all fields except comments. - * - * Multiple `fields` parameters can be included in a request. - * - * Note: By default, this resource returns IDs only. This differs from [GET - * issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields. - */ - fields?: ('*all' | '*navigable' | 'id' | `-${string}` | string)[] | '*all' | '*navigable' | 'id' | string; - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional - * information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, - * `expand` is defined as a list of values. The expand options are: - * - * - `renderedFields` Returns field values rendered in HTML format. - * - `names` Returns the display name of each field. - * - `schema` Returns the schema describing a field type. - * - `transitions` Returns all possible transitions for the issue. - * - `operations` Returns all possible operations for the issue. - * - `editmeta` Returns information about how each field can be edited. - * - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. - * - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each - * version of a field's value, with the highest numbered item representing the most recent version. - */ - expand?: - | 'renderedFields' - | 'names' - | 'schema' - | 'transitions' - | 'operations' - | 'editmeta' - | 'changelog' - | 'versionedRepresentations' - | string - | ( - | 'renderedFields' - | 'names' - | 'schema' - | 'transitions' - | 'operations' - | 'editmeta' - | 'changelog' - | 'versionedRepresentations' - | string - )[]; - /** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */ - properties?: string[]; - /** Reference fields by their key (rather than ID). The default is `false`. */ - fieldsByKeys?: boolean; - /** Fail this request early if we can't retrieve all field data. */ - failFast?: boolean; - /** Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. All issues must exist. */ - reconcileIssues?: number[]; -} + diff --git a/src/version3/parameters/searchForIssuesUsingJqlEnhancedSearch.ts b/src/version3/parameters/searchForIssuesUsingJqlEnhancedSearch.ts index 512132727..03c024d4d 100644 --- a/src/version3/parameters/searchForIssuesUsingJqlEnhancedSearch.ts +++ b/src/version3/parameters/searchForIssuesUsingJqlEnhancedSearch.ts @@ -1,7 +1,8 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { /** - * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. - * For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. + * The [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a + * bounded query. A bounded query is a query with a search restriction. + * * - Example of an unbounded query: `order by key desc`. * - Example of a bounded query: `assignee = currentUser() order by key`. * @@ -9,8 +10,8 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { */ jql: string; /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. - * Use the `nextPageToken` to fetch the next page of issues. + * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the + * `nextPageToken` to fetch the next page of issues. */ nextPageToken?: string; /** @@ -44,8 +45,8 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { * * Multiple `fields` parameters can be included in a request. * - * Note: By default, this resource returns IDs only. This differs from - * [GET issue](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get) + * Note: By default, this resource returns IDs only. This differs from [GET + * issue](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get) * where the default is all fields. */ fields?: string[]; @@ -62,14 +63,12 @@ export interface SearchForIssuesUsingJqlEnhancedSearch { * - `editmeta` Returns information about how each field can be edited. * - `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * - `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each - * version of a field's value, with the highest numbered item representing the most recent version. + * version of a field's value, with the highest numbered item representing the most recent version. * * Examples: `names,changelog` Returns the display name of each field as well as a list of recent updates to an issue. */ expand?: string; - /** - * A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. - */ + /** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */ properties?: string[]; /** Reference fields by their key (rather than ID). The default is `false`. */ fieldsByKeys?: boolean;