Do not expand issuelinks in /api/2/search response

XMLWordPrintable

    • Type: Suggestion
    • Resolution: Won't Do
    • None
    • Component/s: REST API
    • Environment:
      JIRA 5.0-rc3

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

      Currently, both /api/2/issue and /api/2/search will return issue links complete with the representation of the issues on the other side of the link:

            "issuelinks"                   :[
              {
                "id"         :"11591",
                "self"       :"http://snow:10500/rest/api/2/issueLink/11591",
                "type"       :{
                  "id"     :"10030",
                  "name"   :"Relates",
                  "inward" :"relates to",
                  "outward":"relates to",
                  "self"   :"http://snow:10500/rest/api/2/issueLinkType/10030"
                },
                "inwardIssue":{
                  "id"    :"11375",
                  "key"   :"JC-476",
                  "self"  :"http://snow:10500/rest/api/2/issue/11375",
                  "fields":{
                    "summary"  :"Speed search in text editors should set the caret on the start of the occurrence",
                    "status"   :{
                      "self"       :"http://snow:10500/rest/api/2/status/1",
                      "description":"The issue is open and ready for the assignee to start work on it.",
                      "iconUrl"    :"http://snow:10500/images/icons/status_open.gif",
                      "name"       :"Open",
                      "id"         :"1"
                    },
                    "issuetype":{
                      "self"       :"http://snow:10500/rest/api/2/issuetype/2",
                      "id"         :"2",
                      "description":"A new feature of the product, which has yet to be developed.",
                      "iconUrl"    :"http://snow:10500/images/icons/newfeature.gif",
                      "name"       :"New Feature",
                      "subtask"    :false
                    },
                    "priority" :{
                      "self"   :"http://snow:10500/rest/api/2/priority/6",
                      "iconUrl":"http://snow:10500/images/icons/priority_trivial.gif",
                      "name"   :"Not set",
                      "id"     :"6"
                    }
                  }
                }
              },
      

      This could be a strain on the network and server resources. Some JIRA instances have huge amount of links to issues – on the scale of thousands. (I recall an issue that had 8000 links.) Sheer presence of such issues in the search result may severely degrade performance.

      REST API should collapse inwardIssue by default in /api/2/issue and /api/2/search and provide the possibility to expand it.

            Assignee:
            Matt Quail (Inactive)
            Reporter:
            Igor Baltiyskiy
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: