Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-44570

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

XMLWordPrintable

    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      NOTE: This suggestion is for JIRA Server. Using JIRA Cloud? 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)

              mnowakowski Maciej Nowakowski (Inactive)
              5b4336f845e0 Scott Vitale
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: