@esm-js/jira.js/src/version2/models/fieldReferenceData.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

/** Details of a field that can be used in advanced searches. */
export interface FieldReferenceData {
  /** Whether the field provide auto-complete suggestions. */
  auto?: string;
  /** If the item is a custom field, the ID of the custom field. */
  cfid?: string;
  /** Whether this field has been deprecated. */
  deprecated?: string;
  /** The searcher key of the field, only passed when the field is deprecated. */
  deprecatedSearcherKey?: string;
  /**
   * The display name contains the following:
   *
   * For system fields, the field name. For example, `Summary`. for collapsed custom fields, the field name followed by
   * a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`. for other custom
   * fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.
   */
  displayName?: string;
  /** The valid search operators for the field. */
  operators?: string[];
  /** Whether the field can be used in a query's `ORDER BY` clause. */
  orderable?: string;
  /** Whether the content of this field can be searched. */
  searchable?: string;
  /** The data types of items in the field. */
  types?: string[];
  /** The field identifier. */
  value?: string;
}