Commit Comparison

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
html_url	string
permalink_url	string
diff_url	string
patch_url	string
base_commit	object
merge_base_commit	object
status	string
ahead_by	integer
behind_by	integer
total_commits	integer
commits	array
files	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/commit-comparison",
  "title": "Commit Comparison",
  "description": "Commit Comparison",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/master...topic"
    },
    "permalink_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17"
    },
    "diff_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/master...topic.diff"
    },
    "patch_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/master...topic.patch"
    },
    "base_commit": {
      "$ref": "#/components/schemas/commit"
    },
    "merge_base_commit": {
      "$ref": "#/components/schemas/commit"
    },
    "status": {
      "type": "string",
      "enum": [
        "diverged",
        "ahead",
        "behind",
        "identical"
      ],
      "example": "ahead"
    },
    "ahead_by": {
      "type": "integer",
      "example": 4
    },
    "behind_by": {
      "type": "integer",
      "example": 5
    },
    "total_commits": {
      "type": "integer",
      "example": 6
    },
    "commits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commit"
      }
    },
    "files": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/diff-entry"
      }
    }
  },
  "required": [
    "url",
    "html_url",
    "permalink_url",
    "diff_url",
    "patch_url",
    "base_commit",
    "merge_base_commit",
    "status",
    "ahead_by",
    "behind_by",
    "total_commits",
    "commits"
  ]
}