Compare two commit diff stats

v1.0.0

Produces a response in JSON format with a record for every path modified, including information on the type of the change and the number of lines added and removed.

Single commit spec

If the spec argument to this API is a single commit, the diff is produced against the first parent of the specified commit.

Two commit spec

Two commits separated by .. may be provided as the spec, e.g., 3a8b42..9ff173. When two commits are provided and the topic query parameter is true or absent, this API produces a 2-way three dot diff. This is the diff between source commit and the merge base of the source commit and the destination commit. When the topic query param is false, a simple git-style diff is produced.

The two commits are interpreted as follows:

First commit: the commit containing the changes we wish to preview
Second commit: the commit representing the state to which we want to compare the first commit
Note: This is the opposite of the order used in git diff.

Sample output

curl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diffstat/d222fa2..e174964{    "pagelen": 500,    "values": [        {            "type": "diffstat",            "status": "modified",            "lines_removed": 1,            "lines_added": 2,            "old": {                "path": "setup.py",                "escaped_path": "setup.py",                "type": "commit_file",                "links": {                    "self": {                        "href": "https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/e1749643d655d7c7014001a6c0f58abaf42ad850/setup.py"                    }                }            },            "new": {                "path": "setup.py",                "escaped_path": "setup.py",                "type": "commit_file",                "links": {                    "self": {                        "href": "https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/d222fa235229c55dad20b190b0b571adf737d5a6/setup.py"                    }                }            }        }    ],    "page": 1,    "size": 1}

Output

{
  "type": "object",
  "description": "A paginated list of diffstats.",
  "properties": {
    "next": {
      "type": "string",
      "format": "uri",
      "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
    },
    "page": {
      "type": "integer",
      "description": "Page number of the current results. This is an optional element that is not provided in all responses."
    },
    "pagelen": {
      "type": "integer",
      "description": "Current number of objects on the existing page. The default value is 500 with 5000 being the maximum allowed value."
    },
    "previous": {
      "type": "string",
      "format": "uri",
      "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
    },
    "size": {
      "type": "integer",
      "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A diffstat object that includes a summary of changes made to a file between two commits.",
        "required": [
          "type"
        ],
        "properties": {
          "lines_added": {
            "type": "integer"
          },
          "lines_removed": {
            "type": "integer"
          },
          "new": {
            "type": "object",
            "description": "A file object, representing a file at a commit in a repository",
            "required": [
              "type"
            ],
            "properties": {
              "attributes": {
                "type": "string",
                "enum": [
                  "link",
                  "executable",
                  "subrepository",
                  "binary",
                  "lfs"
                ]
              },
              "commit": {
                "type": "object"
              },
              "escaped_path": {
                "type": "string",
                "description": "The escaped version of the path as it appears in a diff. If the path does not require escaping this will be the same as path."
              },
              "path": {
                "type": "string",
                "description": "The path in the repository"
              },
              "type": {
                "type": "string"
              }
            }
          },
          "old": {
            "type": "object",
            "additionalProperties": true
          },
          "status": {
            "type": "string",
            "enum": [
              "added",
              "removed",
              "modified",
              "renamed"
            ]
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  },
  "additionalProperties": false
}