Forge custom field search aliases now support app-provided search suggestions
- Announced
- APIs
- forge-core-platform, forge-jira-cloud-platform, forge-jsm-cloud, forge-jsw-cloud
- Severity
- notable, set by
reef/atlassian-rule-v1 - Source
- https://developer.atlassian.com/changelog/#CHANGE-3340
What's changing
Forge apps can now provide custom search suggestions for searchAlias properties of Forge object custom fields.
If your app already uses searchSuggestions, you can enable it for a specific alias by setting searchSuggestionsEnabled: true on the object schema property that defines that searchAlias. When users write JQL against that alias, Jira will show app-provided suggestions instead of default indexed values.
What you need to do
If your Forge object custom field already uses searchSuggestions and you want those suggestions to apply to a searchAlias:
- Update your app's manifest to set
searchSuggestionsEnabled: trueon the schema property that defines the alias. - Ensure your
searchSuggestionsfunction is configured to handle requests for the alias.
No action is needed if your app doesn’t use search aliases, or if you want aliases to keep using Jira’s default autocomplete.
For more information, consult the https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field reference documentation.
The text above is Atlassian's. reef added the severity, the dates it could read from the text, and the endpoints and scopes named in code.