PATCH to update Feature Field modifies Points, and Team weeks fields

XMLWordPrintable

    • Type: Bug
    • Resolution: Fixed
    • Priority: Low
    • 11.13.1.0715
    • Affects Version/s: 11.13.1
    • Component/s: REST API

      Issue Summary

      When the Portfolio Specific Estimation System is set to 'T-Shirt' (regardless of what the 'Estimation system' is set to in the Platform->Portfolio tab Settings), PATCH API requests to modify the Features also update the Points and Team weeks values (to the ones corresponding to Medium T-Shirt size), although there is no T-Shirt information set. In the Feature audit log, we see the updated Points and Team weeks, but not for the T-Shirt.

      Features initially created from the Jira Connector in Jira Align may have no Estimation values assigned. Consequently, during the first update to such a feature, the Estimation fields are expected to be automatically set to their default values: 0 for Team Weeks, "No Estimate" for T-Shirt size, and 0 for Points, even if these fields are not included in the update (UI or API Call).
      However, we have observed that when the first update to the Feature is made through an API PATCH call, instead of applying the default values, the Points and Team Weeks fields are set to values corresponding to the medium-size T-shirt.
      This issue is occurring in Jira Align version 11.13.1 and is not observed with version 11.12.1.

      Steps to Reproduce

      • Ensure Portfolio Specific Estimation System set to T-Shirt
      • Create a Jira Epic in Jira and sync it to JA
      • Once the Feature syncs in from Jira to JA, check the audit log and notice that the Estimation values are not set.
      • Make the following API PATCH call
      curl -X 'PATCH' \
        'https://alignsupport.jiraalign.com/rest/align/api/2/Features/xxxxx' \
         '[
        {
          "op": "replace",
          "path": "/description",
          "value": "Testing"
        }
      ]'
      
      • Check the audit log of the updated Feature
      • Notice that instead of the Points, and Team weeks fields being updated to their default value 0, the API call updated the Points and TW/MW (to the ones corresponding to Medium T-Shirt size)
      Feature Updated -
      Description Changed - From [] To [Testing]
      Points Changed - From [] To [80]
      TW/MW Changed - From [0] To [5.33]
      

      Expected Results

      PATCH to update Feature, will set the Estimation fields to its default values in the audit logs even when the Estimation fields are not updated.

      Actual Results

      PATCH API call to update the Feature sets the Estimation fields to values corresponding to Medium T-Shirt size instead of setting it to default values in the audit logs even when the Estimation fields are not updated.

      Workaround

      To ensure that the first PATCH API call to update a Feature does not update the Estimation fields to values corresponding to Medium T-Shirt size, you can update the T-shirt field to a value which is the corresponding value for 'No Estimate' in the API payload along with other field updates. Example payload-

      curl -X 'PATCH' \
        'https://alignsupport.jiraalign.com/rest/align/api/2/Features/xxxxx' \
         '[
        {
          "op": "replace",
          "path": "/description",
          "value": "Testing"
        },
      {
          "op": "replace",
          "path": "/estimateTshirt",
          "value": 36
        }
      ]'
      

      This will ensure that T-shirt field is set to its default value "No Estimate" thereby ensuring other Estimate fields - Points and TW/MW are also set to its default values 0.

            Assignee:
            Yannick Genin
            Reporter:
            Arathi M S
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: