How to enable argument autocomplete for custom JQL functions

Jira Development Jira Data Center
1

Title:
Jira DC v10.11 Can plugins provide argument autocomplete for custom JQL functions? (ClauseValuesGenerator vs. FunctionValuesGenerator)

or

Proper syntax for adding a <values-generator … /> to a jql-function

or

Example project displaying argument autocomplete for a Jira jql-function

Body:
Greetings. Our marketplace app “CCC Last Comment” lacks helpful hints for the app’s 4 search routine expected arguments. We are trying to add them - we want to surface argument suggestions in the Advanced Search editor (i.e. show list of roles when user enters jql like issue in lastCommentRole("H - we’d like to show a list of all roles that start with H.

Environment

  • Jira Data Center: 10.1.1 (node)

  • jira-api: 10.0.0

  • Plugin: custom JQL functions (work fine), now wiring a values generator

What we tried

  • Implemented com.atlassian.jira.jql.values.ClauseValuesGenerator and registered it under our <jql-function> with a <values-generator class="…"/> child.

  • The adapter returns ClauseValuesGenerator.Results and unit tests pass.

  • At runtime the editor shows the function snippet (lastCommentRole("")), but no suggestions after typing a character inside the quotes; our generator is never called (no logs). Also tried without quotes.

  • We also tested the descriptor with <function-values-generator …/>, but that child appears unsupported on 10.0.0 (and FunctionValuesGenerator isn’t on the API classpath).

Question(s)

  1. On Jira DC 10.x, is function-argument autocomplete for plugin-defined JQL functions still supported?

  2. If yes, which interface + descriptor child is the supported combination on 10.0.0?

    • Interface: ClauseValuesGenerator? (We don’t see FunctionValuesGenerator in 10.0.0.)

    • Descriptor child: <values-generator …/> or <function-values-generator …/>?

  3. Is there an official example or reference plugin demonstrating function-operand suggestions on DC 10?

Thanks!

-wc

William Crighton

Capital City Consultants