How to enable argument autocomplete for custom JQL functions

[William Crighton]

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

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

[Marc - Devoteam · Accepted solution]

Hi @William Crighton 

Welcome to the community.

I'm not a developer, but I do know there is an API option for this in DC.

https://developer.atlassian.com/server/jira/platform/rest/v11000/api-group-jql/#api-api-2-jql-autocompletedata-suggestions-get

Otherwise it might be good to ask this question in the Developer Community

https://community.developer.atlassian.com/ 

[William Crighton]

Thank you for your response - I didn't know they had split out the developer questions to another community. I'll ask the question there.

Have a great day