Uploaded image for project: 'Jira Platform Cloud'
  1. Jira Platform Cloud
  2. JRACLOUD-44570

Update documentation for com.atlassian.jira.workflow.WorkflowSchemeManager.getWorkflowName()

XMLWordPrintable

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      NOTE: This suggestion is for JIRA Cloud. Using JIRA Server? See the corresponding suggestion.

      The documentation for the getWorkflowName method takes two parameters:

      public String getWorkflowName (Project project, String issueType)
      

      The second parameter is a String type named issueType, but it's not clear whether an issue type name or ID (or some other value) should be passed here. Passing the issue type name succeeds (no exception is raised), but the return value is the workflow name for unassigned issue types. This behavior is somewhat unexpected. Passing the issue type ID as a string results in the correct behavior.

      Please update the documentation to reflect that this should be the issue type ID as a string that gets passed as the second parameter.

      Reference:
      https://developer.atlassian.com/static/javadoc/jira/latest/reference/com/atlassian/jira/workflow/WorkflowSchemeManager.html#getWorkflowName(com.atlassian.jira.project.Project, java.lang.String)

              alui Andrew
              5b4336f845e0 Scott Vitale
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: