Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Reminder

if you arrived here, it is probably that you have experienced some issue with one if Minyaa Workflows's Upgrade !

Sorry for these disagreement.

With below REST API, you will be able to replay some of Upgrade Task on a part of your Workflow.

To identify which Upgrade Tasks have to be replayed see Upgrade Notes pages

In most of cases, if some specific change are required in the configuration, each version of the Minyaa Workflows plugin are able to come with an UpgradeTask class who will take in charge these modification.

The UpgradeTask is based on a JIRA extension point managed by the Universal Plugin Manager (UPM). On plugin deployment, if an UpgradeTask has never been executed, UPM will launch it.

The required changes are done in background ... In not yet identified cases, some of these upgrade may encounter some issues and causes that some of your Workflows are not correctly migrated with the new configuration related the new plugin version.

Such cases have been experimented by a part of our customer with a large number of Workflow.

In order to allow them to replay these Upgrades, a dedicated REST APIs has been implemented. It allows to re-launch some if them on some of your Workflows.

/rest/minyaaWF/1.0/workflows/upgrade

Description

Launch a (or more) Upgrade Tasks on a set of Workflow.

Only UpgradeTask who extends com.alkaes.jira.upgrade.AbstractWorkflowUpgradeTask are allowed. The class AbstractWorkflowUpgradeTask is used by different Alkaes Plugin as soon as they provide Upgrade Task related Workflows.

MethodPOST
Content-Typeapplication/json
Parameters

PayLoad Parameters :

PropertiesValuesDescriptions
pluginKey
StringComplete Key of the plugin who provides the selected UpgradeTasks
workflowNames
List<String>List of Workflow Names for which you need to re-launch the selected Upgrade Tasks
upgradeClassNames
List<String>List of Workflow Upgrade Tasks to re-launch.
Sample :
Code Block
languagejson
linenumberstrue
{
	"pluginKey": "fr.alkaes.minyaa.jira-plugin-minyaa-workflows",
	"workflowNames": [
		"nameOfMy1stWorflow",
		"nameOfMy2ndWorflow"
	],
	"upgradeClassNames": [
		"fr.alkaes.myaawf.upgrade.UpgradeTask_001",
		"fr.alkaes.myaawf.upgrade.UpgradeTask_002"
	]
}
HTTP 200 Return

In case of success, the list of Upgraded Workflows per Upgrade Task are listed ...

Code Block
languagejson
linenumberstrue
{
	"pluginKey": "fr.alkaes.minyaa.jira-plugin-minyaa-workflows",
	"performedUpgrades": {
		"fr.alkaes.myaawf.upgrade.UpgradeTask_001": [
			"nameOfMy1stWorflow",
			"nameOfMy2ndWorflow"
		],
		"fr.alkaes.myaawf.upgrade.UpgradeTask_002": [
			"nameOfMy1stWorflow",
			"nameOfMy2ndWorflow"
		]
	}
}