REST API consistency/standards

XMLWordPrintable

    • 1

      I am working with REST API of Jira Server/Jira Cloud and Confluence Cloud a lot and what I miss is some consistency.

      E.g. when requesting a paged list of custom fields or issues, I get Total, isLast, and Values in response. So I can easily find out if I am at the end of the list. Unfortunately, one of them isLast is missing, but at least Total is returned. But when I request a list of users, I get values only.

      Another example is backup API for Jira and Confluence. If we ignore different endpoint /wiki/rest/obm/1.0/getprogress and rest/backup/1/export/getProgress?taskId=backuptaskid, the Jira returns the Status Success, while Confluence returns alternativePercentage.

      And I do not even mention, that for one type of object I found out, that startAt should be the index of the issue, while on another object startAt parameter is expected a page number.

      All these inconsistencies are not necessary and make the development more challenging/painful. Would your teams review the current API and make some standards?

      I understand, that changing the current API could break existing solutions, but for the development of API for new features it would be really nice.

            Assignee:
            Unassigned
            Reporter:
            Lígia Zanchet (Inactive)
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: