SearchRequestBean

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchRequestBean",
  "title": "SearchRequestBean",
  "additionalProperties": false,
  "properties": {
    "expand": {
      "description": "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:\n\n *  `renderedFields` Returns field values rendered in HTML format.\n *  `names` Returns the display name of each field.\n *  `schema` Returns the schema describing a field type.\n *  `transitions` Returns all possible transitions for the issue.\n *  `operations` Returns all possible operations for the issue.\n *  `editmeta` Returns information about how each field can be edited.\n *  `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n *  `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.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "fields": {
      "description": "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:\n\n *  `*all` Returns all fields.\n *  `*navigable` Returns navigable fields.\n *  Any issue field, prefixed with a minus to exclude.\n\nThe default is `*navigable`.\n\nExamples:\n\n *  `summary,comment` Returns the summary and comments fields only.\n *  `-description` Returns all navigable (default) fields except description.\n *  `*all,-comment` Returns all fields except comments.\n\nMultiple `fields` parameters can be included in a request.\n\nNote: 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.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "fieldsByKeys": {
      "description": "Reference fields by their key (rather than ID). The default is `false`.",
      "type": "boolean"
    },
    "jql": {
      "description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.",
      "type": "string"
    },
    "maxResults": {
      "default": 50,
      "description": "The maximum number of items to return per page.",
      "format": "int32",
      "type": "integer"
    },
    "properties": {
      "description": "A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "startAt": {
      "description": "The index of the first item to return in the page of results (page offset). The base index is `0`.",
      "format": "int32",
      "type": "integer"
    },
    "validateQuery": {
      "description": "Determines how to validate the JQL query and treat the validation results. Supported values:\n\n *  `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n *  `warn` Returns all errors as warnings.\n *  `none` No validation is performed.\n *  `true` *Deprecated* A legacy synonym for `strict`.\n *  `false` *Deprecated* A legacy synonym for `warn`.\n\nThe default is `strict`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.",
      "enum": [
        "strict",
        "warn",
        "none",
        "true",
        "false"
      ],
      "type": "string"
    }
  },
  "type": "object"
}