Clarify the behaviour of empty issue fields in REST API

XMLWordPrintable

      Issue Summary

      Jira REST API documentation does not specify whether an empty field will be omitted or included in the response with a null value. As an example, SearcherKey is an optional field and if it has a null value, it will not be returned by the  Issues Field Paginated API .

      Steps to Reproduce

      To reproduce, run the following curl request, and you will see that API is not returning the searcherKey for the 'Approvers' field as searcherKey is optional and has Null value for 'Approvers' field.

      curl --request GET \
        --url 'https://your-domain.atlassian.net/rest/api/3/field/search?expand=searcherKey' \ 
        --user email@example.com:<api_token> \
        --header 'Accept: application/json' 

      Suggestion

      It would be good to have a documentation to specify whether an empty field will be omitted or included in the response with the null value, so we can better identify the expected behavior

              Assignee:
              Unassigned
              Reporter:
              Rosa Faghihi (Inactive)
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: