/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface SearchRequestBean */ export interface SearchRequestBean { /** * A comma-separated list of fields to return for each issue, use it to retrieve a subset of fields. Allowed values * `*all` Returns all fields. * `*navigable` Returns navigable fields. * Any issue field, prefixed with a minus to exclude. The default is `*navigable`. Examples: * `summary,comment` Returns 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: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields. * @type {Array} * @memberof SearchRequestBean */ fields?: Array; /** * The maximum number of items to return per page. The default is `50` and the maximum is `100`. * @type {number} * @memberof SearchRequestBean */ maxResults?: number; /** * Determines how to validate the JQL query and treat the validation results. Supported values: * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). * `warn` Returns all errors as warnings. * `none` No validation is performed. * `true` *Deprecated* A legacy synonym for `strict`. * `false` *Deprecated* A legacy synonym for `warn`. The default is `strict`. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value. * @type {string} * @memberof SearchRequestBean */ validateQuery?: SearchRequestBeanValidateQueryEnum; /** * Use [expand](em>#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. * @type {Array} * @memberof SearchRequestBean */ expand?: Array; /** * The index of the first item to return in the page of results (page offset). The base index is `0`. * @type {number} * @memberof SearchRequestBean */ startAt?: number; /** * Reference fields by their key (rather than ID). The default is `false`. * @type {boolean} * @memberof SearchRequestBean */ fieldsByKeys?: boolean; /** * A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. * @type {string} * @memberof SearchRequestBean */ jql?: string; /** * A comma-separated list of up to 5 issue properties to include in the results. * @type {Array} * @memberof SearchRequestBean */ properties?: Array; } export declare function SearchRequestBeanFromJSON(json: any): SearchRequestBean; export declare function SearchRequestBeanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchRequestBean; export declare function SearchRequestBeanToJSON(value?: SearchRequestBean): any; /** * @export * @enum {string} */ export declare enum SearchRequestBeanValidateQueryEnum { Strict = "strict", Warn = "warn", None = "none", True = "true", False = "false" }